Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_batch_segment_jobs

list_batch_segment_jobs(**kwargs)

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_segment_jobs(
    solutionVersionArn='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • solutionVersionArn (string) -- The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
  • nextToken (string) -- The token to request the next page of results.
  • maxResults (integer) -- The maximum number of batch segment job results to return in each page. The default value is 100.
Return type

dict

Returns

Response Syntax

{
    'batchSegmentJobs': [
        {
            'batchSegmentJobArn': 'string',
            'jobName': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string',
            'solutionVersionArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • batchSegmentJobs (list) --

      A list containing information on each job that is returned.

      • (dict) --

        A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.

        • batchSegmentJobArn (string) --

          The Amazon Resource Name (ARN) of the batch segment job.

        • jobName (string) --

          The name of the batch segment job.

        • status (string) --

          The status of the batch segment job. The status is one of the following values:

          • PENDING
          • IN PROGRESS
          • ACTIVE
          • CREATE FAILED
        • creationDateTime (datetime) --

          The time at which the batch segment job was created.

        • lastUpdatedDateTime (datetime) --

          The time at which the batch segment job was last updated.

        • failureReason (string) --

          If the batch segment job failed, the reason for the failure.

        • solutionVersionArn (string) --

          The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

    • nextToken (string) --

      The token to use to retrieve the next page of results. The value is null when there are no more results to return.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException
  • Personalize.Client.exceptions.InvalidNextTokenException