Create Export Job

sesv2_create_export_job

R Documentation

Creates an export job for a data source and destination

Description

Creates an export job for a data source and destination.

You can execute this operation no more than once per second.

Usage

sesv2_create_export_job(ExportDataSource, ExportDestination)

Arguments

ExportDataSource

[required] The data source for the export job.

ExportDestination

[required] The destination for the export job.

Value

A list with the following syntax:

list(
  JobId = "string"
)

Request syntax

svc$create_export_job(
  ExportDataSource = list(
    MetricsDataSource = list(
      Dimensions = list(
        list(
          "string"
        )
      ),
      Namespace = "VDM",
      Metrics = list(
        list(
          Name = "SEND"|"COMPLAINT"|"PERMANENT_BOUNCE"|"TRANSIENT_BOUNCE"|"OPEN"|"CLICK"|"DELIVERY"|"DELIVERY_OPEN"|"DELIVERY_CLICK"|"DELIVERY_COMPLAINT",
          Aggregation = "RATE"|"VOLUME"
        )
      ),
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      )
    ),
    MessageInsightsDataSource = list(
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      Include = list(
        FromEmailAddress = list(
          "string"
        ),
        Destination = list(
          "string"
        ),
        Subject = list(
          "string"
        ),
        Isp = list(
          "string"
        ),
        LastDeliveryEvent = list(
          "SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT"
        ),
        LastEngagementEvent = list(
          "OPEN"|"CLICK"
        )
      ),
      Exclude = list(
        FromEmailAddress = list(
          "string"
        ),
        Destination = list(
          "string"
        ),
        Subject = list(
          "string"
        ),
        Isp = list(
          "string"
        ),
        LastDeliveryEvent = list(
          "SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT"
        ),
        LastEngagementEvent = list(
          "OPEN"|"CLICK"
        )
      ),
      MaxResults = 123
    )
  ),
  ExportDestination = list(
    DataFormat = "CSV"|"JSON",
    S3Url = "string"
  )
)

Examples

## Not run: 
# Creates a new export job for Metrics data
svc$create_export_job(
  ExportDataSource = list(
    MetricsDataSource = list(
      Dimensions = list(
        ISP = list(
          "*"
        )
      ),
      EndDate = "2023-07-02T00:00:00",
      Metrics = list(
        list(
          Aggregation = "VOLUME",
          Name = "SEND"
        ),
        list(
          Aggregation = "VOLUME",
          Name = "COMPLAINT"
        ),
        list(
          Aggregation = "RATE",
          Name = "COMPLAINT"
        )
      ),
      Namespace = "VDM",
      StartDate = "2023-07-01T00:00:00"
    )
  ),
  ExportDestination = list(
    DataFormat = "CSV"
  )
)

# Creates a new export job for Message Insights data
svc$create_export_job(
  ExportDataSource = list(
    MessageInsightsDataSource = list(
      EndDate = "2023-07-02T00:00:00",
      Exclude = list(
        FromEmailAddress = list(
          "hello@example.com"
        )
      ),
      Include = list(
        Subject = list(
          "Hello"
        )
      ),
      StartDate = "2023-07-01T00:00:00"
    )
  ),
  ExportDestination = list(
    DataFormat = "CSV"
  )
)

## End(Not run)