# Data Types


The Braket API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [ActionMetadata](API_ActionMetadata.md) 
+  [AlgorithmSpecification](API_AlgorithmSpecification.md) 
+  [Association](API_Association.md) 
+  [ContainerImage](API_ContainerImage.md) 
+  [DataSource](API_DataSource.md) 
+  [DeviceConfig](API_DeviceConfig.md) 
+  [DeviceQueueInfo](API_DeviceQueueInfo.md) 
+  [DeviceSummary](API_DeviceSummary.md) 
+  [ExperimentalCapabilities](API_ExperimentalCapabilities.md) 
+  [HybridJobQueueInfo](API_HybridJobQueueInfo.md) 
+  [InputFileConfig](API_InputFileConfig.md) 
+  [InstanceConfig](API_InstanceConfig.md) 
+  [JobCheckpointConfig](API_JobCheckpointConfig.md) 
+  [JobEventDetails](API_JobEventDetails.md) 
+  [JobOutputDataConfig](API_JobOutputDataConfig.md) 
+  [JobStoppingCondition](API_JobStoppingCondition.md) 
+  [JobSummary](API_JobSummary.md) 
+  [ProgramSetValidationFailure](API_ProgramSetValidationFailure.md) 
+  [QuantumTaskQueueInfo](API_QuantumTaskQueueInfo.md) 
+  [QuantumTaskSummary](API_QuantumTaskSummary.md) 
+  [S3DataSource](API_S3DataSource.md) 
+  [ScriptModeConfig](API_ScriptModeConfig.md) 
+  [SearchDevicesFilter](API_SearchDevicesFilter.md) 
+  [SearchJobsFilter](API_SearchJobsFilter.md) 
+  [SearchQuantumTasksFilter](API_SearchQuantumTasksFilter.md) 
+  [SearchSpendingLimitsFilter](API_SearchSpendingLimitsFilter.md) 
+  [SpendingLimitSummary](API_SpendingLimitSummary.md) 
+  [TimePeriod](API_TimePeriod.md) 

# ActionMetadata


Contains metadata about the quantum task action, including the action type and program statistics.

## Contents


 ** actionType **   <a name="braket-Type-ActionMetadata-actionType"></a>
The type of action associated with the quantum task.  
Type: String  
Required: Yes

 ** executableCount **   <a name="braket-Type-ActionMetadata-executableCount"></a>
The number of executables in a program set. This is only available for a program set.  
Type: Long  
Required: No

 ** programCount **   <a name="braket-Type-ActionMetadata-programCount"></a>
The number of programs in a program set. This is only available for a program set.  
Type: Long  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/ActionMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/ActionMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/ActionMetadata) 

# AlgorithmSpecification


Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.

## Contents


 ** containerImage **   <a name="braket-Type-AlgorithmSpecification-containerImage"></a>
The container image used to create an Amazon Braket hybrid job.  
Type: [ContainerImage](API_ContainerImage.md) object  
Required: No

 ** scriptModeConfig **   <a name="braket-Type-AlgorithmSpecification-scriptModeConfig"></a>
Configures the paths to the Python scripts used for entry and training.  
Type: [ScriptModeConfig](API_ScriptModeConfig.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/AlgorithmSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/AlgorithmSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/AlgorithmSpecification) 

# Association


The Amazon Braket resource and the association type.

## Contents


 ** arn **   <a name="braket-Type-Association-arn"></a>
The Amazon Braket resource arn.  
Type: String  
Pattern: `arn:aws[a-z\-]*:braket:[a-z0-9\-]*:[0-9]{12}:.*`   
Required: Yes

 ** type **   <a name="braket-Type-Association-type"></a>
The association type for the specified Amazon Braket resource arn.  
Type: String  
Valid Values: `RESERVATION_TIME_WINDOW_ARN`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/Association) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/Association) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/Association) 

# ContainerImage


The container image used to create an Amazon Braket hybrid job.

## Contents


 ** uri **   <a name="braket-Type-ContainerImage-uri"></a>
The URI locating the container image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `\d{10,14}\.dkr\.ecr.[a-z0-9-]+\.amazonaws\.com\/.+(@sha256)?:.+`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/ContainerImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/ContainerImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/ContainerImage) 

# DataSource


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

## Contents


 ** s3DataSource **   <a name="braket-Type-DataSource-s3DataSource"></a>
Amazon S3 path of the input data used by the hybrid job.  
Type: [S3DataSource](API_S3DataSource.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/DataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/DataSource) 

# DeviceConfig


Configures the primary device used to create and run an Amazon Braket hybrid job.

## Contents


 ** device **   <a name="braket-Type-DeviceConfig-device"></a>
The primary device ARN used to create and run an Amazon Braket hybrid job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/DeviceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/DeviceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/DeviceConfig) 

# DeviceQueueInfo


Information about quantum tasks and hybrid jobs queued on a device.

## Contents


 ** queue **   <a name="braket-Type-DeviceQueueInfo-queue"></a>
The name of the queue.   
Type: String  
Valid Values: `QUANTUM_TASKS_QUEUE | JOBS_QUEUE`   
Required: Yes

 ** queueSize **   <a name="braket-Type-DeviceQueueInfo-queueSize"></a>
The number of hybrid jobs or quantum tasks in the queue for a given device.   
Type: String  
Required: Yes

 ** queuePriority **   <a name="braket-Type-DeviceQueueInfo-queuePriority"></a>
Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.  
Type: String  
Valid Values: `Normal | Priority`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/DeviceQueueInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/DeviceQueueInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/DeviceQueueInfo) 

# DeviceSummary


Includes information about the device.

## Contents


 ** deviceArn **   <a name="braket-Type-DeviceSummary-deviceArn"></a>
The ARN of the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** deviceName **   <a name="braket-Type-DeviceSummary-deviceName"></a>
The name of the device.  
Type: String  
Required: Yes

 ** deviceStatus **   <a name="braket-Type-DeviceSummary-deviceStatus"></a>
The status of the device.  
Type: String  
Valid Values: `ONLINE | OFFLINE | RETIRED`   
Required: Yes

 ** deviceType **   <a name="braket-Type-DeviceSummary-deviceType"></a>
The type of the device.  
Type: String  
Valid Values: `QPU | SIMULATOR`   
Required: Yes

 ** providerName **   <a name="braket-Type-DeviceSummary-providerName"></a>
The provider of the device.  
Type: String  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/DeviceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/DeviceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/DeviceSummary) 

# ExperimentalCapabilities


Enabled experimental capabilities for quantum hardware. Note that the use of these features may impact device capabilities and performance beyond its standard specifications.

## Contents


**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** enabled **   <a name="braket-Type-ExperimentalCapabilities-enabled"></a>
Enabled experimental capabilities.  
Type: String  
Valid Values: `ALL | NONE`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/ExperimentalCapabilities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/ExperimentalCapabilities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/ExperimentalCapabilities) 

# HybridJobQueueInfo


Information about the queue for a specified hybrid job.

## Contents


 ** position **   <a name="braket-Type-HybridJobQueueInfo-position"></a>
Current position of the hybrid job in the jobs queue.  
Type: String  
Required: Yes

 ** queue **   <a name="braket-Type-HybridJobQueueInfo-queue"></a>
The name of the queue.  
Type: String  
Valid Values: `QUANTUM_TASKS_QUEUE | JOBS_QUEUE`   
Required: Yes

 ** message **   <a name="braket-Type-HybridJobQueueInfo-message"></a>
Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message field contains that information.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/HybridJobQueueInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/HybridJobQueueInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/HybridJobQueueInfo) 

# InputFileConfig


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

## Contents


 ** channelName **   <a name="braket-Type-InputFileConfig-channelName"></a>
