braket

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 15

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.

Additional Resources:

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 (
	// CancellationStatusCancelling is a CancellationStatus enum value
	CancellationStatusCancelling = "CANCELLING"

	// CancellationStatusCancelled is a CancellationStatus enum value
	CancellationStatusCancelled = "CANCELLED"
)
View Source 
const (
	// CompressionTypeNone is a CompressionType enum value
	CompressionTypeNone = "NONE"

	// CompressionTypeGzip is a CompressionType enum value
	CompressionTypeGzip = "GZIP"
)
View Source 
const (
	// DeviceStatusOnline is a DeviceStatus enum value
	DeviceStatusOnline = "ONLINE"

	// DeviceStatusOffline is a DeviceStatus enum value
	DeviceStatusOffline = "OFFLINE"

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

	// DeviceTypeSimulator is a DeviceType enum value
	DeviceTypeSimulator = "SIMULATOR"
)
View Source 
const (
	// InstanceTypeMlM4Xlarge is a InstanceType enum value
	InstanceTypeMlM4Xlarge = "ml.m4.xlarge"

	// InstanceTypeMlM42xlarge is a InstanceType enum value
	InstanceTypeMlM42xlarge = "ml.m4.2xlarge"

	// InstanceTypeMlM44xlarge is a InstanceType enum value
	InstanceTypeMlM44xlarge = "ml.m4.4xlarge"

	// InstanceTypeMlM410xlarge is a InstanceType enum value
	InstanceTypeMlM410xlarge = "ml.m4.10xlarge"

	// InstanceTypeMlM416xlarge is a InstanceType enum value
	InstanceTypeMlM416xlarge = "ml.m4.16xlarge"

	// InstanceTypeMlG4dnXlarge is a InstanceType enum value
	InstanceTypeMlG4dnXlarge = "ml.g4dn.xlarge"

	// InstanceTypeMlG4dn2xlarge is a InstanceType enum value
	InstanceTypeMlG4dn2xlarge = "ml.g4dn.2xlarge"

	// InstanceTypeMlG4dn4xlarge is a InstanceType enum value
	InstanceTypeMlG4dn4xlarge = "ml.g4dn.4xlarge"

	// InstanceTypeMlG4dn8xlarge is a InstanceType enum value
	InstanceTypeMlG4dn8xlarge = "ml.g4dn.8xlarge"

	// InstanceTypeMlG4dn12xlarge is a InstanceType enum value
	InstanceTypeMlG4dn12xlarge = "ml.g4dn.12xlarge"

	// InstanceTypeMlG4dn16xlarge is a InstanceType enum value
	InstanceTypeMlG4dn16xlarge = "ml.g4dn.16xlarge"

	// InstanceTypeMlM5Large is a InstanceType enum value
	InstanceTypeMlM5Large = "ml.m5.large"

	// InstanceTypeMlM5Xlarge is a InstanceType enum value
	InstanceTypeMlM5Xlarge = "ml.m5.xlarge"

	// InstanceTypeMlM52xlarge is a InstanceType enum value
	InstanceTypeMlM52xlarge = "ml.m5.2xlarge"

	// InstanceTypeMlM54xlarge is a InstanceType enum value
	InstanceTypeMlM54xlarge = "ml.m5.4xlarge"

	// InstanceTypeMlM512xlarge is a InstanceType enum value
	InstanceTypeMlM512xlarge = "ml.m5.12xlarge"

	// InstanceTypeMlM524xlarge is a InstanceType enum value
	InstanceTypeMlM524xlarge = "ml.m5.24xlarge"

	// InstanceTypeMlC4Xlarge is a InstanceType enum value
	InstanceTypeMlC4Xlarge = "ml.c4.xlarge"

	// InstanceTypeMlC42xlarge is a InstanceType enum value
	InstanceTypeMlC42xlarge = "ml.c4.2xlarge"

	// InstanceTypeMlC44xlarge is a InstanceType enum value
	InstanceTypeMlC44xlarge = "ml.c4.4xlarge"

	// InstanceTypeMlC48xlarge is a InstanceType enum value
	InstanceTypeMlC48xlarge = "ml.c4.8xlarge"

	// InstanceTypeMlP2Xlarge is a InstanceType enum value
	InstanceTypeMlP2Xlarge = "ml.p2.xlarge"

	// InstanceTypeMlP28xlarge is a InstanceType enum value
	InstanceTypeMlP28xlarge = "ml.p2.8xlarge"

	// InstanceTypeMlP216xlarge is a InstanceType enum value
	InstanceTypeMlP216xlarge = "ml.p2.16xlarge"

	// InstanceTypeMlP32xlarge is a InstanceType enum value
	InstanceTypeMlP32xlarge = "ml.p3.2xlarge"

	// InstanceTypeMlP38xlarge is a InstanceType enum value
	InstanceTypeMlP38xlarge = "ml.p3.8xlarge"

	// InstanceTypeMlP316xlarge is a InstanceType enum value
	InstanceTypeMlP316xlarge = "ml.p3.16xlarge"

	// InstanceTypeMlP3dn24xlarge is a InstanceType enum value
	InstanceTypeMlP3dn24xlarge = "ml.p3dn.24xlarge"

	// InstanceTypeMlP4d24xlarge is a InstanceType enum value
	InstanceTypeMlP4d24xlarge = "ml.p4d.24xlarge"

	// InstanceTypeMlC5Xlarge is a InstanceType enum value
	InstanceTypeMlC5Xlarge = "ml.c5.xlarge"

	// InstanceTypeMlC52xlarge is a InstanceType enum value
	InstanceTypeMlC52xlarge = "ml.c5.2xlarge"

	// InstanceTypeMlC54xlarge is a InstanceType enum value
	InstanceTypeMlC54xlarge = "ml.c5.4xlarge"

	// InstanceTypeMlC59xlarge is a InstanceType enum value
	InstanceTypeMlC59xlarge = "ml.c5.9xlarge"

	// InstanceTypeMlC518xlarge is a InstanceType enum value
	InstanceTypeMlC518xlarge = "ml.c5.18xlarge"

	// InstanceTypeMlC5nXlarge is a InstanceType enum value
	InstanceTypeMlC5nXlarge = "ml.c5n.xlarge"

	// InstanceTypeMlC5n2xlarge is a InstanceType enum value
	InstanceTypeMlC5n2xlarge = "ml.c5n.2xlarge"

	// InstanceTypeMlC5n4xlarge is a InstanceType enum value
	InstanceTypeMlC5n4xlarge = "ml.c5n.4xlarge"

	// InstanceTypeMlC5n9xlarge is a InstanceType enum value
	InstanceTypeMlC5n9xlarge = "ml.c5n.9xlarge"

	// InstanceTypeMlC5n18xlarge is a InstanceType enum value
	InstanceTypeMlC5n18xlarge = "ml.c5n.18xlarge"
)
View Source 
const (
	// JobEventTypeWaitingForPriority is a JobEventType enum value
	JobEventTypeWaitingForPriority = "WAITING_FOR_PRIORITY"

	// JobEventTypeQueuedForExecution is a JobEventType enum value
	JobEventTypeQueuedForExecution = "QUEUED_FOR_EXECUTION"

	// JobEventTypeStartingInstance is a JobEventType enum value
	JobEventTypeStartingInstance = "STARTING_INSTANCE"

	// JobEventTypeDownloadingData is a JobEventType enum value
	JobEventTypeDownloadingData = "DOWNLOADING_DATA"

	// JobEventTypeRunning is a JobEventType enum value
	JobEventTypeRunning = "RUNNING"

	// JobEventTypeDeprioritizedDueToInactivity is a JobEventType enum value
	JobEventTypeDeprioritizedDueToInactivity = "DEPRIORITIZED_DUE_TO_INACTIVITY"

	// JobEventTypeUploadingResults is a JobEventType enum value
	JobEventTypeUploadingResults = "UPLOADING_RESULTS"

	// JobEventTypeCompleted is a JobEventType enum value
	JobEventTypeCompleted = "COMPLETED"

	// JobEventTypeFailed is a JobEventType enum value
	JobEventTypeFailed = "FAILED"

	// JobEventTypeMaxRuntimeExceeded is a JobEventType enum value
	JobEventTypeMaxRuntimeExceeded = "MAX_RUNTIME_EXCEEDED"

	// JobEventTypeCancelled is a JobEventType enum value
	JobEventTypeCancelled = "CANCELLED"
)
View Source 
const (
	// JobPrimaryStatusQueued is a JobPrimaryStatus enum value
	JobPrimaryStatusQueued = "QUEUED"

	// JobPrimaryStatusRunning is a JobPrimaryStatus enum value
	JobPrimaryStatusRunning = "RUNNING"

	// JobPrimaryStatusCompleted is a JobPrimaryStatus enum value
	JobPrimaryStatusCompleted = "COMPLETED"

	// JobPrimaryStatusFailed is a JobPrimaryStatus enum value
	JobPrimaryStatusFailed = "FAILED"

	// JobPrimaryStatusCancelling is a JobPrimaryStatus enum value
	JobPrimaryStatusCancelling = "CANCELLING"

	// JobPrimaryStatusCancelled is a JobPrimaryStatus enum value
	JobPrimaryStatusCancelled = "CANCELLED"
)
View Source 
const (
	// QuantumTaskStatusCreated is a QuantumTaskStatus enum value
	QuantumTaskStatusCreated = "CREATED"

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

	// QuantumTaskStatusRunning is a QuantumTaskStatus enum value
	QuantumTaskStatusRunning = "RUNNING"

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

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

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

	// QuantumTaskStatusCancelled is a QuantumTaskStatus enum value
	QuantumTaskStatusCancelled = "CANCELLED"
)
View Source 
const (
	// QueueNameQuantumTasksQueue is a QueueName enum value
	QueueNameQuantumTasksQueue = "QUANTUM_TASKS_QUEUE"

	// QueueNameJobsQueue is a QueueName enum value
	QueueNameJobsQueue = "JOBS_QUEUE"
)
View Source 
const (
	// QueuePriorityNormal is a QueuePriority enum value
	QueuePriorityNormal = "Normal"

	// QueuePriorityPriority is a QueuePriority enum value
	QueuePriorityPriority = "Priority"
)
View Source 
const (
	// SearchJobsFilterOperatorLt is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorLt = "LT"

	// SearchJobsFilterOperatorLte is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorLte = "LTE"

	// SearchJobsFilterOperatorEqual is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorEqual = "EQUAL"

	// SearchJobsFilterOperatorGt is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorGt = "GT"

	// SearchJobsFilterOperatorGte is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorGte = "GTE"

	// SearchJobsFilterOperatorBetween is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorBetween = "BETWEEN"

	// SearchJobsFilterOperatorContains is a SearchJobsFilterOperator enum value
	SearchJobsFilterOperatorContains = "CONTAINS"
)
View Source 
const (
	// SearchQuantumTasksFilterOperatorLt is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorLt = "LT"

	// SearchQuantumTasksFilterOperatorLte is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorLte = "LTE"

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

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

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

	// SearchQuantumTasksFilterOperatorBetween is a SearchQuantumTasksFilterOperator enum value
	SearchQuantumTasksFilterOperatorBetween = "BETWEEN"
)
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"

	// ErrCodeDeviceRetiredException for service response error code
	// "DeviceRetiredException".
	//
	// The specified device has been retired.
	ErrCodeDeviceRetiredException = "DeviceRetiredException"

	// 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 exceeded.
	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

View Source 
const (
	// AssociationTypeReservationTimeWindowArn is a AssociationType enum value
	AssociationTypeReservationTimeWindowArn = "RESERVATION_TIME_WINDOW_ARN"
)
View Source 
const (
	// HybridJobAdditionalAttributeNameQueueInfo is a HybridJobAdditionalAttributeName enum value
	HybridJobAdditionalAttributeNameQueueInfo = "QueueInfo"
)
View Source 
const (
	// QuantumTaskAdditionalAttributeNameQueueInfo is a QuantumTaskAdditionalAttributeName enum value
	QuantumTaskAdditionalAttributeNameQueueInfo = "QueueInfo"
)

Variables

This section is empty.

Functions

func AssociationType_Values added in v1.48.12 

func AssociationType_Values() []string

AssociationType_Values returns all elements of the AssociationType enum

func CancellationStatus_Values 

func CancellationStatus_Values() []string

CancellationStatus_Values returns all elements of the CancellationStatus enum

func CompressionType_Values added in v1.42.10 

func CompressionType_Values() []string

CompressionType_Values returns all elements of the CompressionType 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 HybridJobAdditionalAttributeName_Values added in v1.45.15 

func HybridJobAdditionalAttributeName_Values() []string

HybridJobAdditionalAttributeName_Values returns all elements of the HybridJobAdditionalAttributeName enum

func InstanceType_Values added in v1.42.10 

func InstanceType_Values() []string

InstanceType_Values returns all elements of the InstanceType enum

func JobEventType_Values added in v1.42.10 

func JobEventType_Values() []string

JobEventType_Values returns all elements of the JobEventType enum

func JobPrimaryStatus_Values added in v1.42.10 

func JobPrimaryStatus_Values() []string

JobPrimaryStatus_Values returns all elements of the JobPrimaryStatus enum

func QuantumTaskAdditionalAttributeName_Values added in v1.45.15 

func QuantumTaskAdditionalAttributeName_Values() []string

QuantumTaskAdditionalAttributeName_Values returns all elements of the QuantumTaskAdditionalAttributeName enum

func QuantumTaskStatus_Values 

func QuantumTaskStatus_Values() []string

QuantumTaskStatus_Values returns all elements of the QuantumTaskStatus enum

func QueueName_Values added in v1.45.15 

func QueueName_Values() []string

QueueName_Values returns all elements of the QueueName enum

func QueuePriority_Values added in v1.45.15 

func QueuePriority_Values() []string

QueuePriority_Values returns all elements of the QueuePriority enum

func SearchJobsFilterOperator_Values added in v1.42.10 

func SearchJobsFilterOperator_Values() []string

SearchJobsFilterOperator_Values returns all elements of the SearchJobsFilterOperator 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlgorithmSpecification added in v1.42.10 

type AlgorithmSpecification struct {

	// The container image used to create an Amazon Braket job.
	ContainerImage *ContainerImage `locationName:"containerImage" type:"structure"`

	// Configures the paths to the Python scripts used for entry and training.
	ScriptModeConfig *ScriptModeConfig `locationName:"scriptModeConfig" type:"structure"`
	// contains filtered or unexported fields
}

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.

func (AlgorithmSpecification) GoString added in v1.42.10 

func (s AlgorithmSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlgorithmSpecification) SetContainerImage added in v1.42.10 

func (s *AlgorithmSpecification) SetContainerImage(v *ContainerImage) *AlgorithmSpecification

SetContainerImage sets the ContainerImage field's value.

func (*AlgorithmSpecification) SetScriptModeConfig added in v1.42.10 

func (s *AlgorithmSpecification) SetScriptModeConfig(v *ScriptModeConfig) *AlgorithmSpecification

SetScriptModeConfig sets the ScriptModeConfig field's value.

func (AlgorithmSpecification) String added in v1.42.10 

func (s AlgorithmSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlgorithmSpecification) Validate added in v1.42.10 

func (s *AlgorithmSpecification) Validate() error

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

type Association added in v1.48.12 

type Association struct {

	// The Amazon Braket resource arn.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The association type for the specified Amazon Braket resource arn.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AssociationType"`
	// contains filtered or unexported fields
}

The Amazon Braket resource and the association type.

func (Association) GoString added in v1.48.12 

func (s Association) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Association) SetArn added in v1.48.12 

func (s *Association) SetArn(v string) *Association

SetArn sets the Arn field's value.

func (*Association) SetType added in v1.48.12 

func (s *Association) SetType(v string) *Association

SetType sets the Type field's value.

func (Association) String added in v1.48.12 

func (s Association) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Association) Validate added in v1.48.12 

func (s *Association) Validate() error

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

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) CancelJob added in v1.42.10 

func (c *Braket) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)

CancelJob API operation for Braket.

Cancels an Amazon Braket job.

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 CancelJob 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/CancelJob

func (*Braket) CancelJobRequest added in v1.42.10 

func (c *Braket) CancelJobRequest(input *CancelJobInput) (req *request.Request, output *CancelJobOutput)

CancelJobRequest generates a "aws/request.Request" representing the client's request for the CancelJob 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 CancelJob for more information on using the CancelJob 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 CancelJobRequest method.
req, resp := client.CancelJobRequest(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/CancelJob

func (*Braket) CancelJobWithContext added in v1.42.10 

func (c *Braket) CancelJobWithContext(ctx aws.Context, input *CancelJobInput, opts ...request.Option) (*CancelJobOutput, error)

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

See CancelJob 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) 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) CreateJob added in v1.42.10 

func (c *Braket) CreateJob(input *CreateJobInput) (*CreateJobOutput, error)

CreateJob API operation for Braket.

Creates an Amazon Braket job.

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 CreateJob for usage and error information.

Returned Error Types:

  • ConflictException An error occurred due to a conflict.

  • 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.

  • DeviceRetiredException The specified device has been retired.

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

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

  • 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/CreateJob

func (*Braket) CreateJobRequest added in v1.42.10 

func (c *Braket) CreateJobRequest(input *CreateJobInput) (req *request.Request, output *CreateJobOutput)

CreateJobRequest generates a "aws/request.Request" representing the client's request for the CreateJob 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 CreateJob for more information on using the CreateJob 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 CreateJobRequest method.
req, resp := client.CreateJobRequest(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/CreateJob

func (*Braket) CreateJobWithContext added in v1.42.10 

func (c *Braket) CreateJobWithContext(ctx aws.Context, input *CreateJobInput, opts ...request.Option) (*CreateJobOutput, error)

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

See CreateJob 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.

  • DeviceRetiredException The specified device has been retired.

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

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

  • 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.

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.

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) GetJob added in v1.42.10 

func (c *Braket) GetJob(input *GetJobInput) (*GetJobOutput, error)

GetJob API operation for Braket.

Retrieves the specified Amazon Braket job.

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 GetJob 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/GetJob

func (*Braket) GetJobRequest added in v1.42.10 

func (c *Braket) GetJobRequest(input *GetJobInput) (req *request.Request, output *GetJobOutput)

GetJobRequest generates a "aws/request.Request" representing the client's request for the GetJob 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 GetJob for more information on using the GetJob 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 GetJobRequest method.
req, resp := client.GetJobRequest(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/GetJob

func (*Braket) GetJobWithContext added in v1.42.10 

func (c *Braket) GetJobWithContext(ctx aws.Context, input *GetJobInput, opts ...request.Option) (*GetJobOutput, error)

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

See GetJob 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) ListTagsForResource added in v1.35.19 

func (c *Braket) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Braket.

Shows the tags associated with this resource.

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • 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/ListTagsForResource

func (*Braket) ListTagsForResourceRequest added in v1.35.19 

func (c *Braket) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*Braket) ListTagsForResourceWithContext added in v1.35.19 

func (c *Braket) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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) SearchJobs added in v1.42.10 

func (c *Braket) SearchJobs(input *SearchJobsInput) (*SearchJobsOutput, error)

SearchJobs API operation for Braket.

Searches for Amazon Braket jobs 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 SearchJobs 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/SearchJobs

func (*Braket) SearchJobsPages added in v1.42.10 

func (c *Braket) SearchJobsPages(input *SearchJobsInput, fn func(*SearchJobsOutput, bool) bool) error

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

See SearchJobs 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 SearchJobs operation.
pageNum := 0
err := client.SearchJobsPages(params,
    func(page *braket.SearchJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Braket) SearchJobsPagesWithContext added in v1.42.10 

func (c *Braket) SearchJobsPagesWithContext(ctx aws.Context, input *SearchJobsInput, fn func(*SearchJobsOutput, bool) bool, opts ...request.Option) error

SearchJobsPagesWithContext same as SearchJobsPages 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) SearchJobsRequest added in v1.42.10 

func (c *Braket) SearchJobsRequest(input *SearchJobsInput) (req *request.Request, output *SearchJobsOutput)

SearchJobsRequest generates a "aws/request.Request" representing the client's request for the SearchJobs 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 SearchJobs for more information on using the SearchJobs 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 SearchJobsRequest method.
req, resp := client.SearchJobsRequest(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/SearchJobs

func (*Braket) SearchJobsWithContext added in v1.42.10 

func (c *Braket) SearchJobsWithContext(ctx aws.Context, input *SearchJobsInput, opts ...request.Option) (*SearchJobsOutput, error)

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

See SearchJobs 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.

func (*Braket) TagResource added in v1.35.19 

func (c *Braket) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Braket.

Add a tag to the specified resource.

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 TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • 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/TagResource

func (*Braket) TagResourceRequest added in v1.35.19 

func (c *Braket) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*Braket) TagResourceWithContext added in v1.35.19 

func (c *Braket) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.35.19 

func (c *Braket) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Braket.

Remove tags from a resource.

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 UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • 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/UntagResource

func (*Braket) UntagResourceRequest added in v1.35.19 

func (c *Braket) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*Braket) UntagResourceWithContext added in v1.35.19 

func (c *Braket) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 CancelJobInput added in v1.42.10 

