Class: Aws::SnowDeviceManagement::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SnowDeviceManagement::Client
- 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
API Operations collapse
-
#cancel_task(params = {}) ⇒ Types::CancelTaskOutput
Sends a cancel request for a specified task.
-
#create_task(params = {}) ⇒ Types::CreateTaskOutput
Instructs one or more devices to start a task, such as unlocking or rebooting.
-
#describe_device(params = {}) ⇒ Types::DescribeDeviceOutput
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
-
#describe_device_ec2_instances(params = {}) ⇒ Types::DescribeDeviceEc2Output
Checks the current state of the Amazon EC2 instances.
-
#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput
Checks the status of a remote task running on one or more target devices.
-
#describe_task(params = {}) ⇒ Types::DescribeTaskOutput
Checks the metadata for a given task on a device.
-
#list_device_resources(params = {}) ⇒ Types::ListDeviceResourcesOutput
Returns a list of the Amazon Web Services resources available for a device.
-
#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.
-
#list_executions(params = {}) ⇒ Types::ListExecutionsOutput
Returns the status of tasks for one or more target devices.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags for a managed device or task.
-
#list_tasks(params = {}) ⇒ Types::ListTasksOutput
Returns a list of tasks that can be filtered by state.
-
#tag_resource(params = {}) ⇒ Struct
Adds or replaces tags on a device or task.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a device or task.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
476 477 478 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 476 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.
CancelTask
operation changes the task's state.
513 514 515 516 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 513 def cancel_task(params = {}, = {}) req = build_request(:cancel_task, params) req.send_request() end |
#create_task(params = {}) ⇒ Types::CreateTaskOutput
Instructs one or more devices to start a task, such as unlocking or rebooting.
574 575 576 577 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 574 def create_task(params = {}, = {}) req = build_request(:create_task, params) req.send_request() end |
#describe_device(params = {}) ⇒ Types::DescribeDeviceOutput
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
638 639 640 641 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 638 def describe_device(params = {}, = {}) req = build_request(:describe_device, params) req.send_request() 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.
696 697 698 699 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 696 def describe_device_ec2_instances(params = {}, = {}) req = build_request(:describe_device_ec2_instances, params) req.send_request() end |
#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput
Checks the status of a remote task running on one or more target devices.
739 740 741 742 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 739 def describe_execution(params = {}, = {}) req = build_request(:describe_execution, params) req.send_request() end |
#describe_task(params = {}) ⇒ Types::DescribeTaskOutput
Checks the metadata for a given task on a device.
785 786 787 788 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 785 def describe_task(params = {}, = {}) req = build_request(:describe_task, params) req.send_request() 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.
834 835 836 837 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 834 def list_device_resources(params = {}, = {}) req = build_request(:list_device_resources, params) req.send_request() 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.
881 882 883 884 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 881 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() 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.
929 930 931 932 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 929 def list_executions(params = {}, = {}) req = build_request(:list_executions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags for a managed device or task.
958 959 960 961 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 958 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 1003 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or replaces tags on a device or task.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 1033 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a device or task.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-snowdevicemanagement/lib/aws-sdk-snowdevicemanagement/client.rb', line 1061 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |