Class: Aws::Braket::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb

Overview

An API client for Braket. To construct a client, you need to configure a :region and :credentials.

client = Aws::Braket::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Braket::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Braket::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#cancel_job(params = {}) ⇒ Types::CancelJobResponse

Cancels an Amazon Braket hybrid job.

Examples:

Request syntax with placeholder values


resp = client.cancel_job({
  job_arn: "JobArn", # required
})

Response structure


resp.job_arn #=> String
resp.cancellation_status #=> String, one of "CANCELLING", "CANCELLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_arn (required, String) —

    The ARN of the Amazon Braket hybrid job to cancel.

Returns:

See Also:



502
503
504
505
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 502

def cancel_job(params = {}, options = {})
  req = build_request(:cancel_job, params)
  req.send_request(options)
end

#cancel_quantum_task(params = {}) ⇒ Types::CancelQuantumTaskResponse

Cancels the specified task.

Examples:

Request syntax with placeholder values


resp = client.cancel_quantum_task({
  quantum_task_arn: "QuantumTaskArn", # required
  client_token: "String64", # required
})

Response structure


resp.quantum_task_arn #=> String
resp.cancellation_status #=> String, one of "CANCELLING", "CANCELLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :quantum_task_arn (required, String) —

    The ARN of the quantum task to cancel.

  • :client_token (required, String) —

    The client token associated with the cancellation request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 539

def cancel_quantum_task(params = {}, options = {})
  req = build_request(:cancel_quantum_task, params)
  req.send_request(options)
end

#create_job(params = {}) ⇒ Types::CreateJobResponse

Creates an Amazon Braket hybrid job.

Examples:

Request syntax with placeholder values


resp = client.create_job({
  client_token: "String64", # required
  algorithm_specification: { # required
    script_mode_config: {
      entry_point: "String", # required
      s3_uri: "S3Path", # required
      compression_type: "NONE", # accepts NONE, GZIP
    },
    container_image: {
      uri: "Uri", # required
    },
  },
  input_data_config: [
    {
      channel_name: "InputFileConfigChannelNameString", # required
      content_type: "String256",
      data_source: { # required
        s3_data_source: { # required
          s3_uri: "S3Path", # required
        },
      },
    },
  ],
  output_data_config: { # required
    kms_key_id: "String2048",
    s3_path: "S3Path", # required
  },
  checkpoint_config: {
    local_path: "String4096",
    s3_uri: "S3Path", # required
  },
  job_name: "CreateJobRequestJobNameString", # required
  role_arn: "RoleArn", # required
  stopping_condition: {
    max_runtime_in_seconds: 1,
  },
  instance_config: { # required
    instance_type: "ml.t3.large", # required, accepts 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.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, 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
    volume_size_in_gb: 1, # required
    instance_count: 1,
  },
  hyper_parameters: {
    "String256" => "HyperParametersValueString",
  },
  device_config: { # required
    device: "String256", # required
  },
  tags: {
    "String" => "String",
  },
  associations: [
    {
      arn: "BraketResourceArn", # required
      type: "RESERVATION_TIME_WINDOW_ARN", # required, accepts RESERVATION_TIME_WINDOW_ARN
    },
  ],
})

Response structure


resp.job_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The client token associated with this request that guarantees that the request is idempotent.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :algorithm_specification (required, Types::AlgorithmSpecification) —

    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.

  • :input_data_config (Array<Types::InputFileConfig>) —

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

  • :output_data_config (required, Types::JobOutputDataConfig) —

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

  • :checkpoint_config (Types::JobCheckpointConfig) —

    Information about the output locations for hybrid job checkpoint data.

  • :job_name (required, String) —

    The name of the Amazon Braket hybrid job.

  • :role_arn (required, String) —

    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 results and hybrid job details to the users' s3 buckets.

  • :stopping_condition (Types::JobStoppingCondition) —

    The user-defined criteria that specifies when a hybrid job stops running.

  • :instance_config (required, Types::InstanceConfig) —

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

  • :hyper_parameters (Hash<String,String>) —

    Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

  • :device_config (required, Types::DeviceConfig) —

    The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.

  • :tags (Hash<String,String>) —

    Tags to be added to the hybrid job you're creating.

  • :associations (Array<Types::Association>) —

    The list of Amazon Braket resources associated with the hybrid job.