type CancelJobInput struct {

	// The ARN of the Amazon Braket job to cancel.
	//
	// JobArn is a required field
	JobArn *string `location:"uri" locationName:"jobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelJobInput) GoString added in v1.42.10 

func (s CancelJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelJobInput) SetJobArn added in v1.42.10 

func (s *CancelJobInput) SetJobArn(v string) *CancelJobInput

SetJobArn sets the JobArn field's value.

func (CancelJobInput) String added in v1.42.10 

func (s CancelJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelJobInput) Validate added in v1.42.10 

func (s *CancelJobInput) Validate() error

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

type CancelJobOutput added in v1.42.10 

type CancelJobOutput struct {

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

	// The ARN of the Amazon Braket job.
	//
	// JobArn is a required field
	JobArn *string `locationName:"jobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelJobOutput) GoString added in v1.42.10 

func (s CancelJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelJobOutput) SetCancellationStatus added in v1.42.10 

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

SetCancellationStatus sets the CancellationStatus field's value.

func (*CancelJobOutput) SetJobArn added in v1.42.10 

func (s *CancelJobOutput) SetJobArn(v string) *CancelJobOutput

SetJobArn sets the JobArn field's value.

func (CancelJobOutput) String added in v1.42.10 

func (s CancelJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQuantumTaskInput) GoString 

func (s CancelQuantumTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQuantumTaskOutput) GoString 

func (s CancelQuantumTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerImage added in v1.42.10 

type ContainerImage struct {

	// The URI locating the container image.
	//
	// Uri is a required field
	Uri *string `locationName:"uri" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The container image used to create an Amazon Braket job.

func (ContainerImage) GoString added in v1.42.10 

func (s ContainerImage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerImage) SetUri added in v1.42.10 

func (s *ContainerImage) SetUri(v string) *ContainerImage

SetUri sets the Uri field's value.

func (ContainerImage) String added in v1.42.10 

func (s ContainerImage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerImage) Validate added in v1.42.10 

func (s *ContainerImage) Validate() error

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

type CreateJobInput added in v1.42.10 

type CreateJobInput struct {

	// Definition of the Amazon Braket job to be created. Specifies the container
	// image the job uses and information about the Python scripts used for entry
	// and training.
	//
	// AlgorithmSpecification is a required field
	AlgorithmSpecification *AlgorithmSpecification `locationName:"algorithmSpecification" type:"structure" required:"true"`

	// The list of Amazon Braket resources associated with the hybrid job.
	Associations []*Association `locationName:"associations" type:"list"`

	// Information about the output locations for job checkpoint data.
	CheckpointConfig *JobCheckpointConfig `locationName:"checkpointConfig" type:"structure"`

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The quantum processing unit (QPU) or simulator used to create an Amazon Braket
	// job.
	//
	// DeviceConfig is a required field
	DeviceConfig *DeviceConfig `locationName:"deviceConfig" type:"structure" required:"true"`

	// Algorithm-specific parameters used by an Amazon Braket job that influence
	// the quality of the training job. The values are set with a string of JSON
	// key:value pairs, where the key is the name of the hyperparameter and the
	// value is the value of th hyperparameter.
	HyperParameters map[string]*string `locationName:"hyperParameters" type:"map"`

	// A list of parameters that specify the name and type of input data and where
	// it is located.
	InputDataConfig []*InputFileConfig `locationName:"inputDataConfig" type:"list"`

	// Configuration of the resource instances to use while running the hybrid job
	// on Amazon Braket.
	//
	// InstanceConfig is a required field
	InstanceConfig *InstanceConfig `locationName:"instanceConfig" type:"structure" required:"true"`

	// The name of the Amazon Braket job.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The path to the S3 location where you want to store job artifacts and the
	// encryption key used to store them.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *JobOutputDataConfig `locationName:"outputDataConfig" type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume
	// to perform tasks on behalf of a user. It can access user resources, run an
	// Amazon Braket job container on behalf of user, and output resources to the
	// users' s3 buckets.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The user-defined criteria that specifies when a job stops running.
	StoppingCondition *JobStoppingCondition `locationName:"stoppingCondition" type:"structure"`

	// A tag object that consists of a key and an optional value, used to manage
	// metadata for Amazon Braket resources.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateJobInput) GoString added in v1.42.10 

func (s CreateJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobInput) SetAlgorithmSpecification added in v1.42.10 

func (s *CreateJobInput) SetAlgorithmSpecification(v *AlgorithmSpecification) *CreateJobInput

SetAlgorithmSpecification sets the AlgorithmSpecification field's value.

func (*CreateJobInput) SetAssociations added in v1.48.12 

func (s *CreateJobInput) SetAssociations(v []*Association) *CreateJobInput

SetAssociations sets the Associations field's value.

func (*CreateJobInput) SetCheckpointConfig added in v1.42.10 

func (s *CreateJobInput) SetCheckpointConfig(v *JobCheckpointConfig) *CreateJobInput

SetCheckpointConfig sets the CheckpointConfig field's value.

func (*CreateJobInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*CreateJobInput) SetDeviceConfig added in v1.42.10 

func (s *CreateJobInput) SetDeviceConfig(v *DeviceConfig) *CreateJobInput

SetDeviceConfig sets the DeviceConfig field's value.

func (*CreateJobInput) SetHyperParameters added in v1.42.10 

func (s *CreateJobInput) SetHyperParameters(v map[string]*string) *CreateJobInput

SetHyperParameters sets the HyperParameters field's value.

func (*CreateJobInput) SetInputDataConfig added in v1.42.10 

func (s *CreateJobInput) SetInputDataConfig(v []*InputFileConfig) *CreateJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateJobInput) SetInstanceConfig added in v1.42.10 

func (s *CreateJobInput) SetInstanceConfig(v *InstanceConfig) *CreateJobInput

SetInstanceConfig sets the InstanceConfig field's value.

func (*CreateJobInput) SetJobName added in v1.42.10 

func (s *CreateJobInput) SetJobName(v string) *CreateJobInput

SetJobName sets the JobName field's value.

func (*CreateJobInput) SetOutputDataConfig added in v1.42.10 

func (s *CreateJobInput) SetOutputDataConfig(v *JobOutputDataConfig) *CreateJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*CreateJobInput) SetRoleArn added in v1.42.10 

func (s *CreateJobInput) SetRoleArn(v string) *CreateJobInput

SetRoleArn sets the RoleArn field's value.

func (*CreateJobInput) SetStoppingCondition added in v1.42.10 

func (s *CreateJobInput) SetStoppingCondition(v *JobStoppingCondition) *CreateJobInput

SetStoppingCondition sets the StoppingCondition field's value.

func (*CreateJobInput) SetTags added in v1.42.10 

func (s *CreateJobInput) SetTags(v map[string]*string) *CreateJobInput

SetTags sets the Tags field's value.

func (CreateJobInput) String added in v1.42.10 

func (s CreateJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobInput) Validate added in v1.42.10 

func (s *CreateJobInput) Validate() error

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

type CreateJobOutput added in v1.42.10 

type CreateJobOutput struct {

	// The ARN of the Amazon Braket job created.
	//
	// JobArn is a required field
	JobArn *string `locationName:"jobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJobOutput) GoString added in v1.42.10 

func (s CreateJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobOutput) SetJobArn added in v1.42.10 

func (s *CreateJobOutput) SetJobArn(v string) *CreateJobOutput

SetJobArn sets the JobArn field's value.

func (CreateJobOutput) String added in v1.42.10 

func (s CreateJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 list of Amazon Braket resources associated with the quantum task.
	Associations []*Association `locationName:"associations" type:"list"`

	// 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 token for an Amazon Braket job that associates it with the quantum task.
	JobToken *string `locationName:"jobToken" min:"1" type:"string"`

	// 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"`

	// Tags to be added to the quantum task you're creating.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateQuantumTaskInput) GoString 

func (s CreateQuantumTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuantumTaskInput) SetAction 

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

SetAction sets the Action field's value.

func (*CreateQuantumTaskInput) SetAssociations added in v1.48.12 

func (s *CreateQuantumTaskInput) SetAssociations(v []*Association) *CreateQuantumTaskInput

SetAssociations sets the Associations 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) SetJobToken added in v1.42.10 

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

SetJobToken sets the JobToken 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) SetTags added in v1.35.19 

func (s *CreateQuantumTaskInput) SetTags(v map[string]*string) *CreateQuantumTaskInput

SetTags sets the Tags field's value.

func (CreateQuantumTaskInput) String 

func (s CreateQuantumTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQuantumTaskOutput) GoString 

