Braket

public struct Braket

Client object for interacting with AWS Braket service.

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

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the Braket client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    cancelQuantumTask(_:)

Cancels the specified task.

Declaration

Swift

public func cancelQuantumTask(_ input: CancelQuantumTaskRequest) -> EventLoopFuture<CancelQuantumTaskResponse>


                    
                    
                    createQuantumTask(_:)

Creates a quantum task.

Declaration

Swift

public func createQuantumTask(_ input: CreateQuantumTaskRequest) -> EventLoopFuture<CreateQuantumTaskResponse>


                    
                    
                    getDevice(_:)

Retrieves the devices available in Amazon Braket.

Declaration

Swift

public func getDevice(_ input: GetDeviceRequest) -> EventLoopFuture<GetDeviceResponse>


                    
                    
                    getQuantumTask(_:)

Retrieves the specified quantum task.

Declaration

Swift

public func getQuantumTask(_ input: GetQuantumTaskRequest) -> EventLoopFuture<GetQuantumTaskResponse>


                    
                    
                    searchDevices(_:)

Searches for devices using the specified filters.

Declaration

Swift

public func searchDevices(_ input: SearchDevicesRequest) -> EventLoopFuture<SearchDevicesResponse>


                    
                    
                    searchQuantumTasks(_:)

Searches for tasks that match the specified filter values.

Declaration

Swift

public func searchQuantumTasks(_ input: SearchQuantumTasksRequest) -> EventLoopFuture<SearchQuantumTasksResponse>

Paginators


                    
                    
                    searchDevicesPaginator(_:onPage:)

Searches for devices using the specified filters.

Declaration

Swift

public func searchDevicesPaginator(_ input: SearchDevicesRequest, onPage: @escaping (SearchDevicesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    searchQuantumTasksPaginator(_:onPage:)

Searches for tasks that match the specified filter values.

Declaration

Swift

public func searchQuantumTasksPaginator(_ input: SearchQuantumTasksRequest, onPage: @escaping (SearchQuantumTasksResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    SearchDevicesRequest

Undocumented

Declaration

Swift

public struct SearchDevicesRequest : AWSShape

extension Braket.SearchDevicesRequest: AWSPaginateStringToken


                    
                    
                    SearchQuantumTasksRequest

Undocumented

Declaration

Swift

public struct SearchQuantumTasksRequest : AWSShape

extension Braket.SearchQuantumTasksRequest: AWSPaginateStringToken

CancelQuantumTaskRequest
Undocumented
See more
Declaration
Swift

public struct CancelQuantumTaskRequest : AWSShape
CancelQuantumTaskResponse
Undocumented
See more
Declaration
Swift

public struct CancelQuantumTaskResponse : AWSShape
CreateQuantumTaskRequest
Undocumented
See more
Declaration
Swift

public struct CreateQuantumTaskRequest : AWSShape
CreateQuantumTaskResponse
Undocumented
See more
Declaration
Swift

public struct CreateQuantumTaskResponse : AWSShape
DeviceSummary
Undocumented
See more
Declaration
Swift

public struct DeviceSummary : AWSShape
GetDeviceRequest
Undocumented
See more
Declaration
Swift

public struct GetDeviceRequest : AWSShape
GetDeviceResponse
Undocumented
See more
Declaration
Swift

public struct GetDeviceResponse : AWSShape
GetQuantumTaskRequest
Undocumented
See more
Declaration
Swift

public struct GetQuantumTaskRequest : AWSShape
GetQuantumTaskResponse
Undocumented
See more
Declaration
Swift

public struct GetQuantumTaskResponse : AWSShape
QuantumTaskSummary
Undocumented
See more
Declaration
Swift

public struct QuantumTaskSummary : AWSShape
SearchDevicesFilter
Undocumented
See more
Declaration
Swift

public struct SearchDevicesFilter : AWSShape
SearchDevicesResponse
Undocumented
See more
Declaration
Swift

public struct SearchDevicesResponse : AWSShape
SearchQuantumTasksFilter
Undocumented
See more
Declaration
Swift

public struct SearchQuantumTasksFilter : AWSShape
SearchQuantumTasksResponse
Undocumented
See more
Declaration
Swift

public struct SearchQuantumTasksResponse : AWSShape

Enums


                    
                    
                    CancellationStatus

Undocumented

Declaration

Swift

public enum CancellationStatus : String, CustomStringConvertible, Codable


                    
                    
                    DeviceStatus

Undocumented

Declaration

Swift

public enum DeviceStatus : String, CustomStringConvertible, Codable


                    
                    
                    DeviceType

Undocumented

Declaration

Swift

public enum DeviceType : String, CustomStringConvertible, Codable


                    
                    
                    QuantumTaskStatus

Undocumented

Declaration

Swift

public enum QuantumTaskStatus : String, CustomStringConvertible, Codable


                    
                    
                    SearchQuantumTasksFilterOperator

Undocumented

Declaration

Swift

public enum SearchQuantumTasksFilterOperator : String, CustomStringConvertible, Codable