Returns:

See Also:



681
682
683
684
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 681

def create_job(params = {}, options = {})
  req = build_request(:create_job, params)
  req.send_request(options)
end

#create_quantum_task(params = {}) ⇒ Types::CreateQuantumTaskResponse

Creates a quantum task.

Examples:

Request syntax with placeholder values


resp = client.create_quantum_task({
  client_token: "String64", # required
  device_arn: "DeviceArn", # required
  device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
  shots: 1, # required
  output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
  output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
  action: "JsonValue", # required
  tags: {
    "String" => "String",
  },
  job_token: "JobToken",
  associations: [
    {
      arn: "BraketResourceArn", # required
      type: "RESERVATION_TIME_WINDOW_ARN", # required, accepts RESERVATION_TIME_WINDOW_ARN
    },
  ],
  experimental_capabilities: {
    enabled: "ALL", # accepts ALL, NONE
  },
})

Response structure


resp.quantum_task_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :device_arn (required, String) —

    The ARN of the device to run the quantum task on.

  • :device_parameters (String) —

    The parameters for the device to run the quantum task on.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :shots (required, Integer) —

    The number of shots to use for the quantum task.

  • :output_s3_bucket (required, String) —

    The S3 bucket to store quantum task result files in.

  • :output_s3_key_prefix (required, String) —

    The key prefix for the location in the S3 bucket to store quantum task results in.

  • :action (required, String) —

    The action associated with the quantum task.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :tags (Hash<String,String>) —

    Tags to be added to the quantum task you're creating.

  • :job_token (String) —

    The token for an Amazon Braket hybrid job that associates it with the quantum task.

  • :associations (Array<Types::Association>) —

    The list of Amazon Braket resources associated with the quantum task.

  • :experimental_capabilities (Types::ExperimentalCapabilities) —

    Enable experimental capabilities for the quantum task.

Returns:

See Also:



771
772
773
774
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 771

def create_quantum_task(params = {}, options = {})
  req = build_request(:create_quantum_task, params)
  req.send_request(options)
end

#create_spending_limit(params = {}) ⇒ Types::CreateSpendingLimitResponse

Creates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.

Examples:

Request syntax with placeholder values