func (s CreateQuantumTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSource added in v1.42.10 

type DataSource struct {

	// Information about the data stored in Amazon S3 used by the Amazon Braket
	// job.
	//
	// S3DataSource is a required field
	S3DataSource *S3DataSource `locationName:"s3DataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (DataSource) GoString added in v1.42.10 

func (s DataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSource) SetS3DataSource added in v1.42.10 

func (s *DataSource) SetS3DataSource(v *S3DataSource) *DataSource

SetS3DataSource sets the S3DataSource field's value.

func (DataSource) String added in v1.42.10 

func (s DataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSource) Validate added in v1.42.10 

func (s *DataSource) Validate() error

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

type DeviceConfig added in v1.42.10 

type DeviceConfig struct {

	// The primary quantum processing unit (QPU) or simulator used to create and
	// run an Amazon Braket job.
	//
	// Device is a required field
	Device *string `locationName:"device" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DeviceConfig) GoString added in v1.42.10 

func (s DeviceConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceConfig) SetDevice added in v1.42.10 

func (s *DeviceConfig) SetDevice(v string) *DeviceConfig

SetDevice sets the Device field's value.

func (DeviceConfig) String added in v1.42.10 

func (s DeviceConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceConfig) Validate added in v1.42.10 

func (s *DeviceConfig) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeviceQueueInfo added in v1.45.15 

type DeviceQueueInfo struct {

	// The name of the queue.
	//
	// Queue is a required field
	Queue *string `locationName:"queue" type:"string" required:"true" enum:"QueueName"`

	// Optional. Specifies the priority of the queue. Tasks in a priority queue
	// are processed before the tasks in a normal queue.
	QueuePriority *string `locationName:"queuePriority" type:"string" enum:"QueuePriority"`

	// The number of jobs or tasks in the queue for a given device.
	//
	// QueueSize is a required field
	QueueSize *string `locationName:"queueSize" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about tasks and jobs queued on a device.

func (DeviceQueueInfo) GoString added in v1.45.15 

func (s DeviceQueueInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceQueueInfo) SetQueue added in v1.45.15 

func (s *DeviceQueueInfo) SetQueue(v string) *DeviceQueueInfo

SetQueue sets the Queue field's value.

func (*DeviceQueueInfo) SetQueuePriority added in v1.45.15 

func (s *DeviceQueueInfo) SetQueuePriority(v string) *DeviceQueueInfo

SetQueuePriority sets the QueuePriority field's value.

func (*DeviceQueueInfo) SetQueueSize added in v1.45.15 

func (s *DeviceQueueInfo) SetQueueSize(v string) *DeviceQueueInfo

SetQueueSize sets the QueueSize field's value.

func (DeviceQueueInfo) String added in v1.45.15 

func (s DeviceQueueInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeviceRetiredException added in v1.38.53 

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

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

The specified device has been retired.

func (*DeviceRetiredException) Code added in v1.38.53 

func (s *DeviceRetiredException) Code() string

Code returns the exception type name.

func (*DeviceRetiredException) Error added in v1.38.53 

func (s *DeviceRetiredException) Error() string

func (DeviceRetiredException) GoString added in v1.38.53 

func (s DeviceRetiredException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceRetiredException) Message added in v1.38.53 

func (s *DeviceRetiredException) Message() string

Message returns the exception's message.

func (*DeviceRetiredException) OrigErr added in v1.38.53 

func (s *DeviceRetiredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeviceRetiredException) RequestID added in v1.38.53 

func (s *DeviceRetiredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeviceRetiredException) StatusCode added in v1.38.53 

func (s *DeviceRetiredException) StatusCode() int

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

func (DeviceRetiredException) String added in v1.38.53 

func (s DeviceRetiredException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// List of information about tasks and jobs queued on a device.
	DeviceQueueInfo []*DeviceQueueInfo `locationName:"deviceQueueInfo" type:"list"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetDeviceQueueInfo added in v1.45.15 

func (s *GetDeviceOutput) SetDeviceQueueInfo(v []*DeviceQueueInfo) *GetDeviceOutput

SetDeviceQueueInfo sets the DeviceQueueInfo 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJobInput added in v1.42.10 

type GetJobInput struct {

	// A list of attributes to return information for.
	AdditionalAttributeNames []*string `location:"querystring" locationName:"additionalAttributeNames" type:"list" enum:"HybridJobAdditionalAttributeName"`

	// The ARN of the job to retrieve.
	//
	// JobArn is a required field
	JobArn *string `location:"uri" locationName:"jobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetJobInput) GoString added in v1.42.10 

func (s GetJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobInput) SetAdditionalAttributeNames added in v1.45.15 

func (s *GetJobInput) SetAdditionalAttributeNames(v []*string) *GetJobInput

SetAdditionalAttributeNames sets the AdditionalAttributeNames field's value.

func (*GetJobInput) SetJobArn added in v1.42.10 

func (s *GetJobInput) SetJobArn(v string) *GetJobInput

SetJobArn sets the JobArn field's value.

func (GetJobInput) String added in v1.42.10 

func (s GetJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobInput) Validate added in v1.42.10 

func (s *GetJobInput) Validate() error

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

type GetJobOutput added in v1.42.10 

type GetJobOutput struct {

	// Definition of the Amazon Braket job created. Specifies the container image
	// the job uses, information about the Python scripts used for entry and training,
	// and the user-defined metrics used to evaluation the job.
	//
	// AlgorithmSpecification is a required field
	AlgorithmSpecification *AlgorithmSpecification `locationName:"algorithmSpecification" type:"structure" required:"true"`

	// The list of Amazon Braket resources associated with the hybrid job.
	Associations []*Association `locationName:"associations" type:"list"`

	// The billable time the Amazon Braket job used to complete.
	BillableDuration *int64 `locationName:"billableDuration" type:"integer"`

	// Information about the output locations for job checkpoint data.
	CheckpointConfig *JobCheckpointConfig `locationName:"checkpointConfig" type:"structure"`

	// The date and time that the Amazon Braket job was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The quantum processing unit (QPU) or simulator used to run the Amazon Braket
	// job.
	DeviceConfig *DeviceConfig `locationName:"deviceConfig" type:"structure"`

	// The date and time that the Amazon Braket job ended.
	EndedAt *time.Time `locationName:"endedAt" type:"timestamp" timestampFormat:"iso8601"`

	// Details about the type and time events occurred related to the Amazon Braket
	// job.
	Events []*JobEventDetails `locationName:"events" type:"list"`

	// A description of the reason why an Amazon Braket job failed, if it failed.
	FailureReason *string `locationName:"failureReason" min:"1" type:"string"`

	// Algorithm-specific parameters used by an Amazon Braket job that influence
	// the quality of the traiing job. The values are set with a string of JSON
	// key:value pairs, where the key is the name of the hyperparameter and the
	// value is the value of th hyperparameter.
	HyperParameters map[string]*string `locationName:"hyperParameters" type:"map"`

	// A list of parameters that specify the name and type of input data and where
	// it is located.
	InputDataConfig []*InputFileConfig `locationName:"inputDataConfig" type:"list"`

	// The resource instances to use while running the hybrid job on Amazon Braket.
	//
	// InstanceConfig is a required field
	InstanceConfig *InstanceConfig `locationName:"instanceConfig" type:"structure" required:"true"`

	// The ARN of the Amazon Braket job.
	//
	// JobArn is a required field
	JobArn *string `locationName:"jobArn" type:"string" required:"true"`

	// The name of the Amazon Braket job.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The path to the S3 location where job artifacts are stored and the encryption
	// key used to store them there.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *JobOutputDataConfig `locationName:"outputDataConfig" type:"structure" required:"true"`

	// Queue information for the requested job. Only returned if QueueInfo is specified
	// in the additionalAttributeNames" field in the GetJob API request.
	QueueInfo *HybridJobQueueInfo `locationName:"queueInfo" type:"structure"`

	// The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume
	// to perform tasks on behalf of a user. It can access user resources, run an
	// Amazon Braket job container on behalf of user, and output resources to the
	// s3 buckets of a user.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The date and time that the Amazon Braket job was started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The status of the Amazon Braket job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobPrimaryStatus"`

	// The user-defined criteria that specifies when to stop a job running.
	StoppingCondition *JobStoppingCondition `locationName:"stoppingCondition" type:"structure"`

	// A tag object that consists of a key and an optional value, used to manage
	// metadata for Amazon Braket resources.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (GetJobOutput) GoString added in v1.42.10 

func (s GetJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobOutput) SetAlgorithmSpecification added in v1.42.10 

func (s *GetJobOutput) SetAlgorithmSpecification(v *AlgorithmSpecification) *GetJobOutput

SetAlgorithmSpecification sets the AlgorithmSpecification field's value.

func (*GetJobOutput) SetAssociations added in v1.48.12 

func (s *GetJobOutput) SetAssociations(v []*Association) *GetJobOutput

SetAssociations sets the Associations field's value.

func (*GetJobOutput) SetBillableDuration added in v1.42.10 

func (s *GetJobOutput) SetBillableDuration(v int64) *GetJobOutput

SetBillableDuration sets the BillableDuration field's value.

func (*GetJobOutput) SetCheckpointConfig added in v1.42.10 

func (s *GetJobOutput) SetCheckpointConfig(v *JobCheckpointConfig) *GetJobOutput

SetCheckpointConfig sets the CheckpointConfig field's value.

func (*GetJobOutput) SetCreatedAt added in v1.42.10 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetJobOutput) SetDeviceConfig added in v1.42.10 

func (s *GetJobOutput) SetDeviceConfig(v *DeviceConfig) *GetJobOutput

SetDeviceConfig sets the DeviceConfig field's value.

func (*GetJobOutput) SetEndedAt added in v1.42.10 

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

SetEndedAt sets the EndedAt field's value.

func (*GetJobOutput) SetEvents added in v1.42.10 

func (s *GetJobOutput) SetEvents(v []*JobEventDetails) *GetJobOutput

SetEvents sets the Events field's value.

func (*GetJobOutput) SetFailureReason added in v1.42.10 

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

SetFailureReason sets the FailureReason field's value.

func (*GetJobOutput) SetHyperParameters added in v1.42.10 

func (s *GetJobOutput) SetHyperParameters(v map[string]*string) *GetJobOutput

SetHyperParameters sets the HyperParameters field's value.

func (*GetJobOutput) SetInputDataConfig added in v1.42.10 

func (s *GetJobOutput) SetInputDataConfig(v []*InputFileConfig) *GetJobOutput

SetInputDataConfig sets the InputDataConfig field's value.

func (*GetJobOutput) SetInstanceConfig added in v1.42.10 

func (s *GetJobOutput) SetInstanceConfig(v *InstanceConfig) *GetJobOutput

SetInstanceConfig sets the InstanceConfig field's value.

func (*GetJobOutput) SetJobArn added in v1.42.10 

func (s *GetJobOutput) SetJobArn(v string) *GetJobOutput

SetJobArn sets the JobArn field's value.

func (*GetJobOutput) SetJobName added in v1.42.10 

func (s *GetJobOutput) SetJobName(v string) *GetJobOutput

SetJobName sets the JobName field's value.

func (*GetJobOutput) SetOutputDataConfig added in v1.42.10 

func (s *GetJobOutput) SetOutputDataConfig(v *JobOutputDataConfig) *GetJobOutput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*GetJobOutput) SetQueueInfo added in v1.45.15 

func (s *GetJobOutput) SetQueueInfo(v *HybridJobQueueInfo) *GetJobOutput

SetQueueInfo sets the QueueInfo field's value.

func (*GetJobOutput) SetRoleArn added in v1.42.10 

func (s *GetJobOutput) SetRoleArn(v string) *GetJobOutput

SetRoleArn sets the RoleArn field's value.

func (*GetJobOutput) SetStartedAt added in v1.42.10 

func (s *GetJobOutput) SetStartedAt(v time.Time) *GetJobOutput

SetStartedAt sets the StartedAt field's value.

func (*GetJobOutput) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (*GetJobOutput) SetStoppingCondition added in v1.42.10 

func (s *GetJobOutput) SetStoppingCondition(v *JobStoppingCondition) *GetJobOutput

SetStoppingCondition sets the StoppingCondition field's value.

func (*GetJobOutput) SetTags added in v1.42.10 

func (s *GetJobOutput) SetTags(v map[string]*string) *GetJobOutput

SetTags sets the Tags field's value.

func (GetJobOutput) String added in v1.42.10 

func (s GetJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQuantumTaskInput 

type GetQuantumTaskInput struct {

	// A list of attributes to return information for.
	AdditionalAttributeNames []*string `location:"querystring" locationName:"additionalAttributeNames" type:"list" enum:"QuantumTaskAdditionalAttributeName"`

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

func (GetQuantumTaskInput) GoString 

func (s GetQuantumTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuantumTaskInput) SetAdditionalAttributeNames added in v1.45.15 

func (s *GetQuantumTaskInput) SetAdditionalAttributeNames(v []*string) *GetQuantumTaskInput

SetAdditionalAttributeNames sets the AdditionalAttributeNames field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 list of Amazon Braket resources associated with the quantum task.
	Associations []*Association `locationName:"associations" type:"list"`

	// 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 ARN of the Amazon Braket job associated with the quantum task.
	JobArn *string `locationName:"jobArn" 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" type:"string" required:"true"`

	// Queue information for the requested quantum task. Only returned if QueueInfo
	// is specified in the additionalAttributeNames" field in the GetQuantumTask
	// API request.
	QueueInfo *QuantumTaskQueueInfo `locationName:"queueInfo" type:"structure"`

	// 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"`

	// The tags that belong to this task.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (GetQuantumTaskOutput) GoString 

func (s GetQuantumTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuantumTaskOutput) SetAssociations added in v1.48.12 

func (s *GetQuantumTaskOutput) SetAssociations(v []*Association) *GetQuantumTaskOutput

SetAssociations sets the Associations field's value.

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) SetJobArn added in v1.42.10 

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

SetJobArn sets the JobArn 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) SetQueueInfo added in v1.45.15 

func (s *GetQuantumTaskOutput) SetQueueInfo(v *QuantumTaskQueueInfo) *GetQuantumTaskOutput

SetQueueInfo sets the QueueInfo 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) SetTags added in v1.35.19 

