braket

package
v1.34.25 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2020 License: Apache-2.0 Imports: 10 Imported by: 13

Documentation

Overview

Package braket provides the client and types for making API requests to Braket.

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

See https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01 for more information on this service.

See braket package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/braket/

Using the Client

To contact Braket with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Braket client Braket for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/braket/#New

Index

Constants

View Source 
const (
	// CancellationStatusCancelled is a CancellationStatus enum value
	CancellationStatusCancelled = "CANCELLED"

	// CancellationStatusCancelling is a CancellationStatus enum value
	CancellationStatusCancelling = "CANCELLING"
)
View Source 
const (
	// DeviceStatusOffline is a DeviceStatus enum value
	DeviceStatusOffline = "OFFLINE"

	// DeviceStatusOnline is a DeviceStatus enum value
	DeviceStatusOnline = "ONLINE"
)
View Source 
const (
	// DeviceTypeQpu is a DeviceType enum value
	DeviceTypeQpu = "QPU"

	// DeviceTypeSimulator is a DeviceType enum value
	DeviceTypeSimulator = "SIMULATOR"
)
View Source 
const (
	// QuantumTaskStatusCancelled is a QuantumTaskStatus enum value
	QuantumTaskStatusCancelled = "CANCELLED"

	// QuantumTaskStatusCancelling is a QuantumTaskStatus enum value
	QuantumTaskStatusCancelling = "CANCELLING"

	// QuantumTaskStatusCompleted is a QuantumTaskStatus enum value
	QuantumTaskStatusCompleted = "COMPLETED"

	// QuantumTaskStatusCreated is a QuantumTaskStatus enum value
	QuantumTaskStatusCreated = "CREATED"

	// QuantumTaskStatusFailed is a QuantumTaskStatus enum value
	QuantumTaskStatusFailed = "FAILED"

	// QuantumTaskStatusQueued is a QuantumTaskStatus enum value
	QuantumTaskStatusQueued = "QUEUED"

	// QuantumTaskStatusRunning is a QuantumTaskStatus enum value
	QuantumTaskStatusRunning = "RUNNING"
)
View Source 
const (
	// SearchQuantumTasksFilterOperatorBetween is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorBetween = "BETWEEN"

	// SearchQuantumTasksFilterOperatorEqual is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorEqual = "EQUAL"

	// SearchQuantumTasksFilterOperatorGt is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorGt = "GT"

	// SearchQuantumTasksFilterOperatorGte is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorGte = "GTE"

	// SearchQuantumTasksFilterOperatorLt is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorLt = "LT"

	// SearchQuantumTasksFilterOperatorLte is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorLte = "LTE"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// An error occurred due to a conflict.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDeviceOfflineException for service response error code
	// "DeviceOfflineException".
	//
	// The specified device is currently offline.
	ErrCodeDeviceOfflineException = "DeviceOfflineException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// The request processing has failed because of an unknown error, exception
	// or failure.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request failed because a service quota is met.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The throttling rate limit is met.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Braket" // Name of service.
	EndpointsID = "braket" // ID to lookup a service endpoint with.
	ServiceID   = "Braket" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func CancellationStatus_Values 

func CancellationStatus_Values() []string

CancellationStatus_Values returns all elements of the CancellationStatus enum

func DeviceStatus_Values 

func DeviceStatus_Values() []string

DeviceStatus_Values returns all elements of the DeviceStatus enum

func DeviceType_Values 

func DeviceType_Values() []string

DeviceType_Values returns all elements of the DeviceType enum

func QuantumTaskStatus_Values 

func QuantumTaskStatus_Values() []string

QuantumTaskStatus_Values returns all elements of the QuantumTaskStatus enum

func SearchQuantumTasksFilterOperator_Values 

func SearchQuantumTasksFilterOperator_Values() []string

SearchQuantumTasksFilterOperator_Values returns all elements of the SearchQuantumTasksFilterOperator enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation

type Braket 

type Braket struct {
	*client.Client
}

Braket provides the API operation methods for making requests to Braket. See this package's package overview docs for details on the service.

Braket methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Braket

New creates a new instance of the Braket client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Braket client from just a session.
svc := braket.New(mySession)

// Create a Braket client with additional configuration
svc := braket.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Braket) CancelQuantumTask 

func (c *Braket) CancelQuantumTask(input *CancelQuantumTaskInput) (*CancelQuantumTaskOutput, error)

CancelQuantumTask API operation for Braket.

Cancels the specified task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation CancelQuantumTask for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ConflictException An error occurred due to a conflict.

  • ThrottlingException The throttling rate limit is met.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTask

func (*Braket) CancelQuantumTaskRequest 

func (c *Braket) CancelQuantumTaskRequest(input *CancelQuantumTaskInput) (req *request.Request, output *CancelQuantumTaskOutput)

CancelQuantumTaskRequest generates a "aws/request.Request" representing the client's request for the CancelQuantumTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelQuantumTask for more information on using the CancelQuantumTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelQuantumTaskRequest method.
req, resp := client.CancelQuantumTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTask

func (*Braket) CancelQuantumTaskWithContext 

func (c *Braket) CancelQuantumTaskWithContext(ctx aws.Context, input *CancelQuantumTaskInput, opts ...request.Option) (*CancelQuantumTaskOutput, error)

CancelQuantumTaskWithContext is the same as CancelQuantumTask with the addition of the ability to pass a context and additional request options.

See CancelQuantumTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) CreateQuantumTask 

func (c *Braket) CreateQuantumTask(input *CreateQuantumTaskInput) (*CreateQuantumTaskOutput, error)

CreateQuantumTask API operation for Braket.

Creates a quantum task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation CreateQuantumTask for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The throttling rate limit is met.

  • DeviceOfflineException The specified device is currently offline.

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

  • ServiceQuotaExceededException The request failed because a service quota is met.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTask

func (*Braket) CreateQuantumTaskRequest 

func (c *Braket) CreateQuantumTaskRequest(input *CreateQuantumTaskInput) (req *request.Request, output *CreateQuantumTaskOutput)

CreateQuantumTaskRequest generates a "aws/request.Request" representing the client's request for the CreateQuantumTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateQuantumTask for more information on using the CreateQuantumTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateQuantumTaskRequest method.
req, resp := client.CreateQuantumTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTask

func (*Braket) CreateQuantumTaskWithContext 

func (c *Braket) CreateQuantumTaskWithContext(ctx aws.Context, input *CreateQuantumTaskInput, opts ...request.Option) (*CreateQuantumTaskOutput, error)

CreateQuantumTaskWithContext is the same as CreateQuantumTask with the addition of the ability to pass a context and additional request options.

See CreateQuantumTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) GetDevice 

func (c *Braket) GetDevice(input *GetDeviceInput) (*GetDeviceOutput, error)

GetDevice API operation for Braket.

Retrieves the devices available in Amazon Braket.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation GetDevice for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The throttling rate limit is met.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetDevice

func (*Braket) GetDeviceRequest 

func (c *Braket) GetDeviceRequest(input *GetDeviceInput) (req *request.Request, output *GetDeviceOutput)

GetDeviceRequest generates a "aws/request.Request" representing the client's request for the GetDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDevice for more information on using the GetDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDeviceRequest method.
req, resp := client.GetDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetDevice

func (*Braket) GetDeviceWithContext 

func (c *Braket) GetDeviceWithContext(ctx aws.Context, input *GetDeviceInput, opts ...request.Option) (*GetDeviceOutput, error)

GetDeviceWithContext is the same as GetDevice with the addition of the ability to pass a context and additional request options.

See GetDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) GetQuantumTask 

func (c *Braket) GetQuantumTask(input *GetQuantumTaskInput) (*GetQuantumTaskOutput, error)

GetQuantumTask API operation for Braket.

Retrieves the specified quantum task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation GetQuantumTask for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The throttling rate limit is met.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetQuantumTask

func (*Braket) GetQuantumTaskRequest 

func (c *Braket) GetQuantumTaskRequest(input *GetQuantumTaskInput) (req *request.Request, output *GetQuantumTaskOutput)

GetQuantumTaskRequest generates a "aws/request.Request" representing the client's request for the GetQuantumTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQuantumTask for more information on using the GetQuantumTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetQuantumTaskRequest method.
req, resp := client.GetQuantumTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetQuantumTask

func (*Braket) GetQuantumTaskWithContext 

func (c *Braket) GetQuantumTaskWithContext(ctx aws.Context, input *GetQuantumTaskInput, opts ...request.Option) (*GetQuantumTaskOutput, error)

GetQuantumTaskWithContext is the same as GetQuantumTask with the addition of the ability to pass a context and additional request options.

See GetQuantumTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) SearchDevices 

func (c *Braket) SearchDevices(input *SearchDevicesInput) (*SearchDevicesOutput, error)

SearchDevices API operation for Braket.

Searches for devices using the specified filters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation SearchDevices for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The throttling rate limit is met.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevices

func (*Braket) SearchDevicesPages 

func (c *Braket) SearchDevicesPages(input *SearchDevicesInput, fn func(*SearchDevicesOutput, bool) bool) error

SearchDevicesPages iterates over the pages of a SearchDevices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchDevices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a SearchDevices operation.
pageNum := 0
err := client.SearchDevicesPages(params,
    func(page *braket.SearchDevicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Braket) SearchDevicesPagesWithContext 

func (c *Braket) SearchDevicesPagesWithContext(ctx aws.Context, input *SearchDevicesInput, fn func(*SearchDevicesOutput, bool) bool, opts ...request.Option) error

SearchDevicesPagesWithContext same as SearchDevicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) SearchDevicesRequest 

func (c *Braket) SearchDevicesRequest(input *SearchDevicesInput) (req *request.Request, output *SearchDevicesOutput)

SearchDevicesRequest generates a "aws/request.Request" representing the client's request for the SearchDevices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchDevices for more information on using the SearchDevices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchDevicesRequest method.
req, resp := client.SearchDevicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevices

func (*Braket) SearchDevicesWithContext 

func (c *Braket) SearchDevicesWithContext(ctx aws.Context, input *SearchDevicesInput, opts ...request.Option) (*SearchDevicesOutput, error)

SearchDevicesWithContext is the same as SearchDevices with the addition of the ability to pass a context and additional request options.

See SearchDevices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) SearchQuantumTasks 

func (c *Braket) SearchQuantumTasks(input *SearchQuantumTasksInput) (*SearchQuantumTasksOutput, error)

SearchQuantumTasks API operation for Braket.

Searches for tasks that match the specified filter values.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Braket's API operation SearchQuantumTasks for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The throttling rate limit is met.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasks

func (*Braket) SearchQuantumTasksPages 

func (c *Braket) SearchQuantumTasksPages(input *SearchQuantumTasksInput, fn func(*SearchQuantumTasksOutput, bool) bool) error

SearchQuantumTasksPages iterates over the pages of a SearchQuantumTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchQuantumTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a SearchQuantumTasks operation.
pageNum := 0
err := client.SearchQuantumTasksPages(params,
    func(page *braket.SearchQuantumTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Braket) SearchQuantumTasksPagesWithContext 

func (c *Braket) SearchQuantumTasksPagesWithContext(ctx aws.Context, input *SearchQuantumTasksInput, fn func(*SearchQuantumTasksOutput, bool) bool, opts ...request.Option) error

SearchQuantumTasksPagesWithContext same as SearchQuantumTasksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Braket) SearchQuantumTasksRequest 

func (c *Braket) SearchQuantumTasksRequest(input *SearchQuantumTasksInput) (req *request.Request, output *SearchQuantumTasksOutput)

SearchQuantumTasksRequest generates a "aws/request.Request" representing the client's request for the SearchQuantumTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchQuantumTasks for more information on using the SearchQuantumTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchQuantumTasksRequest method.
req, resp := client.SearchQuantumTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasks

func (*Braket) SearchQuantumTasksWithContext 

func (c *Braket) SearchQuantumTasksWithContext(ctx aws.Context, input *SearchQuantumTasksInput, opts ...request.Option) (*SearchQuantumTasksOutput, error)

SearchQuantumTasksWithContext is the same as SearchQuantumTasks with the addition of the ability to pass a context and additional request options.

See SearchQuantumTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CancelQuantumTaskInput 

