SearchJobsFilter - Amazon Braket

SearchJobsFilter

A filter used to search for Amazon Braket hybrid jobs. You can combine multiple filters in a single request, except that jobArn cannot be combined with any other filter.

Contents

name

The name of the hybrid job parameter to filter based on. Supported filter names:

jobArn — Filter by the job ARN. Supports the EQUAL operator only. Cannot be combined with other filters.

jobName — Filter by the job name. Supports the EQUAL operator for exact match, or the CONTAINS operator for substring match. For example, use CONTAINS with a value of my-experiment to find all jobs whose name includes "my-experiment".

deviceArn — Filter by the target device. Supports the EQUAL operator only. The value can be a device ARN (for example, arn:aws:braket:us-east-1::device/qpu/ionq/Aria-1) or a local simulator identifier (for example, local:braket/default).

createdAt — Filter by the job creation time. Supports the EQUAL, GT, GTE, LT, LTE, and BETWEEN operators. Values must be in RFC 3339 date-time format.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

operator

An operator to use for the filter. The supported operators depend on the filter name. See the name parameter for details.

Type: String

Valid Values: LT | LTE | EQUAL | GT | GTE | BETWEEN | CONTAINS

Required: Yes

values

The values used to filter hybrid jobs based on the filter name and operator. Each filter accepts an array of values. Most filters accept a single value, except createdAt with the BETWEEN operator, which requires exactly two values.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: