search_jobs

search_jobs(**kwargs)

Searches for Amazon Braket jobs that match the specified filter values.

See also: AWS API Documentation

Request Syntax

response = client.search_jobs(
    filters=[
        {
            'name': 'string',
            'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN'|'CONTAINS',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='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) --
• maxResults (integer) -- The maximum number of results to return in the response.
• nextToken (string) -- A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

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 used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

Exceptions

• Braket.Client.exceptions.AccessDeniedException
• Braket.Client.exceptions.ThrottlingException
• Braket.Client.exceptions.InternalServiceException
• Braket.Client.exceptions.ValidationException