SearchJobs

class Braket.Paginator.SearchJobs

paginator = client.get_paginator('search_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Braket.Client.search_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN'|'CONTAINS',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• filters (list) --

  [REQUIRED]

  The filter values to use when searching for a job.

  • (dict) --

    A filter used to search for Amazon Braket jobs.

    • name (string) -- [REQUIRED]

      The name to use for the jobs filter.

    • operator (string) -- [REQUIRED]

      An operator to use for the jobs filter.

    • values (list) -- [REQUIRED]

      The values to use for the jobs filter.

      • (string) --
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'jobs': [
        {
            'createdAt': datetime(2015, 1, 1),
            'device': 'string',
            'endedAt': datetime(2015, 1, 1),
            'jobArn': 'string',
            'jobName': 'string',
            'startedAt': datetime(2015, 1, 1),
            'status': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • jobs (list) --

    An array of JobSummary objects for devices that match the specified filter values.

    • (dict) --

      Provides summary information about an Amazon Braket job.

      • createdAt (datetime) --

        The date and time that the Amazon Braket job was created.

      • device (string) --

        Provides summary information about the primary device used by an Amazon Braket job.

      • endedAt (datetime) --

        The date and time that the Amazon Braket job ended.

      • jobArn (string) --

        The ARN of the Amazon Braket job.

      • jobName (string) --

        The name of the Amazon Braket job.

      • startedAt (datetime) --

        The date and time that the Amazon Braket job was started.

      • status (string) --

        The status of the Amazon Braket job.

      • tags (dict) --

        A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

        • (string) --
          • (string) --

  • NextToken (string) --

    A token to resume pagination.