func (s *GetQuantumTaskOutput) SetTags(v map[string]*string) *GetQuantumTaskOutput

SetTags sets the Tags field's value.

func (GetQuantumTaskOutput) String 

func (s GetQuantumTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HybridJobQueueInfo added in v1.45.15 

type HybridJobQueueInfo struct {

	// Optional. Provides more information about the queue position. For example,
	// if the job is complete and no longer in the queue, the message field contains
	// that information.
	Message *string `locationName:"message" type:"string"`

	// Current position of the job in the jobs queue.
	//
	// Position is a required field
	Position *string `locationName:"position" type:"string" required:"true"`

	// The name of the queue.
	//
	// Queue is a required field
	Queue *string `locationName:"queue" type:"string" required:"true" enum:"QueueName"`
	// contains filtered or unexported fields
}

Information about the queue for a specified job.

func (HybridJobQueueInfo) GoString added in v1.45.15 

func (s HybridJobQueueInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HybridJobQueueInfo) SetMessage added in v1.45.15 

func (s *HybridJobQueueInfo) SetMessage(v string) *HybridJobQueueInfo

SetMessage sets the Message field's value.

func (*HybridJobQueueInfo) SetPosition added in v1.45.15 

func (s *HybridJobQueueInfo) SetPosition(v string) *HybridJobQueueInfo

SetPosition sets the Position field's value.

func (*HybridJobQueueInfo) SetQueue added in v1.45.15 

func (s *HybridJobQueueInfo) SetQueue(v string) *HybridJobQueueInfo

SetQueue sets the Queue field's value.

func (HybridJobQueueInfo) String added in v1.45.15 

func (s HybridJobQueueInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputFileConfig added in v1.42.10 

type InputFileConfig struct {

	// A named input source that an Amazon Braket job can consume.
	//
	// ChannelName is a required field
	ChannelName *string `locationName:"channelName" min:"1" type:"string" required:"true"`

	// The MIME type of the data.
	ContentType *string `locationName:"contentType" min:"1" type:"string"`

	// The location of the channel data.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (InputFileConfig) GoString added in v1.42.10 

func (s InputFileConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileConfig) SetChannelName added in v1.42.10 

func (s *InputFileConfig) SetChannelName(v string) *InputFileConfig

SetChannelName sets the ChannelName field's value.

func (*InputFileConfig) SetContentType added in v1.42.10 

func (s *InputFileConfig) SetContentType(v string) *InputFileConfig

SetContentType sets the ContentType field's value.

func (*InputFileConfig) SetDataSource added in v1.42.10 

func (s *InputFileConfig) SetDataSource(v *DataSource) *InputFileConfig

SetDataSource sets the DataSource field's value.

func (InputFileConfig) String added in v1.42.10 

func (s InputFileConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileConfig) Validate added in v1.42.10 

func (s *InputFileConfig) Validate() error

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

type InstanceConfig added in v1.42.10 

type InstanceConfig struct {

	// Configures the number of resource instances to use while running an Amazon
	// Braket job on Amazon Braket. The default value is 1.
	InstanceCount *int64 `locationName:"instanceCount" min:"1" type:"integer"`

	// Configures the type resource instances to use while running an Amazon Braket
	// hybrid job.
	//
	// InstanceType is a required field
	InstanceType *string `locationName:"instanceType" type:"string" required:"true" enum:"InstanceType"`

	// The size of the storage volume, in GB, that user wants to provision.
	//
	// VolumeSizeInGb is a required field
	VolumeSizeInGb *int64 `locationName:"volumeSizeInGb" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

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

func (InstanceConfig) GoString added in v1.42.10 

func (s InstanceConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceConfig) SetInstanceCount added in v1.44.3 

func (s *InstanceConfig) SetInstanceCount(v int64) *InstanceConfig

SetInstanceCount sets the InstanceCount field's value.

func (*InstanceConfig) SetInstanceType added in v1.42.10 

func (s *InstanceConfig) SetInstanceType(v string) *InstanceConfig

SetInstanceType sets the InstanceType field's value.

func (*InstanceConfig) SetVolumeSizeInGb added in v1.42.10 

func (s *InstanceConfig) SetVolumeSizeInGb(v int64) *InstanceConfig

SetVolumeSizeInGb sets the VolumeSizeInGb field's value.

func (InstanceConfig) String added in v1.42.10 

func (s InstanceConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceConfig) Validate added in v1.42.10 

func (s *InstanceConfig) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobCheckpointConfig added in v1.42.10 

type JobCheckpointConfig struct {

	// (Optional) The local directory where checkpoints are written. The default
	// directory is /opt/braket/checkpoints/.
	LocalPath *string `locationName:"localPath" min:"1" type:"string"`

	// Identifies the S3 path where you want Amazon Braket to store checkpoints.
	// For example, s3://bucket-name/key-name-prefix.
	//
	// S3Uri is a required field
	S3Uri *string `locationName:"s3Uri" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about the output locations for job checkpoint data.

func (JobCheckpointConfig) GoString added in v1.42.10 

func (s JobCheckpointConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobCheckpointConfig) SetLocalPath added in v1.42.10 

func (s *JobCheckpointConfig) SetLocalPath(v string) *JobCheckpointConfig

SetLocalPath sets the LocalPath field's value.

func (*JobCheckpointConfig) SetS3Uri added in v1.42.10 

func (s *JobCheckpointConfig) SetS3Uri(v string) *JobCheckpointConfig

SetS3Uri sets the S3Uri field's value.

func (JobCheckpointConfig) String added in v1.42.10 

func (s JobCheckpointConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobCheckpointConfig) Validate added in v1.42.10 

func (s *JobCheckpointConfig) Validate() error

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

type JobEventDetails added in v1.42.10 

type JobEventDetails struct {

	// The type of event that occurred related to the Amazon Braket job.
	EventType *string `locationName:"eventType" type:"string" enum:"JobEventType"`

	// A message describing the event that occurred related to the Amazon Braket
	// job.
	Message *string `locationName:"message" type:"string"`

	// The type of event that occurred related to the Amazon Braket job.
	TimeOfEvent *time.Time `locationName:"timeOfEvent" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

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

func (JobEventDetails) GoString added in v1.42.10 

func (s JobEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobEventDetails) SetEventType added in v1.42.10 

func (s *JobEventDetails) SetEventType(v string) *JobEventDetails

SetEventType sets the EventType field's value.

func (*JobEventDetails) SetMessage added in v1.42.10 

func (s *JobEventDetails) SetMessage(v string) *JobEventDetails

SetMessage sets the Message field's value.

func (*JobEventDetails) SetTimeOfEvent added in v1.42.10 

func (s *JobEventDetails) SetTimeOfEvent(v time.Time) *JobEventDetails

SetTimeOfEvent sets the TimeOfEvent field's value.

func (JobEventDetails) String added in v1.42.10 

func (s JobEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobOutputDataConfig added in v1.42.10 

type JobOutputDataConfig struct {

	// The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt
	// the job training artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// Identifies the S3 path where you want Amazon Braket to store the job training
	// artifacts. For example, s3://bucket-name/key-name-prefix.
	//
	// S3Path is a required field
	S3Path *string `locationName:"s3Path" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (JobOutputDataConfig) GoString added in v1.42.10 

func (s JobOutputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobOutputDataConfig) SetKmsKeyId added in v1.42.10 

func (s *JobOutputDataConfig) SetKmsKeyId(v string) *JobOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*JobOutputDataConfig) SetS3Path added in v1.42.10 

func (s *JobOutputDataConfig) SetS3Path(v string) *JobOutputDataConfig

SetS3Path sets the S3Path field's value.

func (JobOutputDataConfig) String added in v1.42.10 

func (s JobOutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobOutputDataConfig) Validate added in v1.42.10 

func (s *JobOutputDataConfig) Validate() error

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

type JobStoppingCondition added in v1.42.10 

type JobStoppingCondition struct {

	// The maximum length of time, in seconds, that an Amazon Braket job can run.
	MaxRuntimeInSeconds *int64 `locationName:"maxRuntimeInSeconds" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

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

func (JobStoppingCondition) GoString added in v1.42.10 

func (s JobStoppingCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobStoppingCondition) SetMaxRuntimeInSeconds added in v1.42.10 

func (s *JobStoppingCondition) SetMaxRuntimeInSeconds(v int64) *JobStoppingCondition

SetMaxRuntimeInSeconds sets the MaxRuntimeInSeconds field's value.

func (JobStoppingCondition) String added in v1.42.10 

func (s JobStoppingCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobStoppingCondition) Validate added in v1.42.10 

func (s *JobStoppingCondition) Validate() error

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

type JobSummary added in v1.42.10 

type JobSummary struct {

	// The date and time that the Amazon Braket job was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Provides summary information about the primary device used by an Amazon Braket
	// job.
	//
	// Device is a required field
	Device *string `locationName:"device" min:"1" type:"string" required:"true"`

	// The date and time that the Amazon Braket job ended.
	EndedAt *time.Time `locationName:"endedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The ARN of the Amazon Braket job.
	//
	// JobArn is a required field
	JobArn *string `locationName:"jobArn" type:"string" required:"true"`

	// The name of the Amazon Braket job.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" type:"string" required:"true"`

	// The date and time that the Amazon Braket job was started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The status of the Amazon Braket job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobPrimaryStatus"`

	// A tag object that consists of a key and an optional value, used to manage
	// metadata for Amazon Braket resources.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Provides summary information about an Amazon Braket job.

func (JobSummary) GoString added in v1.42.10 

func (s JobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobSummary) SetCreatedAt added in v1.42.10 

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

SetCreatedAt sets the CreatedAt field's value.

func (*JobSummary) SetDevice added in v1.42.10 

func (s *JobSummary) SetDevice(v string) *JobSummary

SetDevice sets the Device field's value.

func (*JobSummary) SetEndedAt added in v1.42.10 

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

SetEndedAt sets the EndedAt field's value.

func (*JobSummary) SetJobArn added in v1.42.10 

func (s *JobSummary) SetJobArn(v string) *JobSummary

SetJobArn sets the JobArn field's value.

func (*JobSummary) SetJobName added in v1.42.10 

func (s *JobSummary) SetJobName(v string) *JobSummary

SetJobName sets the JobName field's value.

func (*JobSummary) SetStartedAt added in v1.42.10 

func (s *JobSummary) SetStartedAt(v time.Time) *JobSummary

SetStartedAt sets the StartedAt field's value.

func (*JobSummary) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (*JobSummary) SetTags added in v1.42.10 

func (s *JobSummary) SetTags(v map[string]*string) *JobSummary

SetTags sets the Tags field's value.

func (JobSummary) String added in v1.42.10 

func (s JobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.35.19 

type ListTagsForResourceInput struct {

	// Specify the resourceArn for the resource whose tags to display.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.35.19 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.35.19 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.35.19 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.35.19 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.35.19 

type ListTagsForResourceOutput struct {

	// Displays the key, value pairs of tags associated with this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.35.19 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.35.19 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.35.19 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuantumTaskQueueInfo added in v1.45.15 

type QuantumTaskQueueInfo struct {

	// Optional. Provides more information about the queue position. For example,
	// if the task is complete and no longer in the queue, the message field contains
	// that information.
	Message *string `locationName:"message" type:"string"`

	// Current position of the task in the quantum tasks queue.
	//
	// Position is a required field
	Position *string `locationName:"position" type:"string" required:"true"`

	// The name of the queue.
	//
	// Queue is a required field
	Queue *string `locationName:"queue" type:"string" required:"true" enum:"QueueName"`

	// Optional. Specifies the priority of the queue. Quantum tasks in a priority
	// queue are processed before the tasks in a normal queue.
	QueuePriority *string `locationName:"queuePriority" type:"string" enum:"QueuePriority"`
	// contains filtered or unexported fields
}

Information about the queue for the specified quantum task.

func (QuantumTaskQueueInfo) GoString added in v1.45.15 

func (s QuantumTaskQueueInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuantumTaskQueueInfo) SetMessage added in v1.45.15 

func (s *QuantumTaskQueueInfo) SetMessage(v string) *QuantumTaskQueueInfo

SetMessage sets the Message field's value.

func (*QuantumTaskQueueInfo) SetPosition added in v1.45.15 

func (s *QuantumTaskQueueInfo) SetPosition(v string) *QuantumTaskQueueInfo

SetPosition sets the Position field's value.

func (*QuantumTaskQueueInfo) SetQueue added in v1.45.15 

func (s *QuantumTaskQueueInfo) SetQueue(v string) *QuantumTaskQueueInfo

SetQueue sets the Queue field's value.

func (*QuantumTaskQueueInfo) SetQueuePriority added in v1.45.15 

func (s *QuantumTaskQueueInfo) SetQueuePriority(v string) *QuantumTaskQueueInfo

SetQueuePriority sets the QueuePriority field's value.

func (QuantumTaskQueueInfo) String added in v1.45.15 

func (s QuantumTaskQueueInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" 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"`

	// Displays the key, value pairs of tags associated with this quantum task.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Includes information about a quantum task.

func (QuantumTaskSummary) GoString 

func (s QuantumTaskSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTags added in v1.35.19 

func (s *QuantumTaskSummary) SetTags(v map[string]*string) *QuantumTaskSummary

SetTags sets the Tags field's value.

func (QuantumTaskSummary) String 

func (s QuantumTaskSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3DataSource added in v1.42.10 

type S3DataSource struct {

	// Depending on the value specified for the S3DataType, identifies either a
	// key name prefix or a manifest that locates the S3 data source.
	//
	// S3Uri is a required field
	S3Uri *string `locationName:"s3Uri" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (S3DataSource) GoString added in v1.42.10 

func (s S3DataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSource) SetS3Uri added in v1.42.10 

func (s *S3DataSource) SetS3Uri(v string) *S3DataSource

SetS3Uri sets the S3Uri field's value.

func (S3DataSource) String added in v1.42.10 

func (s S3DataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSource) Validate added in v1.42.10 

func (s *S3DataSource) Validate() error

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

type ScriptModeConfig added in v1.42.10 

type ScriptModeConfig struct {

	// The type of compression used by the Python scripts for an Amazon Braket job.
	CompressionType *string `locationName:"compressionType" type:"string" enum:"CompressionType"`

	// The path to the Python script that serves as the entry point for an Amazon
	// Braket job.
	//
	// EntryPoint is a required field
	EntryPoint *string `locationName:"entryPoint" type:"string" required:"true"`

	// The URI that specifies the S3 path to the Python script module that contains
	// the training script used by an Amazon Braket job.
	//
	// S3Uri is a required field
	S3Uri *string `locationName:"s3Uri" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ScriptModeConfig) GoString added in v1.42.10 

func (s ScriptModeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScriptModeConfig) SetCompressionType added in v1.42.10 

func (s *ScriptModeConfig) SetCompressionType(v string) *ScriptModeConfig

SetCompressionType sets the CompressionType field's value.

func (*ScriptModeConfig) SetEntryPoint added in v1.42.10 

func (s *ScriptModeConfig) SetEntryPoint(v string) *ScriptModeConfig

SetEntryPoint sets the EntryPoint field's value.

func (*ScriptModeConfig) SetS3Uri added in v1.42.10 

func (s *ScriptModeConfig) SetS3Uri(v string) *ScriptModeConfig

SetS3Uri sets the S3Uri field's value.

func (ScriptModeConfig) String added in v1.42.10 

func (s ScriptModeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScriptModeConfig) Validate added in v1.42.10 

func (s *ScriptModeConfig) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchJobsFilter added in v1.42.10 

type SearchJobsFilter struct {

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

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

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

A filter used to search for Amazon Braket jobs.

func (SearchJobsFilter) GoString added in v1.42.10 

func (s SearchJobsFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchJobsFilter) SetName added in v1.42.10 

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

SetName sets the Name field's value.

func (*SearchJobsFilter) SetOperator added in v1.42.10 

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

SetOperator sets the Operator field's value.

func (*SearchJobsFilter) SetValues added in v1.42.10 

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

SetValues sets the Values field's value.

func (SearchJobsFilter) String added in v1.42.10 

func (s SearchJobsFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchJobsFilter) Validate added in v1.42.10 

func (s *SearchJobsFilter) Validate() error

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

type SearchJobsInput added in v1.42.10 

type SearchJobsInput struct {

	// The filter values to use when searching for a job.
	//
	// Filters is a required field
	Filters []*SearchJobsFilter `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 to continue results where the previous
	// request ended.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchJobsInput) GoString added in v1.42.10 

func (s SearchJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchJobsInput) SetFilters added in v1.42.10 

func (s *SearchJobsInput) SetFilters(v []*SearchJobsFilter) *SearchJobsInput

SetFilters sets the Filters field's value.

func (*SearchJobsInput) SetMaxResults added in v1.42.10 

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

SetMaxResults sets the MaxResults field's value.

func (*SearchJobsInput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (SearchJobsInput) String added in v1.42.10 

func (s SearchJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchJobsInput) Validate added in v1.42.10 

func (s *SearchJobsInput) Validate() error

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

type SearchJobsOutput added in v1.42.10 

type SearchJobsOutput struct {

	// An array of JobSummary objects for devices that match the specified filter
	// values.
	//
	// Jobs is a required field
	Jobs []*JobSummary `locationName:"jobs" 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 (SearchJobsOutput) GoString added in v1.42.10 

func (s SearchJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchJobsOutput) SetJobs added in v1.42.10 

func (s *SearchJobsOutput) SetJobs(v []*JobSummary) *SearchJobsOutput

SetJobs sets the Jobs field's value.

func (*SearchJobsOutput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (SearchJobsOutput) String added in v1.42.10 

func (s SearchJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 exceeded.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.35.19 

type TagResourceInput struct {

	// Specify the resourceArn of the resource to which a tag will be added.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// Specify the tags to add to the resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.35.19 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.35.19 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.35.19 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.35.19 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.35.19 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.35.19 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.35.19 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.35.19 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.35.19 

type UntagResourceInput struct {

	// Specify the resourceArn for the resource from which to remove the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// Specify the keys for the tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.35.19 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.35.19 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.35.19 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.35.19 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.35.19 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.35.19 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.35.19 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.35.19 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.