A named input source that an Amazon Braket hybrid job can consume.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9\.\-_]+`   
Required: Yes

 ** dataSource **   <a name="braket-Type-InputFileConfig-dataSource"></a>
The location of the input data.  
Type: [DataSource](API_DataSource.md) object  
Required: Yes

 ** contentType **   <a name="braket-Type-InputFileConfig-contentType"></a>
The MIME type of the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/InputFileConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/InputFileConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/InputFileConfig) 

# InstanceConfig


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

## Contents


 ** instanceType **   <a name="braket-Type-InstanceConfig-instanceType"></a>
Configures the type of resource instances to use while running an Amazon Braket hybrid job.  
Type: String  
Valid Values: `ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.18xlarge | ml.p4d.24xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.12xlarge | ml.g6e.16xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge`   
Required: Yes

 ** volumeSizeInGb **   <a name="braket-Type-InstanceConfig-volumeSizeInGb"></a>
The size of the storage volume, in GB, to provision.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

 ** instanceCount **   <a name="braket-Type-InstanceConfig-instanceCount"></a>
Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/InstanceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/InstanceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/InstanceConfig) 

# JobCheckpointConfig


Contains information about the output locations for hybrid job checkpoint data.

## Contents


 ** s3Uri **   <a name="braket-Type-JobCheckpointConfig-s3Uri"></a>
Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, `s3://bucket-name/key-name-prefix`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(https|s3)://([^/]+)/?(.*)`   
Required: Yes

 ** localPath **   <a name="braket-Type-JobCheckpointConfig-localPath"></a>
(Optional) The local directory where checkpoint data is stored. The default directory is `/opt/braket/checkpoints/`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/JobCheckpointConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/JobCheckpointConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/JobCheckpointConfig) 

# JobEventDetails


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

## Contents


 ** eventType **   <a name="braket-Type-JobEventDetails-eventType"></a>
The type of event that occurred related to the Amazon Braket hybrid job.  
Type: String  
Valid Values: `WAITING_FOR_PRIORITY | QUEUED_FOR_EXECUTION | STARTING_INSTANCE | DOWNLOADING_DATA | RUNNING | DEPRIORITIZED_DUE_TO_INACTIVITY | UPLOADING_RESULTS | COMPLETED | FAILED | MAX_RUNTIME_EXCEEDED | CANCELLED`   
Required: No

 ** message **   <a name="braket-Type-JobEventDetails-message"></a>
A message describing the event that occurred related to the Amazon Braket hybrid job.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2500.  
Required: No

 ** timeOfEvent **   <a name="braket-Type-JobEventDetails-timeOfEvent"></a>
The time of the event that occurred related to the Amazon Braket hybrid job.  
Type: Timestamp  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/JobEventDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/JobEventDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/JobEventDetails) 

# JobOutputDataConfig


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

## Contents


 ** s3Path **   <a name="braket-Type-JobOutputDataConfig-s3Path"></a>
Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, `s3://bucket-name/key-name-prefix`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(https|s3)://([^/]+)/?(.*)`   
Required: Yes

 ** kmsKeyId **   <a name="braket-Type-JobOutputDataConfig-kmsKeyId"></a>
The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/JobOutputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/JobOutputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/JobOutputDataConfig) 

# JobStoppingCondition


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

## Contents


 ** maxRuntimeInSeconds **   <a name="braket-Type-JobStoppingCondition-maxRuntimeInSeconds"></a>
The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 432000.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/JobStoppingCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/JobStoppingCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/JobStoppingCondition) 

# JobSummary


Provides summary information about an Amazon Braket hybrid job.

## Contents


 ** createdAt **   <a name="braket-Type-JobSummary-createdAt"></a>
The time at which the Amazon Braket hybrid job was created.  
Type: Timestamp  
Required: Yes

 ** device **   <a name="braket-Type-JobSummary-device"></a>
The primary device used by an Amazon Braket hybrid job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** jobArn **   <a name="braket-Type-JobSummary-jobArn"></a>
The ARN of the Amazon Braket hybrid job.  
Type: String  
Pattern: `arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:job/.*`   
Required: Yes

 ** jobName **   <a name="braket-Type-JobSummary-jobName"></a>