resp = client.create_spending_limit({
  client_token: "String64", # required
  device_arn: "DeviceArn", # required
  spending_limit: "CreateSpendingLimitRequestSpendingLimitString", # required
  time_period: {
    start_at: Time.now, # required
    end_at: Time.now, # required
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.spending_limit_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Braket ignores the request, but does not return an error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :device_arn (required, String) —

    The Amazon Resource Name (ARN) of the quantum device to apply the spending limit to.

  • :spending_limit (required, String) —

    The maximum amount that can be spent on the specified device, in USD.

  • :time_period (Types::TimePeriod) —

    The time period during which the spending limit is active, including start and end dates.

  • :tags (Hash<String,String>) —

    The tags to apply to the spending limit. Each tag consists of a key and an optional value.

Returns:

See Also:



832
833
834
835
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 832

def create_spending_limit(params = {}, options = {})
  req = build_request(:create_spending_limit, params)
  req.send_request(options)
end

#delete_spending_limit(params = {}) ⇒ Struct

Deletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes unrestricted for spending.

Examples:

Request syntax with placeholder values


resp = client.delete_spending_limit({
  spending_limit_arn: "SpendingLimitArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :spending_limit_arn (required, String) —

    The Amazon Resource Name (ARN) of the spending limit to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



856
857
858
859
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 856

def delete_spending_limit(params = {}, options = {})
  req = build_request(:delete_spending_limit, params)
  req.send_request(options)
end

#get_device(params = {}) ⇒ Types::GetDeviceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_device({
  device_arn: "DeviceArn", # required
})

Response structure


resp.device_arn #=> String
resp.device_name #=> String
resp.provider_name #=> String
resp.device_type #=> String, one of "QPU", "SIMULATOR"
resp.device_status #=> String, one of "ONLINE", "OFFLINE", "RETIRED"
resp.device_capabilities #=> String
resp.device_queue_info #=> Array
resp.device_queue_info[0].queue #=> String, one of "QUANTUM_TASKS_QUEUE", "JOBS_QUEUE"
resp.device_queue_info[0].queue_size #=> String
resp.device_queue_info[0].queue_priority #=> String, one of "Normal", "Priority"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_arn (required, String) —

    The ARN of the device to retrieve.

Returns:

See Also:



911
912
913
914
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 911

def get_device(params = {}, options = {})
  req = build_request(:get_device, params)
  req.send_request(options)
end

#get_job(params = {}) ⇒ Types::GetJobResponse

Retrieves the specified Amazon Braket hybrid job.

Examples:

Request syntax with placeholder values


resp = client.get_job({
  job_arn: "JobArn", # required
  additional_attribute_names: ["QueueInfo"], # accepts QueueInfo
})

Response structure


resp.status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.job_arn #=> String
resp.role_arn #=> String
resp.failure_reason #=> String
resp.job_name #=> String
resp.hyper_parameters #=> Hash
resp.hyper_parameters["String256"] #=> String
resp.input_data_config #=> Array
resp.input_data_config[0].channel_name #=> String
resp.input_data_config[0].content_type #=> String
resp.input_data_config[0].data_source.s3_data_source.s3_uri #=> String
resp.output_data_config.kms_key_id #=> String
resp.output_data_config.s3_path #=> String
resp.stopping_condition.max_runtime_in_seconds #=> Integer
resp.checkpoint_config.local_path #=> String
resp.checkpoint_config.s3_uri #=> String
resp.algorithm_specification.script_mode_config.entry_point #=> String
resp.algorithm_specification.script_mode_config.s3_uri #=> String
resp.algorithm_specification.script_mode_config.compression_type #=> String, one of "NONE", "GZIP"
resp.algorithm_specification.container_image.uri #=> String
resp.instance_config.instance_type #=> String, one of "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.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "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"
resp.instance_config.volume_size_in_gb #=> Integer
resp.instance_config.instance_count #=> Integer
resp.created_at #=> Time
resp.started_at #=> Time
resp.ended_at #=> Time
resp.billable_duration #=> Integer
resp.device_config.device #=> String
resp.events #=> Array
resp.events[0].event_type #=> String, one of "WAITING_FOR_PRIORITY", "QUEUED_FOR_EXECUTION", "STARTING_INSTANCE", "DOWNLOADING_DATA", "RUNNING", "DEPRIORITIZED_DUE_TO_INACTIVITY", "UPLOADING_RESULTS", "COMPLETED", "FAILED", "MAX_RUNTIME_EXCEEDED", "CANCELLED"
resp.events[0].time_of_event #=> Time
resp.events[0].message #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.queue_info.queue #=> String, one of "QUANTUM_TASKS_QUEUE", "JOBS_QUEUE"
resp.queue_info.position #=> String
resp.queue_info.message #=> String
resp.associations #=> Array
resp.associations[0].arn #=> String
resp.associations[0].type #=> String, one of "RESERVATION_TIME_WINDOW_ARN"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_arn (required, String) —

    The ARN of the hybrid job to retrieve.

  • :additional_attribute_names (Array<String>) —

    A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

Returns:

See Also:



1003
1004
1005
1006
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1003

def get_job(params = {}, options = {})
  req = build_request(:get_job, params)
  req.send_request(options)
end

#get_quantum_task(params = {}) ⇒ Types::GetQuantumTaskResponse

Retrieves the specified quantum task.

Examples:

Request syntax with placeholder values


resp = client.get_quantum_task({
  quantum_task_arn: "QuantumTaskArn", # required
  additional_attribute_names: ["QueueInfo"], # accepts QueueInfo
})

Response structure


resp.quantum_task_arn #=> String
resp.status #=> String, one of "CREATED", "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.failure_reason #=> String
resp.device_arn #=> String
resp.device_parameters #=> String
resp.shots #=> Integer
resp.output_s3_bucket #=> String
resp.output_s3_directory #=> String
resp.created_at #=> Time
resp.ended_at #=> Time
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.job_arn #=> String
resp.queue_info.queue #=> String, one of "QUANTUM_TASKS_QUEUE", "JOBS_QUEUE"
resp.queue_info.position #=> String
resp.queue_info.queue_priority #=> String, one of "Normal", "Priority"
resp.queue_info.message #=> String
resp.associations #=> Array
resp.associations[0].arn #=> String
resp.associations[0].type #=> String, one of "RESERVATION_TIME_WINDOW_ARN"
resp.num_successful_shots #=> Integer
resp.action_metadata.action_type #=> String
resp.action_metadata.program_count #=> Integer
resp.action_metadata.executable_count #=> Integer
resp.experimental_capabilities.enabled #=> String, one of "ALL", "NONE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :quantum_task_arn (required, String) —

    The ARN of the quantum task to retrieve.

  • :additional_attribute_names (Array<String>) —

    A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1076

def get_quantum_task(params = {}, options = {})
  req = build_request(:get_quantum_task, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Shows the tags associated with this resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specify the resourceArn for the resource whose tags to display.

Returns:

See Also:



1105
1106
1107
1108
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1105

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#search_devices(params = {}) ⇒ Types::SearchDevicesResponse

Searches for devices using the specified filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_devices({
  next_token: "String",
  max_results: 1,
  filters: [ # required
    {
      name: "SearchDevicesFilterNameString", # required
      values: ["String256"], # required
    },
  ],
})

Response structure


resp.devices #=> Array
resp.devices[0].device_arn #=> String
resp.devices[0].device_name #=> String
resp.devices[0].provider_name #=> String
resp.devices[0].device_type #=> String, one of "QPU", "SIMULATOR"
resp.devices[0].device_status #=> String, one of "ONLINE", "OFFLINE", "RETIRED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

  • :max_results (Integer) —

    The maximum number of results to return in the response.

  • :filters (required, Array<Types::SearchDevicesFilter>) —

    Array of SearchDevicesFilter objects to use when searching for devices.

Returns:

See Also:



1158
1159
1160
1161
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1158

def search_devices(params = {}, options = {})
  req = build_request(:search_devices, params)
  req.send_request(options)
end

#search_jobs(params = {}) ⇒ Types::SearchJobsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_jobs({
  next_token: "String",
  max_results: 1,
  filters: [ # required
    {
      name: "String64", # required
      values: ["String256"], # required
      operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
    },
  ],
})

Response structure


resp.jobs #=> Array
resp.jobs[0].status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.jobs[0].job_arn #=> String
resp.jobs[0].job_name #=> String
resp.jobs[0].device #=> String
resp.jobs[0].created_at #=> Time
resp.jobs[0].started_at #=> Time
resp.jobs[0].ended_at #=> Time
resp.jobs[0].tags #=> Hash
resp.jobs[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

  • :max_results (Integer) —

    The maximum number of results to return in the response.

  • :filters (required, Array<Types::SearchJobsFilter>) —

    Array of SearchJobsFilter objects to use when searching for hybrid jobs.

Returns:

See Also:



1217
1218
1219
1220
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1217

def search_jobs(params = {}, options = {})
  req = build_request(:search_jobs, params)
  req.send_request(options)
end

#search_quantum_tasks(params = {}) ⇒ Types::SearchQuantumTasksResponse

Searches for tasks that match the specified filter values.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_quantum_tasks({
  next_token: "String",
  max_results: 1,
  filters: [ # required
    {
      name: "String64", # required
      values: ["String256"], # required
      operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN
    },
  ],
})

Response structure


resp.quantum_tasks #=> Array
resp.quantum_tasks[0].quantum_task_arn #=> String
resp.quantum_tasks[0].status #=> String, one of "CREATED", "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.quantum_tasks[0].device_arn #=> String
resp.quantum_tasks[0].shots #=> Integer
resp.quantum_tasks[0].output_s3_bucket #=> String
resp.quantum_tasks[0].output_s3_directory #=> String
resp.quantum_tasks[0].created_at #=> Time
resp.quantum_tasks[0].ended_at #=> Time
resp.quantum_tasks[0].tags #=> Hash
resp.quantum_tasks[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

  • :max_results (Integer) —

    Maximum number of results to return in the response.

  • :filters (required, Array<Types::SearchQuantumTasksFilter>) —

    Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.

Returns:

See Also:



1276
1277
1278
1279
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1276

def search_quantum_tasks(params = {}, options = {})
  req = build_request(:search_quantum_tasks, params)
  req.send_request(options)
end

#search_spending_limits(params = {}) ⇒ Types::SearchSpendingLimitsResponse

Searches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_spending_limits({
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String64", # required
      values: ["String256"], # required
      operator: "EQUAL", # required, accepts EQUAL
    },
  ],
})

Response structure


resp.spending_limits #=> Array
resp.spending_limits[0].spending_limit_arn #=> String
resp.spending_limits[0].device_arn #=> String
resp.spending_limits[0].time_period.start_at #=> Time
resp.spending_limits[0].time_period.end_at #=> Time
resp.spending_limits[0].spending_limit #=> String
resp.spending_limits[0].queued_spend #=> String
resp.spending_limits[0].total_spend #=> String
resp.spending_limits[0].created_at #=> Time
resp.spending_limits[0].updated_at #=> Time
resp.spending_limits[0].tags #=> Hash
resp.spending_limits[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to retrieve the next page of results. This value is returned from a previous call to SearchSpendingLimits when there are more results available.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.

  • :filters (Array<Types::SearchSpendingLimitsFilter>) —

    The filters to apply when searching for spending limits. Use filters to narrow down the results based on specific criteria.

Returns:

See Also:



1340
1341
1342
1343
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1340

def search_spending_limits(params = {}, options = {})
  req = build_request(:search_spending_limits, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Add a tag to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specify the resourceArn of the resource to which a tag will be added.

  • :tags (required, Hash<String,String>) —

    Specify the tags to add to the resource. Tags can be specified as a key-value map.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1370
1371
1372
1373
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1370

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specify the resourceArn for the resource from which to remove the tags.

  • :tag_keys (required, Array<String>) —

    Specify the keys for the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1397
1398
1399
1400
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1397

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_spending_limit(params = {}) ⇒ Struct

Updates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.

Examples:

Request syntax with placeholder values


resp = client.update_spending_limit({
  spending_limit_arn: "SpendingLimitArn", # required
  client_token: "String64", # required
  spending_limit: "UpdateSpendingLimitRequestSpendingLimitString",
  time_period: {
    start_at: Time.now, # required
    end_at: Time.now, # required
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :spending_limit_arn (required, String) —

    The Amazon Resource Name (ARN) of the spending limit to update.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Braket ignores the request, but does not return an error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :spending_limit (String) —

    The new maximum amount that can be spent on the specified device, in USD.

  • :time_period (Types::TimePeriod) —

    The new time period during which the spending limit is active, including start and end dates.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1443
1444
1445
1446
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1443

def update_spending_limit(params = {}, options = {})
  req = build_request(:update_spending_limit, params)
  req.send_request(options)
end