/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the braket-2019-09-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Braket.Model;
namespace Amazon.Braket
{
///
/// Interface for accessing Braket
///
/// The Amazon Braket API Reference provides information about the operations and structures
/// supported in Amazon Braket.
///
///
///
/// Additional Resources:
///
///
///
public partial interface IAmazonBraket : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IBraketPaginatorFactory Paginators { get; }
#endif
#region CancelJob
///
/// Cancels an Amazon Braket job.
///
/// Container for the necessary parameters to execute the CancelJob service method.
///
/// The response from the CancelJob service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// An error occurred due to a conflict.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CancelJob Operation
CancelJobResponse CancelJob(CancelJobRequest request);
///
/// Initiates the asynchronous execution of the CancelJob operation.
///
///
/// Container for the necessary parameters to execute the CancelJob operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelJob
/// operation.
/// REST API Reference for CancelJob Operation
IAsyncResult BeginCancelJob(CancelJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CancelJob operation.
///
///
/// The IAsyncResult returned by the call to BeginCancelJob.
///
/// Returns a CancelJobResult from Braket.
/// REST API Reference for CancelJob Operation
CancelJobResponse EndCancelJob(IAsyncResult asyncResult);
#endregion
#region CancelQuantumTask
///
/// Cancels the specified task.
///
/// Container for the necessary parameters to execute the CancelQuantumTask service method.
///
/// The response from the CancelQuantumTask service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// An error occurred due to a conflict.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CancelQuantumTask Operation
CancelQuantumTaskResponse CancelQuantumTask(CancelQuantumTaskRequest request);
///
/// Initiates the asynchronous execution of the CancelQuantumTask operation.
///
///
/// Container for the necessary parameters to execute the CancelQuantumTask operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelQuantumTask
/// operation.
/// REST API Reference for CancelQuantumTask Operation
IAsyncResult BeginCancelQuantumTask(CancelQuantumTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CancelQuantumTask operation.
///
///
/// The IAsyncResult returned by the call to BeginCancelQuantumTask.
///
/// Returns a CancelQuantumTaskResult from Braket.
/// REST API Reference for CancelQuantumTask Operation
CancelQuantumTaskResponse EndCancelQuantumTask(IAsyncResult asyncResult);
#endregion
#region CreateJob
///
/// Creates an Amazon Braket job.
///
/// Container for the necessary parameters to execute the CreateJob service method.
///
/// The response from the CreateJob service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// An error occurred due to a conflict.
///
///
/// The specified device has been retired.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request failed because a service quota is exceeded.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CreateJob Operation
CreateJobResponse CreateJob(CreateJobRequest request);
///
/// Initiates the asynchronous execution of the CreateJob operation.
///
///
/// Container for the necessary parameters to execute the CreateJob operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateJob
/// operation.
/// REST API Reference for CreateJob Operation
IAsyncResult BeginCreateJob(CreateJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateJob operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateJob.
///
/// Returns a CreateJobResult from Braket.
/// REST API Reference for CreateJob Operation
CreateJobResponse EndCreateJob(IAsyncResult asyncResult);
#endregion
#region CreateQuantumTask
///
/// Creates a quantum task.
///
/// Container for the necessary parameters to execute the CreateQuantumTask service method.
///
/// The response from the CreateQuantumTask service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The specified device is currently offline.
///
///
/// The specified device has been retired.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request failed because a service quota is exceeded.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CreateQuantumTask Operation
CreateQuantumTaskResponse CreateQuantumTask(CreateQuantumTaskRequest request);
///
/// Initiates the asynchronous execution of the CreateQuantumTask operation.
///
///
/// Container for the necessary parameters to execute the CreateQuantumTask operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateQuantumTask
/// operation.
/// REST API Reference for CreateQuantumTask Operation
IAsyncResult BeginCreateQuantumTask(CreateQuantumTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateQuantumTask operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateQuantumTask.
///
/// Returns a CreateQuantumTaskResult from Braket.
/// REST API Reference for CreateQuantumTask Operation
CreateQuantumTaskResponse EndCreateQuantumTask(IAsyncResult asyncResult);
#endregion
#region GetDevice
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetDevice service method.
///
/// The response from the GetDevice service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetDevice Operation
GetDeviceResponse GetDevice(GetDeviceRequest request);
///
/// Initiates the asynchronous execution of the GetDevice operation.
///
///
/// Container for the necessary parameters to execute the GetDevice operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevice
/// operation.
/// REST API Reference for GetDevice Operation
IAsyncResult BeginGetDevice(GetDeviceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetDevice operation.
///
///
/// The IAsyncResult returned by the call to BeginGetDevice.
///
/// Returns a GetDeviceResult from Braket.
/// REST API Reference for GetDevice Operation
GetDeviceResponse EndGetDevice(IAsyncResult asyncResult);
#endregion
#region GetJob
///
/// Retrieves the specified Amazon Braket job.
///
/// Container for the necessary parameters to execute the GetJob service method.
///
/// The response from the GetJob service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetJob Operation
GetJobResponse GetJob(GetJobRequest request);
///
/// Initiates the asynchronous execution of the GetJob operation.
///
///
/// Container for the necessary parameters to execute the GetJob operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJob
/// operation.
/// REST API Reference for GetJob Operation
IAsyncResult BeginGetJob(GetJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetJob operation.
///
///
/// The IAsyncResult returned by the call to BeginGetJob.
///
/// Returns a GetJobResult from Braket.
/// REST API Reference for GetJob Operation
GetJobResponse EndGetJob(IAsyncResult asyncResult);
#endregion
#region GetQuantumTask
///
/// Retrieves the specified quantum task.
///
/// Container for the necessary parameters to execute the GetQuantumTask service method.
///
/// The response from the GetQuantumTask service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetQuantumTask Operation
GetQuantumTaskResponse GetQuantumTask(GetQuantumTaskRequest request);
///
/// Initiates the asynchronous execution of the GetQuantumTask operation.
///
///
/// Container for the necessary parameters to execute the GetQuantumTask operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetQuantumTask
/// operation.
/// REST API Reference for GetQuantumTask Operation
IAsyncResult BeginGetQuantumTask(GetQuantumTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetQuantumTask operation.
///
///
/// The IAsyncResult returned by the call to BeginGetQuantumTask.
///
/// Returns a GetQuantumTaskResult from Braket.
/// REST API Reference for GetQuantumTask Operation
GetQuantumTaskResponse EndGetQuantumTask(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Shows the tags associated with this resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by Braket.
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from Braket.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region SearchDevices
///
/// Searches for devices using the specified filters.
///
/// Container for the necessary parameters to execute the SearchDevices service method.
///
/// The response from the SearchDevices service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for SearchDevices Operation
SearchDevicesResponse SearchDevices(SearchDevicesRequest request);
///
/// Initiates the asynchronous execution of the SearchDevices operation.
///
///
/// Container for the necessary parameters to execute the SearchDevices operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchDevices
/// operation.
/// REST API Reference for SearchDevices Operation
IAsyncResult BeginSearchDevices(SearchDevicesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the SearchDevices operation.
///
///
/// The IAsyncResult returned by the call to BeginSearchDevices.
///
/// Returns a SearchDevicesResult from Braket.
/// REST API Reference for SearchDevices Operation
SearchDevicesResponse EndSearchDevices(IAsyncResult asyncResult);
#endregion
#region SearchJobs
///
/// Searches for Amazon Braket jobs that match the specified filter values.
///
/// Container for the necessary parameters to execute the SearchJobs service method.
///
/// The response from the SearchJobs service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for SearchJobs Operation
SearchJobsResponse SearchJobs(SearchJobsRequest request);
///
/// Initiates the asynchronous execution of the SearchJobs operation.
///
///
/// Container for the necessary parameters to execute the SearchJobs operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchJobs
/// operation.
/// REST API Reference for SearchJobs Operation
IAsyncResult BeginSearchJobs(SearchJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the SearchJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginSearchJobs.
///
/// Returns a SearchJobsResult from Braket.
/// REST API Reference for SearchJobs Operation
SearchJobsResponse EndSearchJobs(IAsyncResult asyncResult);
#endregion
#region SearchQuantumTasks
///
/// Searches for tasks that match the specified filter values.
///
/// Container for the necessary parameters to execute the SearchQuantumTasks service method.
///
/// The response from the SearchQuantumTasks service method, as returned by Braket.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The throttling rate limit is met.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for SearchQuantumTasks Operation
SearchQuantumTasksResponse SearchQuantumTasks(SearchQuantumTasksRequest request);
///
/// Initiates the asynchronous execution of the SearchQuantumTasks operation.
///
///
/// Container for the necessary parameters to execute the SearchQuantumTasks operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchQuantumTasks
/// operation.
/// REST API Reference for SearchQuantumTasks Operation
IAsyncResult BeginSearchQuantumTasks(SearchQuantumTasksRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the SearchQuantumTasks operation.
///
///
/// The IAsyncResult returned by the call to BeginSearchQuantumTasks.
///
/// Returns a SearchQuantumTasksResult from Braket.
/// REST API Reference for SearchQuantumTasks Operation
SearchQuantumTasksResponse EndSearchQuantumTasks(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Add a tag to the specified resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by Braket.
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from Braket.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Remove tags from a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by Braket.
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonBraketClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from Braket.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
}
}