AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

You do not have sufficient access to perform this action.

Class AlgorithmSpecification

Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.

Class Association

The Amazon Braket resource and the association type.

Class BraketPaginatorFactory

Paginators for the Braket service

Class CancelJobRequest

Container for the parameters to the CancelJob operation. Cancels an Amazon Braket job.

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class CancelQuantumTaskRequest

Container for the parameters to the CancelQuantumTask operation. Cancels the specified task.

Class CancelQuantumTaskResponse

This is the response object from the CancelQuantumTask operation.

Class ConflictException

An error occurred due to a conflict.

Class ContainerImage

The container image used to create an Amazon Braket job.

Class CreateJobRequest

Container for the parameters to the CreateJob operation. Creates an Amazon Braket job.

Class CreateJobResponse

This is the response object from the CreateJob operation.

Class CreateQuantumTaskRequest

Container for the parameters to the CreateQuantumTask operation. Creates a quantum task.

Class CreateQuantumTaskResponse

This is the response object from the CreateQuantumTask operation.

Class DataSource

Information about the source of the data used by the Amazon Braket job.

Class DeviceConfig

Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.

Class DeviceOfflineException

The specified device is currently offline.

Class DeviceQueueInfo

Information about tasks and jobs queued on a device.

Class DeviceRetiredException

The specified device has been retired.

Class DeviceSummary

Includes information about the device.

Class GetDeviceRequest

Container for the parameters to the GetDevice operation. 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.

Class GetDeviceResponse

This is the response object from the GetDevice operation.

Class GetJobRequest

Container for the parameters to the GetJob operation. Retrieves the specified Amazon Braket job.

Class GetJobResponse

This is the response object from the GetJob operation.

Class GetQuantumTaskRequest

Container for the parameters to the GetQuantumTask operation. Retrieves the specified quantum task.

Class GetQuantumTaskResponse

This is the response object from the GetQuantumTask operation.

Class HybridJobQueueInfo

Information about the queue for a specified job.

Class InputFileConfig

A list of parameters that specify the input channels, type of input data, and where it is located.

Class InstanceConfig

Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.

Class InternalServiceException

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

Class JobCheckpointConfig

Contains information about the output locations for job checkpoint data.

Class JobEventDetails

Details about the type and time events occurred related to the Amazon Braket job.

Class JobOutputDataConfig

Specifies the path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Class JobStoppingCondition

Specifies limits for how long an Amazon Braket job can run.

Class JobSummary

Provides summary information about an Amazon Braket job.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Shows the tags associated with this resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class QuantumTaskQueueInfo

Information about the queue for the specified quantum task.

Class QuantumTaskSummary

Includes information about a quantum task.

Class ResourceNotFoundException

The specified resource was not found.

Class S3DataSource

Information about the data stored in Amazon S3 used by the Amazon Braket job.

Class ScriptModeConfig

Contains information about the Python scripts used for entry and by an Amazon Braket job.

Class SearchDevicesFilter

The filter to use for searching devices.

Class SearchDevicesRequest

Container for the parameters to the SearchDevices operation. Searches for devices using the specified filters.

Class SearchDevicesResponse

This is the response object from the SearchDevices operation.

Class SearchJobsFilter

A filter used to search for Amazon Braket jobs.

Class SearchJobsRequest

Container for the parameters to the SearchJobs operation. Searches for Amazon Braket jobs that match the specified filter values.

Class SearchJobsResponse

This is the response object from the SearchJobs operation.

Class SearchQuantumTasksFilter

A filter to use to search for tasks.

Class SearchQuantumTasksRequest

Container for the parameters to the SearchQuantumTasks operation. Searches for tasks that match the specified filter values.

Class SearchQuantumTasksResponse

This is the response object from the SearchQuantumTasks operation.

Class ServiceQuotaExceededException

The request failed because a service quota is exceeded.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Add a tag to the specified resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

The throttling rate limit is met.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Remove tags from a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class ValidationException

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

Interfaces

NameDescription
Interface IBraketPaginatorFactory

Paginators for the Braket service

Interface ISearchDevicesPaginator

Paginator for the SearchDevices operation

Interface ISearchJobsPaginator

Paginator for the SearchJobs operation

Interface ISearchQuantumTasksPaginator

Paginator for the SearchQuantumTasks operation