The name of the Amazon Braket hybrid job.  
Type: String  
Required: Yes

 ** status **   <a name="braket-Type-JobSummary-status"></a>
The status of the Amazon Braket hybrid job.  
Type: String  
Valid Values: `QUEUED | RUNNING | COMPLETED | FAILED | CANCELLING | CANCELLED`   
Required: Yes

 ** endedAt **   <a name="braket-Type-JobSummary-endedAt"></a>
The time at which the Amazon Braket hybrid job ended.  
Type: Timestamp  
Required: No

 ** startedAt **   <a name="braket-Type-JobSummary-startedAt"></a>
The time at which the Amazon Braket hybrid job was started.  
Type: Timestamp  
Required: No

 ** tags **   <a name="braket-Type-JobSummary-tags"></a>
Displays the key, value pairs of tags associated with this hybrid job.  
Type: String to string map  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/JobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/JobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/JobSummary) 

# ProgramSetValidationFailure


Contains information about validation failures that occurred during the processing of a program set in a quantum task.

## Contents


 ** programIndex **   <a name="braket-Type-ProgramSetValidationFailure-programIndex"></a>
The index of the program within the program set that failed validation.  
Type: Long  
Required: Yes

 ** errors **   <a name="braket-Type-ProgramSetValidationFailure-errors"></a>
A list of error messages describing the validation failures that occurred.  
Type: Array of strings  
Required: No

 ** inputsIndex **   <a name="braket-Type-ProgramSetValidationFailure-inputsIndex"></a>
The index of the input within the program set that failed validation.  
Type: Long  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/ProgramSetValidationFailure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/ProgramSetValidationFailure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/ProgramSetValidationFailure) 

# QuantumTaskQueueInfo


The queue information for the specified quantum task.

## Contents


 ** position **   <a name="braket-Type-QuantumTaskQueueInfo-position"></a>
Current position of the quantum task in the quantum tasks queue.  
Type: String  
Required: Yes

 ** queue **   <a name="braket-Type-QuantumTaskQueueInfo-queue"></a>
The name of the queue.   
Type: String  
Valid Values: `QUANTUM_TASKS_QUEUE | JOBS_QUEUE`   
Required: Yes

 ** message **   <a name="braket-Type-QuantumTaskQueueInfo-message"></a>
Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message field contains that information.  
Type: String  
Required: No

 ** queuePriority **   <a name="braket-Type-QuantumTaskQueueInfo-queuePriority"></a>
Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.  
Type: String  
Valid Values: `Normal | Priority`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/QuantumTaskQueueInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/QuantumTaskQueueInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/QuantumTaskQueueInfo) 

# QuantumTaskSummary


Includes information about a quantum task.

## Contents


 ** createdAt **   <a name="braket-Type-QuantumTaskSummary-createdAt"></a>
The time at which the quantum task was created.  
Type: Timestamp  
Required: Yes

 ** deviceArn **   <a name="braket-Type-QuantumTaskSummary-deviceArn"></a>
The ARN of the device the quantum task ran on.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** outputS3Bucket **   <a name="braket-Type-QuantumTaskSummary-outputS3Bucket"></a>
The S3 bucket where the quantum task result file is stored.  
Type: String  
Required: Yes

 ** outputS3Directory **   <a name="braket-Type-QuantumTaskSummary-outputS3Directory"></a>
The folder in the S3 bucket where the quantum task result file is stored.  
Type: String  
Required: Yes

 ** quantumTaskArn **   <a name="braket-Type-QuantumTaskSummary-quantumTaskArn"></a>
The ARN of the quantum task.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** shots **   <a name="braket-Type-QuantumTaskSummary-shots"></a>
The shots used for the quantum task.  
Type: Long  
Required: Yes

 ** status **   <a name="braket-Type-QuantumTaskSummary-status"></a>
The status of the quantum task.  
Type: String  
Valid Values: `CREATED | QUEUED | RUNNING | COMPLETED | FAILED | CANCELLING | CANCELLED`   
Required: Yes

 ** endedAt **   <a name="braket-Type-QuantumTaskSummary-endedAt"></a>
