AWS SDK for PHP 3.x

Service ID: braket

Version: 2019-09-01

This page describes the parameters and results for the operations of the Braket (2019-09-01), and shows how to use the Aws\Braket\BraketClient object to call the described operations. This documentation is specific to the 2019-09-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelJob ( array $params = [] ): Cancels an Amazon Braket hybrid job.
CancelQuantumTask ( array $params = [] ): Cancels the specified task.
CreateJob ( array $params = [] ): Creates an Amazon Braket hybrid job.
CreateQuantumTask ( array $params = [] ): Creates a quantum task.
GetDevice ( array $params = [] ): Retrieves the devices available in Amazon Braket.
GetJob ( array $params = [] ): Retrieves the specified Amazon Braket hybrid job.
GetQuantumTask ( array $params = [] ): Retrieves the specified quantum task.
ListTagsForResource ( array $params = [] ): Shows the tags associated with this resource.
SearchDevices ( array $params = [] ): Searches for devices using the specified filters.
SearchJobs ( array $params = [] ): Searches for Amazon Braket hybrid jobs that match the specified filter values.
SearchQuantumTasks ( array $params = [] ): Searches for tasks that match the specified filter values.
TagResource ( array $params = [] ): Add a tag to the specified resource.
UntagResource ( array $params = [] ): Remove tags from a resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

SearchDevices
SearchJobs
SearchQuantumTasks

Operations

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

Cancels an Amazon Braket hybrid job.

Parameter Syntax

