com.amazonaws.services.braket

Class AWSBraketClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.braket.AWSBraketClient

All Implemented Interfaces:

AWSBraket

Direct Known Subclasses:

AWSBraketAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBraketClient
extends AmazonWebServiceClient
implements AWSBraket

Client for accessing Braket. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.braket.AWSBraket

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBraketClientBuilder	builder()
CancelJobResult	cancelJob(CancelJobRequest request) Cancels an Amazon Braket job.
CancelQuantumTaskResult	cancelQuantumTask(CancelQuantumTaskRequest request) Cancels the specified task.
CreateJobResult	createJob(CreateJobRequest request) Creates an Amazon Braket job.
CreateQuantumTaskResult	createQuantumTask(CreateQuantumTaskRequest request) 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 request) Retrieves the devices available in Amazon Braket.
GetJobResult	getJob(GetJobRequest request) Retrieves the specified Amazon Braket job.
GetQuantumTaskResult	getQuantumTask(GetQuantumTaskRequest request) Retrieves the specified quantum task.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Shows the tags associated with this resource.
SearchDevicesResult	searchDevices(SearchDevicesRequest request) Searches for devices using the specified filters.
SearchJobsResult	searchJobs(SearchJobsRequest request) Searches for Amazon Braket jobs that match the specified filter values.
SearchQuantumTasksResult	searchQuantumTasks(SearchQuantumTasksRequest request) 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 request) Add a tag to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove tags from a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSBraketClientBuilder builder()

cancelJob

public CancelJobResult cancelJob(CancelJobRequest request)

Cancels an Amazon Braket job.

Specified by:

cancelJob in interface AWSBraket

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

public CancelQuantumTaskResult cancelQuantumTask(CancelQuantumTaskRequest request)

Cancels the specified task.

Specified by:

cancelQuantumTask in interface AWSBraket

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

public CreateJobResult createJob(CreateJobRequest request)

Creates an Amazon Braket job.

Specified by:

createJob in interface AWSBraket

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.

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

createQuantumTask

public CreateQuantumTaskResult createQuantumTask(CreateQuantumTaskRequest request)

Creates a quantum task.

Specified by:

createQuantumTask in interface AWSBraket

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

public GetDeviceResult getDevice(GetDeviceRequest request)

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.

Specified by:

getDevice in interface AWSBraket

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

public GetJobResult getJob(GetJobRequest request)

Retrieves the specified Amazon Braket job.

Specified by:

getJob in interface AWSBraket

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

public GetQuantumTaskResult getQuantumTask(GetQuantumTaskRequest request)

Retrieves the specified quantum task.

Specified by:

getQuantumTask in interface AWSBraket

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Shows the tags associated with this resource.

Specified by:

listTagsForResource in interface AWSBraket

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

public SearchDevicesResult searchDevices(SearchDevicesRequest request)

Searches for devices using the specified filters.

Specified by:

searchDevices in interface AWSBraket

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

public SearchJobsResult searchJobs(SearchJobsRequest request)

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

Specified by:

searchJobs in interface AWSBraket

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

public SearchQuantumTasksResult searchQuantumTasks(SearchQuantumTasksRequest request)

Searches for tasks that match the specified filter values.

Specified by:

searchQuantumTasks in interface AWSBraket

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

public TagResourceResult tagResource(TagResourceRequest request)

Add a tag to the specified resource.

Specified by:

tagResource in interface AWSBraket

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Remove tags from a resource.

Specified by:

untagResource in interface AWSBraket

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSBraket

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSBraket

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.

Specified by:

shutdown in interface AWSBraket

Overrides:

shutdown in class AmazonWebServiceClient