The time at which the quantum task finished.  
Type: Timestamp  
Required: No

 ** tags **   <a name="braket-Type-QuantumTaskSummary-tags"></a>
Displays the key, value pairs of tags associated with this quantum task.  
Type: String to string map  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/QuantumTaskSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/QuantumTaskSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/QuantumTaskSummary) 

# S3DataSource


Information about the Amazon S3 storage used by the Amazon Braket hybrid job.

## Contents


 ** s3Uri **   <a name="braket-Type-S3DataSource-s3Uri"></a>
Depending on the value specified for the `S3DataType`, identifies either a key name prefix or a manifest that locates the S3 data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(https|s3)://([^/]+)/?(.*)`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/S3DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/S3DataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/S3DataSource) 

# ScriptModeConfig


Contains information about algorithm scripts used for the Amazon Braket hybrid job.

## Contents


 ** entryPoint **   <a name="braket-Type-ScriptModeConfig-entryPoint"></a>
The entry point in the algorithm scripts from where the execution begins in the hybrid job.  
Type: String  
Required: Yes

 ** s3Uri **   <a name="braket-Type-ScriptModeConfig-s3Uri"></a>
The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(https|s3)://([^/]+)/?(.*)`   
Required: Yes

 ** compressionType **   <a name="braket-Type-ScriptModeConfig-compressionType"></a>
The type of compression used to store the algorithm scripts in Amazon S3 storage.  
Type: String  
Valid Values: `NONE | GZIP`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/ScriptModeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/ScriptModeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/ScriptModeConfig) 

# SearchDevicesFilter


The filter used to search for devices.

## Contents


 ** name **   <a name="braket-Type-SearchDevicesFilter-name"></a>
The name of the device parameter to filter based on. Only `deviceArn` filter name is currently supported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** values **   <a name="braket-Type-SearchDevicesFilter-values"></a>
The values used to filter devices based on the filter name.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/SearchDevicesFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/SearchDevicesFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/SearchDevicesFilter) 

# SearchJobsFilter


A filter used to search for Amazon Braket hybrid jobs. You can combine multiple filters in a single request, except that `jobArn` cannot be combined with any other filter.

## Contents


 ** name **   <a name="braket-Type-SearchJobsFilter-name"></a>
The name of the hybrid job parameter to filter based on. Supported filter names:  
 `jobArn` — Filter by the job ARN. Supports the `EQUAL` operator only. Cannot be combined with other filters.  
 `jobName` — Filter by the job name. Supports the `EQUAL` operator for exact match, or the `CONTAINS` operator for substring match. For example, use `CONTAINS` with a value of `my-experiment` to find all jobs whose name includes "my-experiment".  
 `deviceArn` — Filter by the target device. Supports the `EQUAL` operator only. The value can be a device ARN (for example, `arn:aws:braket:us-east-1::device/qpu/ionq/Aria-1`) or a local simulator identifier (for example, `local:braket/default`).  
 `createdAt` — Filter by the job creation time. Supports the `EQUAL`, `GT`, `GTE`, `LT`, `LTE`, and `BETWEEN` operators. Values must be in RFC 3339 date-time format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** operator **   <a name="braket-Type-SearchJobsFilter-operator"></a>
An operator to use for the filter. The supported operators depend on the filter name. See the `name` parameter for details.  
Type: String  
Valid Values: `LT | LTE | EQUAL | GT | GTE | BETWEEN | CONTAINS`   
Required: Yes

 ** values **   <a name="braket-Type-SearchJobsFilter-values"></a>
The values used to filter hybrid jobs based on the filter name and operator. Each filter accepts an array of values. Most filters accept a single value, except `createdAt` with the `BETWEEN` operator, which requires exactly two values.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/SearchJobsFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/SearchJobsFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/SearchJobsFilter) 

# SearchQuantumTasksFilter


A filter used to search for quantum tasks.