$result = $client->cancelJob([
    'jobArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

jobArn

: Required: Yes
: Type: string

The ARN of the Amazon Braket hybrid job to cancel.

Result Syntax

[
    'cancellationStatus' => 'CANCELLING|CANCELLED',
    'jobArn' => '<string>',
]

Result Details

Members

cancellationStatus

: Required: Yes
: Type: string

The status of the hybrid job.

jobArn

: Required: Yes
: Type: string

The ARN of the Amazon Braket job.

Errors

ResourceNotFoundException:: The specified resource was not found.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ConflictException:: An error occurred due to a conflict.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

CancelQuantumTask

$result = $client->cancelQuantumTask([/* ... */]);
$promise = $client->cancelQuantumTaskAsync([/* ... */]);

Cancels the specified task.

Parameter Syntax

$result = $client->cancelQuantumTask([
    'clientToken' => '<string>', // REQUIRED
    'quantumTaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Required: Yes
: Type: string

The client token associated with the cancellation request.

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task to cancel.

Result Syntax

[
    'cancellationStatus' => 'CANCELLING|CANCELLED',
    'quantumTaskArn' => '<string>',
]

Result Details

Members

cancellationStatus

: Required: Yes
: Type: string

The status of the quantum task.

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task.

Errors

ResourceNotFoundException:: The specified resource was not found.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ConflictException:: An error occurred due to a conflict.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

Creates an Amazon Braket hybrid job.

Parameter Syntax

$result = $client->createJob([
    'algorithmSpecification' => [ // REQUIRED
        'containerImage' => [
            'uri' => '<string>', // REQUIRED
        ],
        'scriptModeConfig' => [
            'compressionType' => 'NONE|GZIP',
            'entryPoint' => '<string>', // REQUIRED
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'associations' => [
        [
            'arn' => '<string>', // REQUIRED
            'type' => 'RESERVATION_TIME_WINDOW_ARN', // REQUIRED
        ],
        // ...
    ],
    'checkpointConfig' => [
        'localPath' => '<string>',
        's3Uri' => '<string>', // REQUIRED
    ],
    'clientToken' => '<string>', // REQUIRED
    'deviceConfig' => [ // REQUIRED
        'device' => '<string>', // REQUIRED
    ],
    'hyperParameters' => ['<string>', ...],
    'inputDataConfig' => [
        [
            'channelName' => '<string>', // REQUIRED
            'contentType' => '<string>',
            'dataSource' => [ // REQUIRED
                's3DataSource' => [ // REQUIRED
                    's3Uri' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
    'instanceConfig' => [ // REQUIRED
        'instanceCount' => <integer>,
        'instanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge', // REQUIRED
        'volumeSizeInGb' => <integer>, // REQUIRED
    ],
    'jobName' => '<string>', // REQUIRED
    'outputDataConfig' => [ // REQUIRED
        'kmsKeyId' => '<string>',
        's3Path' => '<string>', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
    'stoppingCondition' => [
        'maxRuntimeInSeconds' => <integer>,
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

algorithmSpecification

: Required: Yes
: Type: AlgorithmSpecification structure

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

associations

: Type: Array of Association structures

The list of Amazon Braket resources associated with the hybrid job.

checkpointConfig

: Type: JobCheckpointConfig structure

Information about the output locations for hybrid job checkpoint data.

clientToken

: Required: Yes
: Type: string

The client token associated with this request that guarantees that the request is idempotent.

deviceConfig

: Required: Yes
: Type: DeviceConfig structure

The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.

hyperParameters

: Type: Associative array of custom strings keys (String256) to strings

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

inputDataConfig

: Type: Array of InputFileConfig structures

A list of parameters that specify the name and type of input data and where it is located.

instanceConfig

: Required: Yes
: Type: InstanceConfig structure

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

jobName

: Required: Yes
: Type: string

The name of the Amazon Braket hybrid job.

outputDataConfig

: Required: Yes
: Type: JobOutputDataConfig structure

The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets.

stoppingCondition

: Type: JobStoppingCondition structure

The user-defined criteria that specifies when a hybrid job stops running.

tags

: Type: Associative array of custom strings keys (String) to strings

Tags to be added to the hybrid job you're creating.

Result Syntax

[
    'jobArn' => '<string>',
]

Result Details

Members

jobArn

: Required: Yes
: Type: string

The ARN of the Amazon Braket hybrid job created.

Errors

ConflictException:: An error occurred due to a conflict.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
DeviceOfflineException:: The specified device is currently offline.
DeviceRetiredException:: The specified device has been retired.
ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

CreateQuantumTask

$result = $client->createQuantumTask([/* ... */]);
$promise = $client->createQuantumTaskAsync([/* ... */]);

Creates a quantum task.

Parameter Syntax

$result = $client->createQuantumTask([
    'action' => '<string>', // REQUIRED
    'associations' => [
        [
            'arn' => '<string>', // REQUIRED
            'type' => 'RESERVATION_TIME_WINDOW_ARN', // REQUIRED
        ],
        // ...
    ],
    'clientToken' => '<string>', // REQUIRED
    'deviceArn' => '<string>', // REQUIRED
    'deviceParameters' => '<string>',
    'jobToken' => '<string>',
    'outputS3Bucket' => '<string>', // REQUIRED
    'outputS3KeyPrefix' => '<string>', // REQUIRED
    'shots' => <integer>, // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

action

: Required: Yes
: Type: string (string|number|array|map or anything parsable by json_encode)

The action associated with the quantum task.

associations

: Type: Array of Association structures

The list of Amazon Braket resources associated with the quantum task.

clientToken

: Required: Yes
: Type: string

The client token associated with the request.

deviceArn

: Required: Yes
: Type: string

The ARN of the device to run the quantum task on.

deviceParameters

: Type: string (string|number|array|map or anything parsable by json_encode)

The parameters for the device to run the quantum task on.

jobToken

: Type: string

The token for an Amazon Braket hybrid job that associates it with the quantum task.

outputS3Bucket

: Required: Yes
: Type: string

The S3 bucket to store quantum task result files in.

outputS3KeyPrefix

: Required: Yes
: Type: string

The key prefix for the location in the S3 bucket to store quantum task results in.

shots

: Required: Yes
: Type: long (int|float)

The number of shots to use for the quantum task.

tags

: Type: Associative array of custom strings keys (String) to strings

Tags to be added to the quantum task you're creating.

Result Syntax

[
    'quantumTaskArn' => '<string>',
]

Result Details

Members

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task created by the request.

Errors

AccessDeniedException:: You do not have sufficient permissions to perform this action.
DeviceOfflineException:: The specified device is currently offline.
ThrottlingException:: The API throttling rate limit is exceeded.
DeviceRetiredException:: The specified device has been retired.
ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

GetDevice

$result = $client->getDevice([/* ... */]);
$promise = $client->getDeviceAsync([/* ... */]);

Retrieves the devices available in Amazon Braket.

For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

Parameter Syntax

$result = $client->getDevice([
    'deviceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

deviceArn

: Required: Yes
: Type: string

The ARN of the device to retrieve.

Result Syntax

[
    'deviceArn' => '<string>',
    'deviceCapabilities' => '<string>',
    'deviceName' => '<string>',
    'deviceQueueInfo' => [
        [
            'queue' => 'QUANTUM_TASKS_QUEUE|JOBS_QUEUE',
            'queuePriority' => 'Normal|Priority',
            'queueSize' => '<string>',
        ],
        // ...
    ],
    'deviceStatus' => 'ONLINE|OFFLINE|RETIRED',
    'deviceType' => 'QPU|SIMULATOR',
    'providerName' => '<string>',
]

Result Details

Members

deviceArn

: Required: Yes
: Type: string

The ARN of the device.

deviceCapabilities

: Required: Yes
: Type: string (string|number|array|map or anything parsable by json_encode)

Details about the capabilities of the device.

deviceName

: Required: Yes
: Type: string

The name of the device.

deviceQueueInfo

: Type: Array of DeviceQueueInfo structures

The number of quantum tasks and hybrid jobs currently queued on the device.

deviceStatus

: Required: Yes
: Type: string

The status of the device.

deviceType

: Required: Yes
: Type: string

The type of the device.

providerName

: Required: Yes
: Type: string

The name of the partner company for the device.

Errors

ResourceNotFoundException:: The specified resource was not found.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

Retrieves the specified Amazon Braket hybrid job.

Parameter Syntax

$result = $client->getJob([
    'additionalAttributeNames' => ['<string>', ...],
    'jobArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

additionalAttributeNames

: Type: Array of strings

A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

jobArn

: Required: Yes
: Type: string

The ARN of the hybrid job to retrieve.

Result Syntax

[
    'algorithmSpecification' => [
        'containerImage' => [
            'uri' => '<string>',
        ],
        'scriptModeConfig' => [
            'compressionType' => 'NONE|GZIP',
            'entryPoint' => '<string>',
            's3Uri' => '<string>',
        ],
    ],
    'associations' => [
        [
            'arn' => '<string>',
            'type' => 'RESERVATION_TIME_WINDOW_ARN',
        ],
        // ...
    ],
    'billableDuration' => <integer>,
    'checkpointConfig' => [
        'localPath' => '<string>',
        's3Uri' => '<string>',
    ],
    'createdAt' => <DateTime>,
    'deviceConfig' => [
        'device' => '<string>',
    ],
    'endedAt' => <DateTime>,
    'events' => [
        [
            'eventType' => 'WAITING_FOR_PRIORITY|QUEUED_FOR_EXECUTION|STARTING_INSTANCE|DOWNLOADING_DATA|RUNNING|DEPRIORITIZED_DUE_TO_INACTIVITY|UPLOADING_RESULTS|COMPLETED|FAILED|MAX_RUNTIME_EXCEEDED|CANCELLED',
            'message' => '<string>',
            'timeOfEvent' => <DateTime>,
        ],
        // ...
    ],
    'failureReason' => '<string>',
    'hyperParameters' => ['<string>', ...],
    'inputDataConfig' => [
        [
            'channelName' => '<string>',
            'contentType' => '<string>',
            'dataSource' => [
                's3DataSource' => [
                    's3Uri' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'instanceConfig' => [
        'instanceCount' => <integer>,
        'instanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge',
        'volumeSizeInGb' => <integer>,
    ],
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'outputDataConfig' => [
        'kmsKeyId' => '<string>',
        's3Path' => '<string>',
    ],
    'queueInfo' => [
        'message' => '<string>',
        'position' => '<string>',
        'queue' => 'QUANTUM_TASKS_QUEUE|JOBS_QUEUE',
    ],
    'roleArn' => '<string>',
    'startedAt' => <DateTime>,
    'status' => 'QUEUED|RUNNING|COMPLETED|FAILED|CANCELLING|CANCELLED',
    'stoppingCondition' => [
        'maxRuntimeInSeconds' => <integer>,
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members

algorithmSpecification

: Required: Yes
: Type: AlgorithmSpecification structure

Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

associations

: Type: Array of Association structures

The list of Amazon Braket resources associated with the hybrid job.

billableDuration

: Type: int

The billable time for which the Amazon Braket hybrid job used to complete.

checkpointConfig

: Type: JobCheckpointConfig structure

Information about the output locations for hybrid job checkpoint data.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job was created.

deviceConfig

: Type: DeviceConfig structure

The primary device used by the Amazon Braket hybrid job.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job ended.

events

: Type: Array of JobEventDetails structures

Details about the time and type of events occurred related to the Amazon Braket hybrid job.

failureReason

: Type: string

A description of the reason why an Amazon Braket hybrid job failed, if it failed.

hyperParameters

: Type: Associative array of custom strings keys (String256) to strings

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

inputDataConfig

: Type: Array of InputFileConfig structures

A list of parameters that specify the name and type of input data and where it is located.

instanceConfig

: Required: Yes
: Type: InstanceConfig structure

The resource instances to use while running the hybrid job on Amazon Braket.

jobArn

: Required: Yes
: Type: string

The ARN of the Amazon Braket hybrid job.

jobName

: Required: Yes
: Type: string

The name of the Amazon Braket hybrid job.

outputDataConfig

: Required: Yes
: Type: JobOutputDataConfig structure

The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.

queueInfo

: Type: HybridJobQueueInfo structure

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

roleArn

: Required: Yes
: Type: string

startedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job was started.

status

: Required: Yes
: Type: string

The status of the Amazon Braket hybrid job.

stoppingCondition

: Type: JobStoppingCondition structure

The user-defined criteria that specifies when to stop a running hybrid job.

tags

: Type: Associative array of custom strings keys (String) to strings

The tags associated with this hybrid job.

Errors

ResourceNotFoundException:: The specified resource was not found.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

GetQuantumTask

$result = $client->getQuantumTask([/* ... */]);
$promise = $client->getQuantumTaskAsync([/* ... */]);

Retrieves the specified quantum task.

Parameter Syntax

$result = $client->getQuantumTask([
    'additionalAttributeNames' => ['<string>', ...],
    'quantumTaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

additionalAttributeNames

: Type: Array of strings

A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task to retrieve.

Result Syntax

[
    'actionMetadata' => [
        'actionType' => '<string>',
        'executableCount' => <integer>,
        'programCount' => <integer>,
    ],
    'associations' => [
        [
            'arn' => '<string>',
            'type' => 'RESERVATION_TIME_WINDOW_ARN',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'deviceArn' => '<string>',
    'deviceParameters' => '<string>',
    'endedAt' => <DateTime>,
    'failureReason' => '<string>',
    'jobArn' => '<string>',
    'numSuccessfulShots' => <integer>,
    'outputS3Bucket' => '<string>',
    'outputS3Directory' => '<string>',
    'quantumTaskArn' => '<string>',
    'queueInfo' => [
        'message' => '<string>',
        'position' => '<string>',
        'queue' => 'QUANTUM_TASKS_QUEUE|JOBS_QUEUE',
        'queuePriority' => 'Normal|Priority',
    ],
    'shots' => <integer>,
    'status' => 'CREATED|QUEUED|RUNNING|COMPLETED|FAILED|CANCELLING|CANCELLED',
    'tags' => ['<string>', ...],
]

Result Details

Members

actionMetadata

: Type: ActionMetadata structure

Metadata about the action performed by the quantum task, including information about the type of action and program counts.

associations

: Type: Array of Association structures

The list of Amazon Braket resources associated with the quantum task.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the quantum task was created.

deviceArn

: Required: Yes
: Type: string

The ARN of the device the quantum task was run on.

deviceParameters

: Required: Yes
: Type: string (string|number|array|map or anything parsable by json_encode)

The parameters for the device on which the quantum task ran.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the quantum task ended.

failureReason

: Type: string

The reason that a quantum task failed.

jobArn

: Type: string

The ARN of the Amazon Braket job associated with the quantum task.

numSuccessfulShots

: Type: long (int|float)

The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

outputS3Bucket

: Required: Yes
: Type: string

The S3 bucket where quantum task results are stored.

outputS3Directory

: Required: Yes
: Type: string

The folder in the S3 bucket where quantum task results are stored.

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task.

queueInfo

: Type: QuantumTaskQueueInfo structure

Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.

shots

: Required: Yes
: Type: long (int|float)

The number of shots used in the quantum task.

status

: Required: Yes
: Type: string

The status of the quantum task.

tags

: Type: Associative array of custom strings keys (String) to strings

The tags that belong to this quantum task.

Errors

ResourceNotFoundException:: The specified resource was not found.
AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Shows the tags associated with this resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

Specify the resourceArn for the resource whose tags to display.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (String) to strings

Displays the key, value pairs of tags associated with this resource.

Errors

ResourceNotFoundException:: The specified resource was not found.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

SearchDevices

$result = $client->searchDevices([/* ... */]);
$promise = $client->searchDevicesAsync([/* ... */]);

Searches for devices using the specified filters.

Parameter Syntax

$result = $client->searchDevices([
    'filters' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Required: Yes
: Type: Array of SearchDevicesFilter structures

Array of SearchDevicesFilter objects to use when searching for devices.

maxResults

: Type: int

The maximum number of results to return in the response.

nextToken

: Type: 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.

Result Syntax

[
    'devices' => [
        [
            'deviceArn' => '<string>',
            'deviceName' => '<string>',
            'deviceStatus' => 'ONLINE|OFFLINE|RETIRED',
            'deviceType' => 'QPU|SIMULATOR',
            'providerName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

devices

: Required: Yes
: Type: Array of DeviceSummary structures

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

nextToken

: Type: 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.

Errors

AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

SearchJobs

$result = $client->searchJobs([/* ... */]);
$promise = $client->searchJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->searchJobs([
    'filters' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'operator' => 'LT|LTE|EQUAL|GT|GTE|BETWEEN|CONTAINS', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Required: Yes
: Type: Array of SearchJobsFilter structures

Array of SearchJobsFilter objects to use when searching for hybrid jobs.

maxResults

: Type: int

The maximum number of results to return in the response.

nextToken

: Type: 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.

Result Syntax

[
    'jobs' => [
        [
            'createdAt' => <DateTime>,
            'device' => '<string>',
            'endedAt' => <DateTime>,
            'jobArn' => '<string>',
            'jobName' => '<string>',
            'startedAt' => <DateTime>,
            'status' => 'QUEUED|RUNNING|COMPLETED|FAILED|CANCELLING|CANCELLED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

jobs

: Required: Yes
: Type: Array of JobSummary structures

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

nextToken

: Type: 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.

Errors

AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

SearchQuantumTasks

$result = $client->searchQuantumTasks([/* ... */]);
$promise = $client->searchQuantumTasksAsync([/* ... */]);

Searches for tasks that match the specified filter values.

Parameter Syntax

$result = $client->searchQuantumTasks([
    'filters' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'operator' => 'LT|LTE|EQUAL|GT|GTE|BETWEEN', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Required: Yes
: Type: Array of SearchQuantumTasksFilter structures

Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.

maxResults

: Type: int

Maximum number of results to return in the response.

nextToken

: Type: 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.

Result Syntax

[
    'nextToken' => '<string>',
    'quantumTasks' => [
        [
            'createdAt' => <DateTime>,
            'deviceArn' => '<string>',
            'endedAt' => <DateTime>,
            'outputS3Bucket' => '<string>',
            'outputS3Directory' => '<string>',
            'quantumTaskArn' => '<string>',
            'shots' => <integer>,
            'status' => 'CREATED|QUEUED|RUNNING|COMPLETED|FAILED|CANCELLING|CANCELLED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: 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.

quantumTasks

: Required: Yes
: Type: Array of QuantumTaskSummary structures

An array of QuantumTaskSummary objects for quantum tasks that match the specified filters.

Errors

AccessDeniedException:: You do not have sufficient permissions to perform this action.
ThrottlingException:: The API throttling rate limit is exceeded.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add a tag to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

Specify the resourceArn of the resource to which a tag will be added.

tags

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

Specify the tags to add to the resource. Tags can be specified as a key-value map.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource was not found.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

Specify the resourceArn for the resource from which to remove the tags.

tagKeys

: Required: Yes
: Type: Array of strings

Specify the keys for the tags to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource was not found.
InternalServiceException:: The request failed because of an unknown error.
ValidationException:: The input request failed to satisfy constraints expected by Amazon Braket.

Shapes

AccessDeniedException

Description

You do not have sufficient permissions to perform this action.

Members

message

: Type: string

ActionMetadata

Description

Contains metadata about the quantum task action, including the action type and program statistics.

Members

actionType

: Required: Yes
: Type: string

The type of action associated with the quantum task.

executableCount

: Type: long (int|float)

The number of executables in a program set. This is only available for a Program Set.

programCount

: Type: long (int|float)

The number of programs in a program set. This is only available for a Program Set.

AlgorithmSpecification

Description

Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.

Members

containerImage

: Type: ContainerImage structure

The container image used to create an Amazon Braket hybrid job.

scriptModeConfig

: Type: ScriptModeConfig structure

Configures the paths to the Python scripts used for entry and training.

Association

Description

The Amazon Braket resource and the association type.

Members

arn

: Required: Yes
: Type: string

The Amazon Braket resource arn.

type

: Required: Yes
: Type: string

The association type for the specified Amazon Braket resource arn.

ConflictException

Description

An error occurred due to a conflict.

Members

message

: Type: string

ContainerImage

Description

The container image used to create an Amazon Braket hybrid job.

Members

uri

: Required: Yes
: Type: string

The URI locating the container image.

DataSource

Description

Information about the source of the input data used by the Amazon Braket hybrid job.

Members

s3DataSource

: Required: Yes
: Type: S3DataSource structure

Amazon S3 path of the input data used by the hybrid job.

DeviceConfig

Description

Configures the primary device used to create and run an Amazon Braket hybrid job.

Members

device

: Required: Yes
: Type: string

The primary device ARN used to create and run an Amazon Braket hybrid job.

DeviceOfflineException

Description

The specified device is currently offline.

Members

message

: Type: string

DeviceQueueInfo

Description

Information about quantum tasks and hybrid jobs queued on a device.

Members

queue

: Required: Yes
: Type: string

The name of the queue.

queuePriority

: Type: string

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.

queueSize

: Required: Yes
: Type: string

The number of hybrid jobs or quantum tasks in the queue for a given device.

DeviceRetiredException

Description

The specified device has been retired.

Members

message

: Type: string

DeviceSummary

Description

Includes information about the device.

Members

deviceArn

: Required: Yes
: Type: string

The ARN of the device.

deviceName

: Required: Yes
: Type: string

The name of the device.

deviceStatus

: Required: Yes
: Type: string

The status of the device.

deviceType

: Required: Yes
: Type: string

The type of the device.

providerName

: Required: Yes
: Type: string

The provider of the device.

HybridJobQueueInfo

Description

Information about the queue for a specified hybrid job.

Members

message

: Type: string

Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message field contains that information.

position

: Required: Yes
: Type: string

Current position of the hybrid job in the jobs queue.

queue

: Required: Yes
: Type: string

The name of the queue.

InputFileConfig

Description

A list of parameters that specify the input channels, type of input data, and where it is located.

Members

channelName

: Required: Yes
: Type: string

A named input source that an Amazon Braket hybrid job can consume.

contentType

: Type: string

The MIME type of the data.

dataSource

: Required: Yes
: Type: DataSource structure

The location of the input data.

InstanceConfig

Description

Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.

Members

instanceCount

: Type: int

Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.

instanceType

: Required: Yes
: Type: string

Configures the type of resource instances to use while running an Amazon Braket hybrid job.

volumeSizeInGb

: Required: Yes
: Type: int

The size of the storage volume, in GB, to provision.

InternalServiceException

Description

The request failed because of an unknown error.

Members

message

: Type: string

JobCheckpointConfig

Description

Contains information about the output locations for hybrid job checkpoint data.

Members

localPath

: Type: string

(Optional) The local directory where checkpoint data is stored. The default directory is /opt/braket/checkpoints/.

s3Uri

: Required: Yes
: Type: string

Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, s3://bucket-name/key-name-prefix.

JobEventDetails

Description

Details about the type and time events that occurred related to the Amazon Braket hybrid job.

Members

eventType

: Type: string

The type of event that occurred related to the Amazon Braket hybrid job.

message

: Type: string

A message describing the event that occurred related to the Amazon Braket hybrid job.

timeOfEvent

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of the event that occurred related to the Amazon Braket hybrid job.

JobOutputDataConfig

Description

Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

Members

kmsKeyId

: Type: string

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.

s3Path

: Required: Yes
: Type: string

Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, s3://bucket-name/key-name-prefix.

JobStoppingCondition

Description

Specifies limits for how long an Amazon Braket hybrid job can run.

Members

maxRuntimeInSeconds

: Type: int

The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.

JobSummary

Description

Provides summary information about an Amazon Braket hybrid job.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job was created.

device

: Required: Yes
: Type: string

The primary device used by an Amazon Braket hybrid job.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job ended.

jobArn

: Required: Yes
: Type: string

The ARN of the Amazon Braket hybrid job.

jobName

: Required: Yes
: Type: string

The name of the Amazon Braket hybrid job.

startedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the Amazon Braket hybrid job was started.

status

: Required: Yes
: Type: string

The status of the Amazon Braket hybrid job.

tags

: Type: Associative array of custom strings keys (String) to strings

Displays the key, value pairs of tags associated with this hybrid job.

ProgramSetValidationFailure

Description

Contains information about validation failures that occurred during the processing of a program set in a quantum task.

Members

errors

: Type: Array of strings

A list of error messages describing the validation failures that occurred.

inputsIndex

: Type: long (int|float)

The index of the input within the program set that failed validation.

programIndex

: Required: Yes
: Type: long (int|float)

The index of the program within the program set that failed validation.

QuantumTaskQueueInfo

Description

The queue information for the specified quantum task.

Members

message

: Type: string

Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message field contains that information.

position

: Required: Yes
: Type: string

Current position of the quantum task in the quantum tasks queue.

queue

: Required: Yes
: Type: string

The name of the queue.

queuePriority

: Type: string

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.

QuantumTaskSummary

Description

Includes information about a quantum task.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the quantum task was created.

deviceArn

: Required: Yes
: Type: string

The ARN of the device the quantum task ran on.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the quantum task finished.

outputS3Bucket

: Required: Yes
: Type: string

The S3 bucket where the quantum task result file is stored.

outputS3Directory

: Required: Yes
: Type: string

The folder in the S3 bucket where the quantum task result file is stored.

quantumTaskArn

: Required: Yes
: Type: string

The ARN of the quantum task.

shots

: Required: Yes
: Type: long (int|float)

The shots used for the quantum task.

status

: Required: Yes
: Type: string

The status of the quantum task.

tags

: Type: Associative array of custom strings keys (String) to strings

Displays the key, value pairs of tags associated with this quantum task.

ResourceNotFoundException

Description

The specified resource was not found.

Members

message

: Type: string

S3DataSource

Description

Information about the Amazon S3 storage used by the Amazon Braket hybrid job.

Members

s3Uri

: Required: Yes
: Type: string

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.

ScriptModeConfig

Description

Contains information about algorithm scripts used for the Amazon Braket hybrid job.

Members

compressionType

: Type: string

The type of compression used to store the algorithm scripts in Amazon S3 storage.

entryPoint

: Required: Yes
: Type: string

The entry point in the algorithm scripts from where the execution begins in the hybrid job.

s3Uri

: Required: Yes
: Type: string

The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.

SearchDevicesFilter

Description

The filter used to search for devices.

Members

name

: Required: Yes
: Type: string

The name of the device parameter to filter based on. Only deviceArn filter name is currently supported.

values

: Required: Yes
: Type: Array of strings

The values used to filter devices based on the filter name.

SearchJobsFilter

Description

A filter used to search for Amazon Braket hybrid jobs.

Members

name

: Required: Yes
: Type: string

The name of the hybrid job parameter to filter based on. Filter name can be either jobArn or createdAt.

operator

: Required: Yes
: Type: string

An operator to use for the filter.

values

: Required: Yes
: Type: Array of strings

The values used to filter hybrid jobs based on the filter name and operator.

SearchQuantumTasksFilter

Description

A filter used to search for quantum tasks.

Members

name

: Required: Yes
: Type: string

The name of the quantum task parameter to filter based on. Filter name can be either quantumTaskArn, deviceArn, jobArn, status or createdAt.

operator

: Required: Yes
: Type: string

An operator to use for the filter.

values

: Required: Yes
: Type: Array of strings

The values used to filter quantum tasks based on the filter name and operator.

ServiceQuotaExceededException

Description

The request failed because a service quota is exceeded.

Members

message

: Type: string

ThrottlingException

Description

The API throttling rate limit is exceeded.

Members

message

: Type: string

ValidationException

Description

The input request failed to satisfy constraints expected by Amazon Braket.

Members

message

: Type: string

programSetValidationFailures

: Type: Array of ProgramSetValidationFailure structures

The validation failures in the program set submitted in the request.

reason

: Type: string

The reason for validation failure.

Braket 2019-09-01

Operation Summary

Paginators

Operations

CancelJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelQuantumTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateQuantumTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetQuantumTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

SearchDevices

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

SearchJobs

Parameter Syntax

Parameter Details

Members