Braket / Client / search_jobs

search_jobs¶

Braket.Client.search_jobs(**kwargs)¶

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

Request Syntax

response = client.search_jobs(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN'|'CONTAINS'
        },
    ]
)

Parameters:

nextToken (string) – A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.
maxResults (integer) – The maximum number of results to return in the response.
filters (list) –
[REQUIRED]

Array of SearchJobsFilter objects to use when searching for hybrid jobs.
- (dict) –
  
  A filter used to search for Amazon Braket hybrid jobs.
  - name (string) – [REQUIRED]
    
    The name of the hybrid job parameter to filter based on. Filter name can be either jobArn or createdAt.
  - values (list) – [REQUIRED]
    
    The values used to filter hybrid jobs based on the filter name and operator.
    - (string) –
  - operator (string) – [REQUIRED]
    
    An operator to use for the filter.

Return type:

dict

Returns:

Response Syntax

{
    'jobs': [
        {
            'status': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
            'jobArn': 'string',
            'jobName': 'string',
            'device': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            '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 hybrid job.
    - status (string) –
      
      The status of the Amazon Braket hybrid job.
    - jobArn (string) –
      
      The ARN of the Amazon Braket hybrid job.
    - jobName (string) –
      
      The name of the Amazon Braket hybrid job.
    - device (string) –
      
      The primary device used by an Amazon Braket hybrid job.
    - createdAt (datetime) –
      
      The time at which the Amazon Braket hybrid job was created.
    - startedAt (datetime) –
      
      The time at which the Amazon Braket hybrid job was started.
    - endedAt (datetime) –
      
      The time at which the Amazon Braket hybrid job ended.
    - tags (dict) –
      
      Displays the key, value pairs of tags associated with this hybrid job.
      - (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 search where the previous request ended.

Exceptions

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