## Contents


 ** name **   <a name="braket-Type-SearchQuantumTasksFilter-name"></a>
The name of the quantum task parameter to filter based on. Filter name can be either `quantumTaskArn`, `deviceArn`, `jobArn`, `status` or `createdAt`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** operator **   <a name="braket-Type-SearchQuantumTasksFilter-operator"></a>
An operator to use for the filter.  
Type: String  
Valid Values: `LT | LTE | EQUAL | GT | GTE | BETWEEN`   
Required: Yes

 ** values **   <a name="braket-Type-SearchQuantumTasksFilter-values"></a>
The values used to filter quantum tasks based on the filter name and operator.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/SearchQuantumTasksFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/SearchQuantumTasksFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/SearchQuantumTasksFilter) 

# SearchSpendingLimitsFilter


Specifies filter criteria for searching spending limits. Use filters to narrow down results based on specific attributes.

## Contents


 ** name **   <a name="braket-Type-SearchSpendingLimitsFilter-name"></a>
The name of the field to filter on. Currently supports `deviceArn` and `spendingLimitArn`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** operator **   <a name="braket-Type-SearchSpendingLimitsFilter-operator"></a>
The comparison operator to use when filtering.  
Type: String  
Valid Values: `EQUAL`   
Required: Yes

 ** values **   <a name="braket-Type-SearchSpendingLimitsFilter-values"></a>
An array of values to match against the specified field.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/SearchSpendingLimitsFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/SearchSpendingLimitsFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/SearchSpendingLimitsFilter) 

# SpendingLimitSummary


Contains summary information about a spending limit, including current spending status and configuration details.

## Contents


 ** createdAt **   <a name="braket-Type-SpendingLimitSummary-createdAt"></a>
The date and time when the spending limit was created, in epoch seconds.  
Type: Timestamp  
Required: Yes

 ** deviceArn **   <a name="braket-Type-SpendingLimitSummary-deviceArn"></a>
The Amazon Resource Name (ARN) of the quantum device associated with this spending limit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** queuedSpend **   <a name="braket-Type-SpendingLimitSummary-queuedSpend"></a>
The amount currently queued for spending on the device, in USD.  
Type: String  
Required: Yes

 ** spendingLimit **   <a name="braket-Type-SpendingLimitSummary-spendingLimit"></a>
The maximum spending amount allowed for the device during the specified time period, in USD.  
Type: String  
Required: Yes

 ** spendingLimitArn **   <a name="braket-Type-SpendingLimitSummary-spendingLimitArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the spending limit.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:spending-limit/.*`   
Required: Yes

 ** timePeriod **   <a name="braket-Type-SpendingLimitSummary-timePeriod"></a>
The time period during which the spending limit is active.  
Type: [TimePeriod](API_TimePeriod.md) object  
Required: Yes

 ** totalSpend **   <a name="braket-Type-SpendingLimitSummary-totalSpend"></a>
The total amount spent on the device so far during the current time period, in USD.  
Type: String  
Required: Yes

 ** updatedAt **   <a name="braket-Type-SpendingLimitSummary-updatedAt"></a>
The date and time when the spending limit was last modified, in epoch seconds.  
Type: Timestamp  
Required: Yes

 ** tags **   <a name="braket-Type-SpendingLimitSummary-tags"></a>
The tags associated with the spending limit. Each tag consists of a key and an optional value.  
Type: String to string map  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/SpendingLimitSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/SpendingLimitSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/SpendingLimitSummary) 

# TimePeriod


Defines a time range for spending limits, specifying when the limit is active.

## Contents


 ** endAt **   <a name="braket-Type-TimePeriod-endAt"></a>
The end date and time for the spending limit period, in epoch seconds.  
Type: Timestamp  
Required: Yes

 ** startAt **   <a name="braket-Type-TimePeriod-startAt"></a>
The start date and time for the spending limit period, in epoch seconds.  
Type: Timestamp  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/braket-2019-09-01/TimePeriod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/braket-2019-09-01/TimePeriod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/braket-2019-09-01/TimePeriod)