Class: Aws::SnowDeviceManagement::Client

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

Overview

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

client = Aws::SnowDeviceManagement::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. This can be an 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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

  • :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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :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) —

    A Bearer Token Provider. This can be an 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::SnowDeviceManagement::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::SnowDeviceManagement::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.



444
445
446
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 444

def initialize(*args)
  super
end

Instance Method Details

#cancel_task(params = {}) ⇒ Types::CancelTaskOutput

Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

Examples:

Request syntax with placeholder values


resp = client.cancel_task({
  task_id: "TaskId", # required
})

Response structure


resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.

Returns:

See Also:



481
482
483
484
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 481

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

#create_task(params = {}) ⇒ Types::CreateTaskOutput

Instructs one or more devices to start a task, such as unlocking or rebooting.

Examples:

Request syntax with placeholder values


resp = client.create_task({
  client_token: "IdempotencyToken",
  command: { # required
    reboot: {
    },
    unlock: {
    },
  },
  description: "TaskDescriptionString",
  tags: {
    "String" => "String",
  },
  targets: ["String"], # required
})

Response structure


resp.task_arn #=> String
resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A token ensuring that the action is called only once with the specified details.

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

  • :command (required, Types::Command) —

    The task to be performed. Only one task is executed on a device at a time.

  • :description (String) —

    A description of the task and its targets.

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

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

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

    A list of managed device IDs.

Returns:

See Also:



542
543
544
545
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 542

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

#describe_device(params = {}) ⇒ Types::DescribeDeviceOutput

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Examples:

Request syntax with placeholder values


resp = client.describe_device({
  managed_device_id: "ManagedDeviceId", # required
})

Response structure


resp.associated_with_job #=> String
resp.device_capacities #=> Array
resp.device_capacities[0].available #=> Integer
resp.device_capacities[0].name #=> String
resp.device_capacities[0].total #=> Integer
resp.device_capacities[0].unit #=> String
resp.device_capacities[0].used #=> Integer
resp.device_state #=> String, one of "UNLOCKED", "LOCKED", "UNLOCKING"
resp.device_type #=> String
resp.last_reached_out_at #=> Time
resp.last_updated_at #=> Time
resp.managed_device_arn #=> String
resp.managed_device_id #=> String
resp.physical_network_interfaces #=> Array
resp.physical_network_interfaces[0].default_gateway #=> String
resp.physical_network_interfaces[0].ip_address #=> String
resp.physical_network_interfaces[0].ip_address_assignment #=> String, one of "DHCP", "STATIC"
resp.physical_network_interfaces[0].mac_address #=> String
resp.physical_network_interfaces[0].netmask #=> String
resp.physical_network_interfaces[0].physical_connector_type #=> String, one of "RJ45", "SFP_PLUS", "QSFP", "RJ45_2", "WIFI"
resp.physical_network_interfaces[0].physical_network_interface_id #=> String
resp.software.install_state #=> String
resp.software.installed_version #=> String
resp.software.installing_version #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_device_id (required, String) —

    The ID of the device that you are checking the information of.

Returns:

See Also:



606
607
608
609
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 606

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

#describe_device_ec2_instances(params = {}) ⇒ Types::DescribeDeviceEc2Output

Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

Examples:

Request syntax with placeholder values


resp = client.describe_device_ec2_instances({
  instance_ids: ["String"], # required
  managed_device_id: "ManagedDeviceId", # required
})

Response structure


resp.instances #=> Array
resp.instances[0].instance.ami_launch_index #=> Integer
resp.instances[0].instance.block_device_mappings #=> Array
resp.instances[0].instance.block_device_mappings[0].device_name #=> String
resp.instances[0].instance.block_device_mappings[0].ebs.attach_time #=> Time
resp.instances[0].instance.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.instances[0].instance.block_device_mappings[0].ebs.status #=> String, one of "ATTACHING", "ATTACHED", "DETACHING", "DETACHED"
resp.instances[0].instance.block_device_mappings[0].ebs.volume_id #=> String
resp.instances[0].instance.cpu_options.core_count #=> Integer
resp.instances[0].instance.cpu_options.threads_per_core #=> Integer
resp.instances[0].instance.created_at #=> Time
resp.instances[0].instance.image_id #=> String
resp.instances[0].instance.instance_id #=> String
resp.instances[0].instance.instance_type #=> String
resp.instances[0].instance.private_ip_address #=> String
resp.instances[0].instance.public_ip_address #=> String
resp.instances[0].instance.root_device_name #=> String
resp.instances[0].instance.security_groups #=> Array
resp.instances[0].instance.security_groups[0].group_id #=> String
resp.instances[0].instance.security_groups[0].group_name #=> String
resp.instances[0].instance.state.code #=> Integer
resp.instances[0].instance.state.name #=> String, one of "PENDING", "RUNNING", "SHUTTING_DOWN", "TERMINATED", "STOPPING", "STOPPED"
resp.instances[0].instance.updated_at #=> Time
resp.instances[0].last_updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

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

    A list of instance IDs associated with the managed device.

  • :managed_device_id (required, String) —

    The ID of the managed device.

Returns:

See Also:



664
665
666
667
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 664

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

#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput

Checks the status of a remote task running on one or more target devices.

Examples:

Request syntax with placeholder values


resp = client.describe_execution({
  managed_device_id: "ManagedDeviceId", # required
  task_id: "TaskId", # required
})

Response structure


resp.execution_id #=> String
resp.last_updated_at #=> Time
resp.managed_device_id #=> String
resp.started_at #=> Time
resp.state #=> String, one of "QUEUED", "IN_PROGRESS", "CANCELED", "FAILED", "SUCCEEDED", "REJECTED", "TIMED_OUT"
resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_device_id (required, String) —

    The ID of the managed device.

  • :task_id (required, String) —

    The ID of the task that the action is describing.

Returns:

See Also:



707
708
709
710
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 707

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

#describe_task(params = {}) ⇒ Types::DescribeTaskOutput

Checks the metadata for a given task on a device.

Examples:

Request syntax with placeholder values


resp = client.describe_task({
  task_id: "TaskId", # required
})

Response structure


resp.completed_at #=> Time
resp.created_at #=> Time
resp.description #=> String
resp.last_updated_at #=> Time
resp.state #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.targets #=> Array
resp.targets[0] #=> String
resp.task_arn #=> String
resp.task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The ID of the task to be described.

Returns:

See Also:



753
754
755
756
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 753

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

#list_device_resources(params = {}) ⇒ Types::ListDeviceResourcesOutput

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

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

Examples:

Request syntax with placeholder values


resp = client.list_device_resources({
  managed_device_id: "ManagedDeviceId", # required
  max_results: 1,
  next_token: "NextToken",
  type: "ListDeviceResourcesInputTypeString",
})

Response structure


resp.next_token #=> String
resp.resources #=> Array
resp.resources[0].arn #=> String
resp.resources[0].id #=> String
resp.resources[0].resource_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_device_id (required, String) —

    The ID of the managed device that you are listing the resources of.

  • :max_results (Integer) —

    The maximum number of resources per page.

  • :next_token (String) —

    A pagination token to continue to the next page of results.

  • :type (String) —

    A structure used to filter the results by type of resource.

Returns:

See Also:



802
803
804
805
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 802

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

#list_devices(params = {}) ⇒ Types::ListDevicesOutput

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

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

Examples:

Request syntax with placeholder values


resp = client.list_devices({
  job_id: "JobId",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.devices #=> Array
resp.devices[0].associated_with_job #=> String
resp.devices[0].managed_device_arn #=> String
resp.devices[0].managed_device_id #=> String
resp.devices[0].tags #=> Hash
resp.devices[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (String) —

    The ID of the job used to order the device.

  • :max_results (Integer) —

    The maximum number of devices to list per page.

  • :next_token (String) —

    A pagination token to continue to the next page of results.

Returns:

See Also:



849
850
851
852
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 849

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

#list_executions(params = {}) ⇒ Types::ListExecutionsOutput

Returns the status of tasks for one or more target devices.

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

Examples:

Request syntax with placeholder values


resp = client.list_executions({
  max_results: 1,
  next_token: "NextToken",
  state: "QUEUED", # accepts QUEUED, IN_PROGRESS, CANCELED, FAILED, SUCCEEDED, REJECTED, TIMED_OUT
  task_id: "TaskId", # required
})

Response structure


resp.executions #=> Array
resp.executions[0].execution_id #=> String
resp.executions[0].managed_device_id #=> String
resp.executions[0].state #=> String, one of "QUEUED", "IN_PROGRESS", "CANCELED", "FAILED", "SUCCEEDED", "REJECTED", "TIMED_OUT"
resp.executions[0].task_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of tasks to list per page.

  • :next_token (String) —

    A pagination token to continue to the next page of tasks.

  • :state (String) —

    A structure used to filter the tasks by their current state.

  • :task_id (required, String) —

    The ID of the task.

Returns:

See Also:



897
898
899
900
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 897

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

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

Returns a list of tags for a managed device or task.

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) —

    The Amazon Resource Name (ARN) of the device or task.

Returns:

See Also:



926
927
928
929
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 926

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

#list_tasks(params = {}) ⇒ Types::ListTasksOutput

Returns a list of tasks that can be filtered by state.

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

Examples:

Request syntax with placeholder values


resp = client.list_tasks({
  max_results: 1,
  next_token: "NextToken",
  state: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED
})

Response structure


resp.next_token #=> String
resp.tasks #=> Array
resp.tasks[0].state #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED"
resp.tasks[0].tags #=> Hash
resp.tasks[0].tags["String"] #=> String
resp.tasks[0].task_arn #=> String
resp.tasks[0].task_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of tasks per page.

  • :next_token (String) —

    A pagination token to continue to the next page of tasks.

  • :state (String) —

    A structure used to filter the list of tasks.

Returns:

See Also:



971
972
973
974
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 971

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

#tag_resource(params = {}) ⇒ Struct

Adds or replaces tags on a device or task.

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) —

    The Amazon Resource Name (ARN) of the device or task.

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

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1001
1002
1003
1004
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 1001

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag from a device or task.

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) —

    The Amazon Resource Name (ARN) of the device or task.

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

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1029
1030
1031
1032
 
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 1029

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