Retrieves information about the status and settings of the import jobs for a segment¶

Description¶

Retrieves information about the status and settings of the import jobs for a segment.

Usage¶

pinpoint_get_segment_import_jobs(ApplicationId, PageSize, SegmentId,
  Token)

Arguments¶

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
PageSize

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
SegmentId

[required] The unique identifier for the segment.
Token

The NextToken string that specifies which page of results to return in a paginated response.

Value¶

A list with the following syntax:

list(
  ImportJobsResponse = list(
    Item = list(
      list(
        ApplicationId = "string",
        CompletedPieces = 123,
        CompletionDate = "string",
        CreationDate = "string",
        Definition = list(
          DefineSegment = TRUE|FALSE,
          ExternalId = "string",
          Format = "CSV"|"JSON",
          RegisterEndpoints = TRUE|FALSE,
          RoleArn = "string",
          S3Url = "string",
          SegmentId = "string",
          SegmentName = "string"
        ),
        FailedPieces = 123,
        Failures = list(
          "string"
        ),
        Id = "string",
        JobStatus = "CREATED"|"PREPARING_FOR_INITIALIZATION"|"INITIALIZING"|"PROCESSING"|"PENDING_JOB"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED",
        TotalFailures = 123,
        TotalPieces = 123,
        TotalProcessed = 123,
        Type = "string"
      )
    ),
    NextToken = "string"
  )
)

Request syntax¶

svc$get_segment_import_jobs(
  ApplicationId = "string",
  PageSize = "string",
  SegmentId = "string",
  Token = "string"
)