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

BraketClient

interface BraketClient : SdkClient

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

Additional Resources:

Amazon Braket Developer Guide

Types

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

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

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

Properties

abstract override val config: BraketClient.Config

BraketClient's configuration

Functions

abstract suspend fun cancelJob(input: CancelJobRequest): CancelJobResponse

Cancels an Amazon Braket job.

cancelQuantumTask

abstract suspend fun cancelQuantumTask(input: CancelQuantumTaskRequest): CancelQuantumTaskResponse

Cancels the specified task.

abstract suspend fun createJob(input: CreateJobRequest): CreateJobResponse

Creates an Amazon Braket job.

createQuantumTask

abstract suspend fun createQuantumTask(input: CreateQuantumTaskRequest): CreateQuantumTaskResponse

Creates a quantum task.

abstract suspend fun getDevice(input: GetDeviceRequest): GetDeviceResponse

Retrieves the devices available in Amazon Braket.

abstract suspend fun getJob(input: GetJobRequest): GetJobResponse

Retrieves the specified Amazon Braket job.

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.

abstract suspend fun searchDevices(input: SearchDevicesRequest): SearchDevicesResponse

Searches for devices using the specified filters.

abstract suspend fun searchJobs(input: SearchJobsRequest): SearchJobsResponse

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

searchQuantumTasks

abstract suspend fun searchQuantumTasks(input: SearchQuantumTasksRequest): SearchQuantumTasksResponse

Searches for tasks that match the specified filter values.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add a tag to the specified resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Remove tags from a resource.

Inherited functions

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

Cancels an Amazon Braket job.

cancelQuantumTask

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

Cancels the specified task.

expect abstract fun close()

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

Creates an Amazon Braket job.

createQuantumTask

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

Creates a quantum task.

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

Retrieves the devices available in Amazon Braket.

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

Retrieves the specified Amazon Braket job.

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.

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

Searches for devices using the specified filters.

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

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

searchQuantumTasks

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

Searches for tasks that match the specified filter values.

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

Add a tag to the specified resource.

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

Remove tags from a resource.

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.