com.amazonaws.services.braket.AWSBraket Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-braket Show documentation
Show all versions of aws-java-sdk-braket Show documentation
The AWS Java SDK for Braket module holds the client classes that are used for communicating with Braket Service
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.braket;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.braket.model.*;
/**
* Interface for accessing Braket.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.braket.AbstractAWSBraket} instead.
*
*
*
* The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBraket {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "braket";
/**
*
* Cancels an Amazon Braket job.
*
*
* @param cancelJobRequest
* @return Result of the CancelJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ConflictException
* An error occurred due to a conflict.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.CancelJob
* @see AWS API
* Documentation
*/
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest);
/**
*
* Cancels the specified task.
*
*
* @param cancelQuantumTaskRequest
* @return Result of the CancelQuantumTask operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ConflictException
* An error occurred due to a conflict.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.CancelQuantumTask
* @see AWS API
* Documentation
*/
CancelQuantumTaskResult cancelQuantumTask(CancelQuantumTaskRequest cancelQuantumTaskRequest);
/**
*
* Creates an Amazon Braket job.
*
*
* @param createJobRequest
* @return Result of the CreateJob operation returned by the service.
* @throws ConflictException
* An error occurred due to a conflict.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws DeviceRetiredException
* The specified device has been retired.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ServiceQuotaExceededException
* The request failed because a service quota is exceeded.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.CreateJob
* @see AWS API
* Documentation
*/
CreateJobResult createJob(CreateJobRequest createJobRequest);
/**
*
* Creates a quantum task.
*
*
* @param createQuantumTaskRequest
* @return Result of the CreateQuantumTask operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws DeviceOfflineException
* The specified device is currently offline.
* @throws DeviceRetiredException
* The specified device has been retired.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ServiceQuotaExceededException
* The request failed because a service quota is exceeded.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.CreateQuantumTask
* @see AWS API
* Documentation
*/
CreateQuantumTaskResult createQuantumTask(CreateQuantumTaskRequest createQuantumTaskRequest);
/**
*
* Retrieves the devices available in Amazon Braket.
*
*
* @param getDeviceRequest
* @return Result of the GetDevice operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.GetDevice
* @see AWS API
* Documentation
*/
GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest);
/**
*
* Retrieves the specified Amazon Braket job.
*
*
* @param getJobRequest
* @return Result of the GetJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.GetJob
* @see AWS API
* Documentation
*/
GetJobResult getJob(GetJobRequest getJobRequest);
/**
*
* Retrieves the specified quantum task.
*
*
* @param getQuantumTaskRequest
* @return Result of the GetQuantumTask operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.GetQuantumTask
* @see AWS API
* Documentation
*/
GetQuantumTaskResult getQuantumTask(GetQuantumTaskRequest getQuantumTaskRequest);
/**
*
* Shows the tags associated with this resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Searches for devices using the specified filters.
*
*
* @param searchDevicesRequest
* @return Result of the SearchDevices operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.SearchDevices
* @see AWS API
* Documentation
*/
SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest);
/**
*
* Searches for Amazon Braket jobs that match the specified filter values.
*
*
* @param searchJobsRequest
* @return Result of the SearchJobs operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.SearchJobs
* @see AWS API
* Documentation
*/
SearchJobsResult searchJobs(SearchJobsRequest searchJobsRequest);
/**
*
* Searches for tasks that match the specified filter values.
*
*
* @param searchQuantumTasksRequest
* @return Result of the SearchQuantumTasks operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The throttling rate limit is met.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.SearchQuantumTasks
* @see AWS API
* Documentation
*/
SearchQuantumTasksResult searchQuantumTasks(SearchQuantumTasksRequest searchQuantumTasksRequest);
/**
*
* Add a tag to the specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Remove tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InternalServiceException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @sample AWSBraket.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}