com.amazonaws.services.braket

Interface AWSBraket

All Known Subinterfaces:

AWSBraketAsync

All Known Implementing Classes:

AbstractAWSBraket, AbstractAWSBraketAsync, AWSBraketAsyncClient, AWSBraketClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBraket

Interface for accessing Braket.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBraket instead.

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

• Amazon Braket Developer Guide

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelJobResult	cancelJob(CancelJobRequest cancelJobRequest) Cancels an Amazon Braket job.
CancelQuantumTaskResult	cancelQuantumTask(CancelQuantumTaskRequest cancelQuantumTaskRequest) Cancels the specified task.
CreateJobResult	createJob(CreateJobRequest createJobRequest) Creates an Amazon Braket job.
CreateQuantumTaskResult	createQuantumTask(CreateQuantumTaskRequest createQuantumTaskRequest) Creates a quantum task.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDeviceResult	getDevice(GetDeviceRequest getDeviceRequest) Retrieves the devices available in Amazon Braket.
GetJobResult	getJob(GetJobRequest getJobRequest) Retrieves the specified Amazon Braket job.
GetQuantumTaskResult	getQuantumTask(GetQuantumTaskRequest getQuantumTaskRequest) Retrieves the specified quantum task.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Shows the tags associated with this resource.
SearchDevicesResult	searchDevices(SearchDevicesRequest searchDevicesRequest) Searches for devices using the specified filters.
SearchJobsResult	searchJobs(SearchJobsRequest searchJobsRequest) Searches for Amazon Braket jobs that match the specified filter values.
SearchQuantumTasksResult	searchQuantumTasks(SearchQuantumTasksRequest searchQuantumTasksRequest) Searches for tasks that match the specified filter values.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add a tag to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove tags from a resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelJob

CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)

Cancels an Amazon Braket job.

Parameters:

cancelJobRequest -

Returns:

Result of the CancelJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient access to perform this action.

ConflictException - An error occurred due to a conflict.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

cancelQuantumTask

CancelQuantumTaskResult cancelQuantumTask(CancelQuantumTaskRequest cancelQuantumTaskRequest)

Cancels the specified task.

Parameters:

cancelQuantumTaskRequest -

Returns:

Result of the CancelQuantumTask operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient access to perform this action.

ConflictException - An error occurred due to a conflict.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

createJob

CreateJobResult createJob(CreateJobRequest createJobRequest)

Creates an Amazon Braket job.

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

ConflictException - An error occurred due to a conflict.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

DeviceRetiredException - The specified device has been retired.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

createQuantumTask

CreateQuantumTaskResult createQuantumTask(CreateQuantumTaskRequest createQuantumTaskRequest)

Creates a quantum task.

Parameters:

createQuantumTaskRequest -

Returns:

Result of the CreateQuantumTask operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

DeviceOfflineException - The specified device is currently offline.

DeviceRetiredException - The specified device has been retired.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getDevice

GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)

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.

Parameters:

getDeviceRequest -

Returns:

Result of the GetDevice operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getJob

GetJobResult getJob(GetJobRequest getJobRequest)

Retrieves the specified Amazon Braket job.

Parameters:

getJobRequest -

Returns:

Result of the GetJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getQuantumTask

GetQuantumTaskResult getQuantumTask(GetQuantumTaskRequest getQuantumTaskRequest)

Retrieves the specified quantum task.

Parameters:

getQuantumTaskRequest -

Returns:

Result of the GetQuantumTask operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Shows the tags associated with this resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

searchDevices

SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest)

Searches for devices using the specified filters.

Parameters:

searchDevicesRequest -

Returns:

Result of the SearchDevices operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

searchJobs

SearchJobsResult searchJobs(SearchJobsRequest searchJobsRequest)

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

Parameters:

searchJobsRequest -

Returns:

Result of the SearchJobs operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

searchQuantumTasks

SearchQuantumTasksResult searchQuantumTasks(SearchQuantumTasksRequest searchQuantumTasksRequest)

Searches for tasks that match the specified filter values.

Parameters:

searchQuantumTasksRequest -

Returns:

Result of the SearchQuantumTasks operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The throttling rate limit is met.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Add a tag to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - The request processing has failed because of an unknown error, exception, or failure.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.