braket/aws.sdk.kotlin.services.braket/BraketClient

BraketClient

The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.

To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.

In this guide:

CommonParameters
CommonErrors

Available languages for AWS SDK:

Code examples from the Amazon Braket Tutorials GitHub repository:

Amazon Braket Examples

Types

Builder

class Builder : AbstractSdkClientBuilder<BraketClient.Config, BraketClient.Config.Builder, BraketClient>

Companion

object Companion : AbstractAwsSdkClientFactory<BraketClient.Config, BraketClient.Config.Builder, BraketClient, BraketClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

config

abstract override val config: BraketClient.Config

BraketClient's configuration

Functions

cancelJob

abstract suspend fun cancelJob(input: CancelJobRequest): CancelJobResponse

Cancels an Amazon Braket hybrid job.

cancelQuantumTask

abstract suspend fun cancelQuantumTask(input: CancelQuantumTaskRequest): CancelQuantumTaskResponse

Cancels the specified task.

createJob

abstract suspend fun createJob(input: CreateJobRequest): CreateJobResponse

Creates an Amazon Braket hybrid job.

createQuantumTask

abstract suspend fun createQuantumTask(input: CreateQuantumTaskRequest): CreateQuantumTaskResponse

Creates a quantum task.

createSpendingLimit

abstract suspend fun createSpendingLimit(input: CreateSpendingLimitRequest): CreateSpendingLimitResponse

Creates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.

deleteSpendingLimit

abstract suspend fun deleteSpendingLimit(input: DeleteSpendingLimitRequest): DeleteSpendingLimitResponse

Deletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes unrestricted for spending.

getDevice

abstract suspend fun getDevice(input: GetDeviceRequest): GetDeviceResponse

Retrieves the devices available in Amazon Braket.

getJob

abstract suspend fun getJob(input: GetJobRequest): GetJobResponse

Retrieves the specified Amazon Braket hybrid job.

getQuantumTask

abstract suspend fun getQuantumTask(input: GetQuantumTaskRequest): GetQuantumTaskResponse

Retrieves the specified quantum task.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Shows the tags associated with this resource.

searchDevices

abstract suspend fun searchDevices(input: SearchDevicesRequest): SearchDevicesResponse

Searches for devices using the specified filters.

searchJobs

abstract suspend fun searchJobs(input: SearchJobsRequest): SearchJobsResponse

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

searchQuantumTasks

abstract suspend fun searchQuantumTasks(input: SearchQuantumTasksRequest): SearchQuantumTasksResponse

Searches for tasks that match the specified filter values.

searchSpendingLimits

abstract suspend fun searchSpendingLimits(input: SearchSpendingLimitsRequest = SearchSpendingLimitsRequest { }): SearchSpendingLimitsResponse

Searches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add a tag to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Remove tags from a resource.

updateSpendingLimit

abstract suspend fun updateSpendingLimit(input: UpdateSpendingLimitRequest): UpdateSpendingLimitResponse

Updates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.

Inherited functions

cancelJob

inline suspend fun BraketClient.cancelJob(crossinline block: CancelJobRequest.Builder.() -> Unit): CancelJobResponse

Cancels an Amazon Braket hybrid job.

cancelQuantumTask

inline suspend fun BraketClient.cancelQuantumTask(crossinline block: CancelQuantumTaskRequest.Builder.() -> Unit): CancelQuantumTaskResponse

Cancels the specified task.

expect abstract fun close()

createJob

inline suspend fun BraketClient.createJob(crossinline block: CreateJobRequest.Builder.() -> Unit): CreateJobResponse

Creates an Amazon Braket hybrid job.

createQuantumTask

inline suspend fun BraketClient.createQuantumTask(crossinline block: CreateQuantumTaskRequest.Builder.() -> Unit): CreateQuantumTaskResponse

Creates a quantum task.

createSpendingLimit