type CancelQuantumTaskInput struct {

	// The client token associated with the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ARN of the task to cancel.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `location:"uri" locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQuantumTaskInput) GoString 

func (s CancelQuantumTaskInput) GoString() string

GoString returns the string representation

func (*CancelQuantumTaskInput) SetClientToken 

func (s *CancelQuantumTaskInput) SetClientToken(v string) *CancelQuantumTaskInput

SetClientToken sets the ClientToken field's value.

func (*CancelQuantumTaskInput) SetQuantumTaskArn 

func (s *CancelQuantumTaskInput) SetQuantumTaskArn(v string) *CancelQuantumTaskInput

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (CancelQuantumTaskInput) String 

func (s CancelQuantumTaskInput) String() string

String returns the string representation

func (*CancelQuantumTaskInput) Validate 

func (s *CancelQuantumTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelQuantumTaskOutput 

type CancelQuantumTaskOutput struct {

	// The status of the cancellation request.
	//
	// CancellationStatus is a required field
	CancellationStatus *string `locationName:"cancellationStatus" type:"string" required:"true" enum:"CancellationStatus"`

	// The ARN of the task.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQuantumTaskOutput) GoString 

func (s CancelQuantumTaskOutput) GoString() string

GoString returns the string representation

func (*CancelQuantumTaskOutput) SetCancellationStatus 

func (s *CancelQuantumTaskOutput) SetCancellationStatus(v string) *CancelQuantumTaskOutput

SetCancellationStatus sets the CancellationStatus field's value.

func (*CancelQuantumTaskOutput) SetQuantumTaskArn 

func (s *CancelQuantumTaskOutput) SetQuantumTaskArn(v string) *CancelQuantumTaskOutput

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (CancelQuantumTaskOutput) String 

func (s CancelQuantumTaskOutput) String() string

String returns the string representation

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred due to a conflict.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation

type CreateQuantumTaskInput 

type CreateQuantumTaskInput struct {

	// The action associated with the task.
	//
	// Action is a required field
	Action aws.JSONValue `locationName:"action" type:"jsonvalue" required:"true"`

	// The client token associated with the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ARN of the device to run the task on.
	//
	// DeviceArn is a required field
	DeviceArn *string `locationName:"deviceArn" min:"1" type:"string" required:"true"`

	// The parameters for the device to run the task on.
	DeviceParameters aws.JSONValue `locationName:"deviceParameters" type:"jsonvalue"`

	// The S3 bucket to store task result files in.
	//
	// OutputS3Bucket is a required field
	OutputS3Bucket *string `locationName:"outputS3Bucket" min:"3" type:"string" required:"true"`

	// The key prefix for the location in the S3 bucket to store task results in.
	//
	// OutputS3KeyPrefix is a required field
	OutputS3KeyPrefix *string `locationName:"outputS3KeyPrefix" min:"1" type:"string" required:"true"`

	// The number of shots to use for the task.
	//
	// Shots is a required field
	Shots *int64 `locationName:"shots" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQuantumTaskInput) GoString 

func (s CreateQuantumTaskInput) GoString() string

GoString returns the string representation

func (*CreateQuantumTaskInput) SetAction 

func (s *CreateQuantumTaskInput) SetAction(v aws.JSONValue) *CreateQuantumTaskInput

SetAction sets the Action field's value.

func (*CreateQuantumTaskInput) SetClientToken 

func (s *CreateQuantumTaskInput) SetClientToken(v string) *CreateQuantumTaskInput

SetClientToken sets the ClientToken field's value.

func (*CreateQuantumTaskInput) SetDeviceArn 

func (s *CreateQuantumTaskInput) SetDeviceArn(v string) *CreateQuantumTaskInput

SetDeviceArn sets the DeviceArn field's value.

func (*CreateQuantumTaskInput) SetDeviceParameters 

func (s *CreateQuantumTaskInput) SetDeviceParameters(v aws.JSONValue) *CreateQuantumTaskInput

SetDeviceParameters sets the DeviceParameters field's value.

func (*CreateQuantumTaskInput) SetOutputS3Bucket 

func (s *CreateQuantumTaskInput) SetOutputS3Bucket(v string) *CreateQuantumTaskInput

SetOutputS3Bucket sets the OutputS3Bucket field's value.

func (*CreateQuantumTaskInput) SetOutputS3KeyPrefix 

func (s *CreateQuantumTaskInput) SetOutputS3KeyPrefix(v string) *CreateQuantumTaskInput

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*CreateQuantumTaskInput) SetShots 

func (s *CreateQuantumTaskInput) SetShots(v int64) *CreateQuantumTaskInput

SetShots sets the Shots field's value.

func (CreateQuantumTaskInput) String 

func (s CreateQuantumTaskInput) String() string

String returns the string representation

func (*CreateQuantumTaskInput) Validate 

func (s *CreateQuantumTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateQuantumTaskOutput 

type CreateQuantumTaskOutput struct {

	// The ARN of the task created by the request.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQuantumTaskOutput) GoString 

func (s CreateQuantumTaskOutput) GoString() string

GoString returns the string representation

func (*CreateQuantumTaskOutput) SetQuantumTaskArn 

func (s *CreateQuantumTaskOutput) SetQuantumTaskArn(v string) *CreateQuantumTaskOutput

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (CreateQuantumTaskOutput) String 

func (s CreateQuantumTaskOutput) String() string

String returns the string representation

type DeviceOfflineException 

type DeviceOfflineException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified device is currently offline.

func (*DeviceOfflineException) Code 

func (s *DeviceOfflineException) Code() string

Code returns the exception type name.

func (*DeviceOfflineException) Error 

func (s *DeviceOfflineException) Error() string

func (DeviceOfflineException) GoString 

func (s DeviceOfflineException) GoString() string

GoString returns the string representation

func (*DeviceOfflineException) Message 

func (s *DeviceOfflineException) Message() string

Message returns the exception's message.

func (*DeviceOfflineException) OrigErr 

func (s *DeviceOfflineException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeviceOfflineException) RequestID 

func (s *DeviceOfflineException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeviceOfflineException) StatusCode 

func (s *DeviceOfflineException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DeviceOfflineException) String 

func (s DeviceOfflineException) String() string

String returns the string representation

type DeviceSummary 

type DeviceSummary struct {

	// The ARN of the device.
	//
	// DeviceArn is a required field
	DeviceArn *string `locationName:"deviceArn" min:"1" type:"string" required:"true"`

	// The name of the device.
	//
	// DeviceName is a required field
	DeviceName *string `locationName:"deviceName" type:"string" required:"true"`

	// The status of the device.
	//
	// DeviceStatus is a required field
	DeviceStatus *string `locationName:"deviceStatus" type:"string" required:"true" enum:"DeviceStatus"`

	// The type of the device.
	//
	// DeviceType is a required field
	DeviceType *string `locationName:"deviceType" type:"string" required:"true" enum:"DeviceType"`

	// The provider of the device.
	//
	// ProviderName is a required field
	ProviderName *string `locationName:"providerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Includes information about the device.

func (DeviceSummary) GoString 

func (s DeviceSummary) GoString() string

GoString returns the string representation

func (*DeviceSummary) SetDeviceArn 

func (s *DeviceSummary) SetDeviceArn(v string) *DeviceSummary

SetDeviceArn sets the DeviceArn field's value.

func (*DeviceSummary) SetDeviceName 

func (s *DeviceSummary) SetDeviceName(v string) *DeviceSummary

SetDeviceName sets the DeviceName field's value.

func (*DeviceSummary) SetDeviceStatus 

func (s *DeviceSummary) SetDeviceStatus(v string) *DeviceSummary

SetDeviceStatus sets the DeviceStatus field's value.

func (*DeviceSummary) SetDeviceType 

func (s *DeviceSummary) SetDeviceType(v string) *DeviceSummary

SetDeviceType sets the DeviceType field's value.

func (*DeviceSummary) SetProviderName 

func (s *DeviceSummary) SetProviderName(v string) *DeviceSummary

SetProviderName sets the ProviderName field's value.

func (DeviceSummary) String 

func (s DeviceSummary) String() string

String returns the string representation

type GetDeviceInput 

type GetDeviceInput struct {

	// The ARN of the device to retrieve.
	//
	// DeviceArn is a required field
	DeviceArn *string `location:"uri" locationName:"deviceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeviceInput) GoString 

func (s GetDeviceInput) GoString() string

GoString returns the string representation

func (*GetDeviceInput) SetDeviceArn 

func (s *GetDeviceInput) SetDeviceArn(v string) *GetDeviceInput

SetDeviceArn sets the DeviceArn field's value.

func (GetDeviceInput) String 

func (s GetDeviceInput) String() string

String returns the string representation

func (*GetDeviceInput) Validate 

func (s *GetDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeviceOutput 

type GetDeviceOutput struct {

	// The ARN of the device.
	//
	// DeviceArn is a required field
	DeviceArn *string `locationName:"deviceArn" min:"1" type:"string" required:"true"`

	// Details about the capabilities of the device.
	//
	// DeviceCapabilities is a required field
	DeviceCapabilities aws.JSONValue `locationName:"deviceCapabilities" type:"jsonvalue" required:"true"`

	// The name of the device.
	//
	// DeviceName is a required field
	DeviceName *string `locationName:"deviceName" type:"string" required:"true"`

	// The status of the device.
	//
	// DeviceStatus is a required field
	DeviceStatus *string `locationName:"deviceStatus" type:"string" required:"true" enum:"DeviceStatus"`

	// The type of the device.
	//
	// DeviceType is a required field
	DeviceType *string `locationName:"deviceType" type:"string" required:"true" enum:"DeviceType"`

	// The name of the partner company for the device.
	//
	// ProviderName is a required field
	ProviderName *string `locationName:"providerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeviceOutput) GoString 

func (s GetDeviceOutput) GoString() string

GoString returns the string representation

func (*GetDeviceOutput) SetDeviceArn 

func (s *GetDeviceOutput) SetDeviceArn(v string) *GetDeviceOutput

SetDeviceArn sets the DeviceArn field's value.

func (*GetDeviceOutput) SetDeviceCapabilities 

func (s *GetDeviceOutput) SetDeviceCapabilities(v aws.JSONValue) *GetDeviceOutput

SetDeviceCapabilities sets the DeviceCapabilities field's value.

func (*GetDeviceOutput) SetDeviceName 

func (s *GetDeviceOutput) SetDeviceName(v string) *GetDeviceOutput

SetDeviceName sets the DeviceName field's value.

func (*GetDeviceOutput) SetDeviceStatus 

func (s *GetDeviceOutput) SetDeviceStatus(v string) *GetDeviceOutput

SetDeviceStatus sets the DeviceStatus field's value.

func (*GetDeviceOutput) SetDeviceType 

func (s *GetDeviceOutput) SetDeviceType(v string) *GetDeviceOutput

SetDeviceType sets the DeviceType field's value.

func (*GetDeviceOutput) SetProviderName 

func (s *GetDeviceOutput) SetProviderName(v string) *GetDeviceOutput

SetProviderName sets the ProviderName field's value.

func (GetDeviceOutput) String 

func (s GetDeviceOutput) String() string

String returns the string representation

type GetQuantumTaskInput 

type GetQuantumTaskInput struct {

	// the ARN of the task to retrieve.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `location:"uri" locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQuantumTaskInput) GoString 

func (s GetQuantumTaskInput) GoString() string

GoString returns the string representation

func (*GetQuantumTaskInput) SetQuantumTaskArn 

func (s *GetQuantumTaskInput) SetQuantumTaskArn(v string) *GetQuantumTaskInput

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (GetQuantumTaskInput) String 

func (s GetQuantumTaskInput) String() string

String returns the string representation

func (*GetQuantumTaskInput) Validate 

func (s *GetQuantumTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQuantumTaskOutput 

type GetQuantumTaskOutput struct {

	// The time at which the task was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The ARN of the device the task was run on.
	//
	// DeviceArn is a required field
	DeviceArn *string `locationName:"deviceArn" min:"1" type:"string" required:"true"`

	// The parameters for the device on which the task ran.
	//
	// DeviceParameters is a required field
	DeviceParameters aws.JSONValue `locationName:"deviceParameters" type:"jsonvalue" required:"true"`

	// The time at which the task ended.
	EndedAt *time.Time `locationName:"endedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The reason that a task failed.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The S3 bucket where task results are stored.
	//
	// OutputS3Bucket is a required field
	OutputS3Bucket *string `locationName:"outputS3Bucket" type:"string" required:"true"`

	// The folder in the S3 bucket where task results are stored.
	//
	// OutputS3Directory is a required field
	OutputS3Directory *string `locationName:"outputS3Directory" type:"string" required:"true"`

	// The ARN of the task.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`

	// The number of shots used in the task.
	//
	// Shots is a required field
	Shots *int64 `locationName:"shots" type:"long" required:"true"`

	// The status of the task.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"QuantumTaskStatus"`
	// contains filtered or unexported fields
}

func (GetQuantumTaskOutput) GoString 

func (s GetQuantumTaskOutput) GoString() string

GoString returns the string representation

func (*GetQuantumTaskOutput) SetCreatedAt 

func (s *GetQuantumTaskOutput) SetCreatedAt(v time.Time) *GetQuantumTaskOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetQuantumTaskOutput) SetDeviceArn 

func (s *GetQuantumTaskOutput) SetDeviceArn(v string) *GetQuantumTaskOutput

SetDeviceArn sets the DeviceArn field's value.

func (*GetQuantumTaskOutput) SetDeviceParameters 

func (s *GetQuantumTaskOutput) SetDeviceParameters(v aws.JSONValue) *GetQuantumTaskOutput

SetDeviceParameters sets the DeviceParameters field's value.

func (*GetQuantumTaskOutput) SetEndedAt 

func (s *GetQuantumTaskOutput) SetEndedAt(v time.Time) *GetQuantumTaskOutput

SetEndedAt sets the EndedAt field's value.

func (*GetQuantumTaskOutput) SetFailureReason 

func (s *GetQuantumTaskOutput) SetFailureReason(v string) *GetQuantumTaskOutput

SetFailureReason sets the FailureReason field's value.

func (*GetQuantumTaskOutput) SetOutputS3Bucket 

func (s *GetQuantumTaskOutput) SetOutputS3Bucket(v string) *GetQuantumTaskOutput

SetOutputS3Bucket sets the OutputS3Bucket field's value.

func (*GetQuantumTaskOutput) SetOutputS3Directory 

func (s *GetQuantumTaskOutput) SetOutputS3Directory(v string) *GetQuantumTaskOutput

SetOutputS3Directory sets the OutputS3Directory field's value.

func (*GetQuantumTaskOutput) SetQuantumTaskArn 

func (s *GetQuantumTaskOutput) SetQuantumTaskArn(v string) *GetQuantumTaskOutput

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (*GetQuantumTaskOutput) SetShots 

func (s *GetQuantumTaskOutput) SetShots(v int64) *GetQuantumTaskOutput

SetShots sets the Shots field's value.

func (*GetQuantumTaskOutput) SetStatus 

func (s *GetQuantumTaskOutput) SetStatus(v string) *GetQuantumTaskOutput

SetStatus sets the Status field's value.

func (GetQuantumTaskOutput) String 

func (s GetQuantumTaskOutput) String() string

String returns the string representation

type InternalServiceException 

type InternalServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServiceException) Code 

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error 

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString 

func (s InternalServiceException) GoString() string

GoString returns the string representation

func (*InternalServiceException) Message 

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr 

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID 

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode 

func (s *InternalServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceException) String 

func (s InternalServiceException) String() string

String returns the string representation

type QuantumTaskSummary 

type QuantumTaskSummary struct {

	// The time at which the task was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The ARN of the device the task ran on.
	//
	// DeviceArn is a required field
	DeviceArn *string `locationName:"deviceArn" min:"1" type:"string" required:"true"`

	// The time at which the task finished.
	EndedAt *time.Time `locationName:"endedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The S3 bucket where the task result file is stored..
	//
	// OutputS3Bucket is a required field
	OutputS3Bucket *string `locationName:"outputS3Bucket" type:"string" required:"true"`

	// The folder in the S3 bucket where the task result file is stored.
	//
	// OutputS3Directory is a required field
	OutputS3Directory *string `locationName:"outputS3Directory" type:"string" required:"true"`

	// The ARN of the task.
	//
	// QuantumTaskArn is a required field
	QuantumTaskArn *string `locationName:"quantumTaskArn" min:"1" type:"string" required:"true"`

	// The shots used for the task.
	//
	// Shots is a required field
	Shots *int64 `locationName:"shots" type:"long" required:"true"`

	// The status of the task.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"QuantumTaskStatus"`
	// contains filtered or unexported fields
}

Includes information about a quantum task.

func (QuantumTaskSummary) GoString 

func (s QuantumTaskSummary) GoString() string

GoString returns the string representation

func (*QuantumTaskSummary) SetCreatedAt 

func (s *QuantumTaskSummary) SetCreatedAt(v time.Time) *QuantumTaskSummary

SetCreatedAt sets the CreatedAt field's value.

func (*QuantumTaskSummary) SetDeviceArn 

func (s *QuantumTaskSummary) SetDeviceArn(v string) *QuantumTaskSummary

SetDeviceArn sets the DeviceArn field's value.

func (*QuantumTaskSummary) SetEndedAt 

func (s *QuantumTaskSummary) SetEndedAt(v time.Time) *QuantumTaskSummary

SetEndedAt sets the EndedAt field's value.

func (*QuantumTaskSummary) SetOutputS3Bucket 

func (s *QuantumTaskSummary) SetOutputS3Bucket(v string) *QuantumTaskSummary

SetOutputS3Bucket sets the OutputS3Bucket field's value.

func (*QuantumTaskSummary) SetOutputS3Directory 

func (s *QuantumTaskSummary) SetOutputS3Directory(v string) *QuantumTaskSummary

SetOutputS3Directory sets the OutputS3Directory field's value.

func (*QuantumTaskSummary) SetQuantumTaskArn 

func (s *QuantumTaskSummary) SetQuantumTaskArn(v string) *QuantumTaskSummary

SetQuantumTaskArn sets the QuantumTaskArn field's value.

func (*QuantumTaskSummary) SetShots 

func (s *QuantumTaskSummary) SetShots(v int64) *QuantumTaskSummary

SetShots sets the Shots field's value.

func (*QuantumTaskSummary) SetStatus 

func (s *QuantumTaskSummary) SetStatus(v string) *QuantumTaskSummary

SetStatus sets the Status field's value.

func (QuantumTaskSummary) String 

func (s QuantumTaskSummary) String() string

String returns the string representation

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource was not found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type SearchDevicesFilter 

type SearchDevicesFilter struct {

	// The name to use to filter results.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The values to use to filter results.
	//
	// Values is a required field
	Values []*string `locationName:"values" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The filter to use for searching devices.

func (SearchDevicesFilter) GoString 

func (s SearchDevicesFilter) GoString() string

GoString returns the string representation

func (*SearchDevicesFilter) SetName 

func (s *SearchDevicesFilter) SetName(v string) *SearchDevicesFilter

SetName sets the Name field's value.

func (*SearchDevicesFilter) SetValues 

func (s *SearchDevicesFilter) SetValues(v []*string) *SearchDevicesFilter

SetValues sets the Values field's value.

func (SearchDevicesFilter) String 

func (s SearchDevicesFilter) String() string

String returns the string representation

func (*SearchDevicesFilter) Validate 

func (s *SearchDevicesFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchDevicesInput 

type SearchDevicesInput struct {

	// The filter values to use to search for a device.
	//
	// Filters is a required field
	Filters []*SearchDevicesFilter `locationName:"filters" type:"list" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token used for pagination of results returned in the response. Use the
	// token returned from the previous request continue results where the previous
	// request ended.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchDevicesInput) GoString 

func (s SearchDevicesInput) GoString() string

GoString returns the string representation

func (*SearchDevicesInput) SetFilters 

func (s *SearchDevicesInput) SetFilters(v []*SearchDevicesFilter) *SearchDevicesInput

SetFilters sets the Filters field's value.

func (*SearchDevicesInput) SetMaxResults 

func (s *SearchDevicesInput) SetMaxResults(v int64) *SearchDevicesInput

SetMaxResults sets the MaxResults field's value.

func (*SearchDevicesInput) SetNextToken 

func (s *SearchDevicesInput) SetNextToken(v string) *SearchDevicesInput

SetNextToken sets the NextToken field's value.

func (SearchDevicesInput) String 

func (s SearchDevicesInput) String() string

String returns the string representation

func (*SearchDevicesInput) Validate 

func (s *SearchDevicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchDevicesOutput 

type SearchDevicesOutput struct {

	// An array of DeviceSummary objects for devices that match the specified filter
	// values.
	//
	// Devices is a required field
	Devices []*DeviceSummary `locationName:"devices" type:"list" required:"true"`

	// A token used for pagination of results, or null if there are no additional
	// results. Use the token value in a subsequent request to continue results
	// where the previous request ended.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchDevicesOutput) GoString 

func (s SearchDevicesOutput) GoString() string

GoString returns the string representation

func (*SearchDevicesOutput) SetDevices 

func (s *SearchDevicesOutput) SetDevices(v []*DeviceSummary) *SearchDevicesOutput

SetDevices sets the Devices field's value.

func (*SearchDevicesOutput) SetNextToken 

func (s *SearchDevicesOutput) SetNextToken(v string) *SearchDevicesOutput

SetNextToken sets the NextToken field's value.

func (SearchDevicesOutput) String 

func (s SearchDevicesOutput) String() string

String returns the string representation

type SearchQuantumTasksFilter 

type SearchQuantumTasksFilter struct {

	// The name of the device used for the task.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// An operator to use in the filter.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"SearchQuantumTasksFilterOperator"`

	// The values to use for the filter.
	//
	// Values is a required field
	Values []*string `locationName:"values" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter to use to search for tasks.

func (SearchQuantumTasksFilter) GoString 

func (s SearchQuantumTasksFilter) GoString() string

GoString returns the string representation

func (*SearchQuantumTasksFilter) SetName 

func (s *SearchQuantumTasksFilter) SetName(v string) *SearchQuantumTasksFilter

SetName sets the Name field's value.

func (*SearchQuantumTasksFilter) SetOperator 

func (s *SearchQuantumTasksFilter) SetOperator(v string) *SearchQuantumTasksFilter

SetOperator sets the Operator field's value.

func (*SearchQuantumTasksFilter) SetValues 

func (s *SearchQuantumTasksFilter) SetValues(v []*string) *SearchQuantumTasksFilter

SetValues sets the Values field's value.

func (SearchQuantumTasksFilter) String 

func (s SearchQuantumTasksFilter) String() string

String returns the string representation

func (*SearchQuantumTasksFilter) Validate 

func (s *SearchQuantumTasksFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchQuantumTasksInput 

type SearchQuantumTasksInput struct {

	// Array of SearchQuantumTasksFilter objects.
	//
	// Filters is a required field
	Filters []*SearchQuantumTasksFilter `locationName:"filters" type:"list" required:"true"`

	// Maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token used for pagination of results returned in the response. Use the
	// token returned from the previous request continue results where the previous
	// request ended.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchQuantumTasksInput) GoString 

func (s SearchQuantumTasksInput) GoString() string

GoString returns the string representation

func (*SearchQuantumTasksInput) SetFilters 

func (s *SearchQuantumTasksInput) SetFilters(v []*SearchQuantumTasksFilter) *SearchQuantumTasksInput

SetFilters sets the Filters field's value.

func (*SearchQuantumTasksInput) SetMaxResults 

func (s *SearchQuantumTasksInput) SetMaxResults(v int64) *SearchQuantumTasksInput

SetMaxResults sets the MaxResults field's value.

func (*SearchQuantumTasksInput) SetNextToken 

func (s *SearchQuantumTasksInput) SetNextToken(v string) *SearchQuantumTasksInput

SetNextToken sets the NextToken field's value.

func (SearchQuantumTasksInput) String 

func (s SearchQuantumTasksInput) String() string

String returns the string representation

func (*SearchQuantumTasksInput) Validate 

func (s *SearchQuantumTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchQuantumTasksOutput 

type SearchQuantumTasksOutput struct {

	// A token used for pagination of results, or null if there are no additional
	// results. Use the token value in a subsequent request to continue results
	// where the previous request ended.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of QuantumTaskSummary objects for tasks that match the specified
	// filters.
	//
	// QuantumTasks is a required field
	QuantumTasks []*QuantumTaskSummary `locationName:"quantumTasks" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (SearchQuantumTasksOutput) GoString 

func (s SearchQuantumTasksOutput) GoString() string

GoString returns the string representation

func (*SearchQuantumTasksOutput) SetNextToken 

func (s *SearchQuantumTasksOutput) SetNextToken(v string) *SearchQuantumTasksOutput

SetNextToken sets the NextToken field's value.

func (*SearchQuantumTasksOutput) SetQuantumTasks 

func (s *SearchQuantumTasksOutput) SetQuantumTasks(v []*QuantumTaskSummary) *SearchQuantumTasksOutput

SetQuantumTasks sets the QuantumTasks field's value.

func (SearchQuantumTasksOutput) String 

func (s SearchQuantumTasksOutput) String() string

String returns the string representation

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request failed because a service quota is met.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The throttling rate limit is met.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package braketiface provides an interface to enable mocking the Braket service client for testing your code.
 Package braketiface provides an interface to enable mocking the Braket service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.