/*
* 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.Threading;
using System.Threading.Tasks;
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
{
///
/// Paginators for the service
///
IBraketPaginatorFactory Paginators { get; }
#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);
///
/// Cancels an Amazon Braket job.
///
/// Container for the necessary parameters to execute the CancelJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CancelJobAsync(CancelJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Cancels the specified task.
///
/// Container for the necessary parameters to execute the CancelQuantumTask service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CancelQuantumTaskAsync(CancelQuantumTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Creates an Amazon Braket job.
///
/// Container for the necessary parameters to execute the CreateJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateJobAsync(CreateJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Creates a quantum task.
///
/// Container for the necessary parameters to execute the CreateQuantumTask service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateQuantumTaskAsync(CreateQuantumTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetDeviceAsync(GetDeviceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Retrieves the specified Amazon Braket job.
///
/// Container for the necessary parameters to execute the GetJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetJobAsync(GetJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Retrieves the specified quantum task.
///
/// Container for the necessary parameters to execute the GetQuantumTask service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetQuantumTaskAsync(GetQuantumTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Shows the tags associated with this resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Searches for devices using the specified filters.
///
/// Container for the necessary parameters to execute the SearchDevices service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SearchDevicesAsync(SearchDevicesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Searches for Amazon Braket jobs that match the specified filter values.
///
/// Container for the necessary parameters to execute the SearchJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SearchJobsAsync(SearchJobsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Searches for tasks that match the specified filter values.
///
/// Container for the necessary parameters to execute the SearchQuantumTasks service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SearchQuantumTasksAsync(SearchQuantumTasksRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Add a tag to the specified resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Remove tags from a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}