inline suspend fun BraketClient.createSpendingLimit(crossinline block: CreateSpendingLimitRequest.Builder.() -> Unit): CreateSpendingLimitResponse

deleteSpendingLimit

inline suspend fun BraketClient.deleteSpendingLimit(crossinline block: DeleteSpendingLimitRequest.Builder.() -> Unit): DeleteSpendingLimitResponse

Deletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes unrestricted for spending.

getDevice

inline suspend fun BraketClient.getDevice(crossinline block: GetDeviceRequest.Builder.() -> Unit): GetDeviceResponse

Retrieves the devices available in Amazon Braket.

getJob

inline suspend fun BraketClient.getJob(crossinline block: GetJobRequest.Builder.() -> Unit): GetJobResponse

Retrieves the specified Amazon Braket hybrid job.

getQuantumTask

inline suspend fun BraketClient.getQuantumTask(crossinline block: GetQuantumTaskRequest.Builder.() -> Unit): GetQuantumTaskResponse

Retrieves the specified quantum task.

listTagsForResource

inline suspend fun BraketClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Shows the tags associated with this resource.

searchDevices

inline suspend fun BraketClient.searchDevices(crossinline block: SearchDevicesRequest.Builder.() -> Unit): SearchDevicesResponse

Searches for devices using the specified filters.

searchDevicesPaginated

fun BraketClient.searchDevicesPaginated(initialRequest: SearchDevicesRequest): Flow<SearchDevicesResponse>

fun BraketClient.searchDevicesPaginated(block: SearchDevicesRequest.Builder.() -> Unit): Flow<SearchDevicesResponse>

Paginate over SearchDevicesResponse results.

searchJobs

inline suspend fun BraketClient.searchJobs(crossinline block: SearchJobsRequest.Builder.() -> Unit): SearchJobsResponse

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

searchJobsPaginated

fun BraketClient.searchJobsPaginated(initialRequest: SearchJobsRequest): Flow<SearchJobsResponse>

fun BraketClient.searchJobsPaginated(block: SearchJobsRequest.Builder.() -> Unit): Flow<SearchJobsResponse>

Paginate over SearchJobsResponse results.

searchQuantumTasks

inline suspend fun BraketClient.searchQuantumTasks(crossinline block: SearchQuantumTasksRequest.Builder.() -> Unit): SearchQuantumTasksResponse

Searches for tasks that match the specified filter values.

searchQuantumTasksPaginated

fun BraketClient.searchQuantumTasksPaginated(initialRequest: SearchQuantumTasksRequest): Flow<SearchQuantumTasksResponse>

fun BraketClient.searchQuantumTasksPaginated(block: SearchQuantumTasksRequest.Builder.() -> Unit): Flow<SearchQuantumTasksResponse>

Paginate over SearchQuantumTasksResponse results.

searchSpendingLimits

inline suspend fun BraketClient.searchSpendingLimits(crossinline block: SearchSpendingLimitsRequest.Builder.() -> Unit): SearchSpendingLimitsResponse

searchSpendingLimitsPaginated

fun BraketClient.searchSpendingLimitsPaginated(initialRequest: SearchSpendingLimitsRequest = SearchSpendingLimitsRequest { }): Flow<SearchSpendingLimitsResponse>

fun BraketClient.searchSpendingLimitsPaginated(block: SearchSpendingLimitsRequest.Builder.() -> Unit): Flow<SearchSpendingLimitsResponse>

Paginate over SearchSpendingLimitsResponse results.

tagResource

inline suspend fun BraketClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Add a tag to the specified resource.

untagResource

inline suspend fun BraketClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove tags from a resource.

updateSpendingLimit

inline suspend fun BraketClient.updateSpendingLimit(crossinline block: UpdateSpendingLimitRequest.Builder.() -> Unit): UpdateSpendingLimitResponse

Updates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.

withConfig

fun BraketClient.withConfig(block: BraketClient.Config.Builder.() -> Unit): BraketClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.