aws-sdk-snowdevicemanagement 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-snowdevicemanagement.rb +53 -0
- data/lib/aws-sdk-snowdevicemanagement/client.rb +949 -0
- data/lib/aws-sdk-snowdevicemanagement/client_api.rb +566 -0
- data/lib/aws-sdk-snowdevicemanagement/customizations.rb +0 -0
- data/lib/aws-sdk-snowdevicemanagement/errors.rb +146 -0
- data/lib/aws-sdk-snowdevicemanagement/resource.rb +26 -0
- data/lib/aws-sdk-snowdevicemanagement/types.rb +1242 -0
- metadata +90 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 06fa45cec5709f63da02b5e1e8e7eb0c9291fc04fab3d57314f760aaf8f7baac
|
4
|
+
data.tar.gz: 8949a83b5a217d47516894d5878d9f5449aec0bc40d10be4227e40f181d57c1a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ca16580641111c1115de54e7d9895c5fec91db988b21072d01906b7db0845cff86b4764b035aa679ce25842813288f1806b49c71050a32f2e479709d179124cb
|
7
|
+
data.tar.gz: 91dc64136807718e50f9d083715d46135cb89471e9c1888595b600cea41c218cbdff47ce7705b1f5476ac129ea5dd820f79b75f16648c666298836881a64250e
|
data/CHANGELOG.md
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.0
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-snowdevicemanagement/types'
|
15
|
+
require_relative 'aws-sdk-snowdevicemanagement/client_api'
|
16
|
+
require_relative 'aws-sdk-snowdevicemanagement/client'
|
17
|
+
require_relative 'aws-sdk-snowdevicemanagement/errors'
|
18
|
+
require_relative 'aws-sdk-snowdevicemanagement/resource'
|
19
|
+
require_relative 'aws-sdk-snowdevicemanagement/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Snow Device Management. This module is available in the
|
22
|
+
# `aws-sdk-snowdevicemanagement` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# snow_device_management = Aws::SnowDeviceManagement::Client.new
|
31
|
+
# resp = snow_device_management.cancel_task(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Snow Device Management are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::SnowDeviceManagement::Errors::ServiceError
|
43
|
+
# # rescues all AWS Snow Device Management API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::SnowDeviceManagement
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,949 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:snowdevicemanagement)
|
34
|
+
|
35
|
+
module Aws::SnowDeviceManagement
|
36
|
+
# An API client for SnowDeviceManagement. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::SnowDeviceManagement::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :snowdevicemanagement
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :stub_responses (false)
|
270
|
+
# Causes the client to return stubbed responses. By default
|
271
|
+
# fake responses are generated and returned. You can specify
|
272
|
+
# the response data to return or errors to raise by calling
|
273
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
274
|
+
#
|
275
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
|
+
# requests are made, and retries are disabled.
|
277
|
+
#
|
278
|
+
# @option options [Boolean] :validate_params (true)
|
279
|
+
# When `true`, request parameters are validated before
|
280
|
+
# sending the request.
|
281
|
+
#
|
282
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
283
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
284
|
+
#
|
285
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
286
|
+
# seconds to wait when opening a HTTP session before raising a
|
287
|
+
# `Timeout::Error`.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
290
|
+
# number of seconds to wait for response data. This value can
|
291
|
+
# safely be set per-request on the session.
|
292
|
+
#
|
293
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
294
|
+
# seconds a connection is allowed to sit idle before it is
|
295
|
+
# considered stale. Stale connections are closed and removed
|
296
|
+
# from the pool before making a request.
|
297
|
+
#
|
298
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
299
|
+
# seconds to wait for a 100-continue response before sending the
|
300
|
+
# request body. This option has no effect unless the request has
|
301
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
302
|
+
# disables this behaviour. This value can safely be set per
|
303
|
+
# request on the session.
|
304
|
+
#
|
305
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
|
+
# HTTP debug output will be sent to the `:logger`.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
309
|
+
# SSL peer certificates are verified when establishing a
|
310
|
+
# connection.
|
311
|
+
#
|
312
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
313
|
+
# certificate authority bundle file that should be used when
|
314
|
+
# verifying peer certificates. If you do not pass
|
315
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
316
|
+
# will be used if available.
|
317
|
+
#
|
318
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
319
|
+
# directory that contains the unbundled SSL certificate
|
320
|
+
# authority files for verifying peer certificates. If you do
|
321
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
322
|
+
# system default will be used if available.
|
323
|
+
#
|
324
|
+
def initialize(*args)
|
325
|
+
super
|
326
|
+
end
|
327
|
+
|
328
|
+
# @!group API Operations
|
329
|
+
|
330
|
+
# Sends a cancel request for a specified task. You can cancel a task
|
331
|
+
# only if it's still in a `QUEUED` state. Tasks that are already
|
332
|
+
# running can't be cancelled.
|
333
|
+
#
|
334
|
+
# <note markdown="1"> A task might still run if it's processed from the queue before the
|
335
|
+
# `CancelTask` operation changes the task's state.
|
336
|
+
#
|
337
|
+
# </note>
|
338
|
+
#
|
339
|
+
# @option params [required, String] :task_id
|
340
|
+
# The ID of the task that you are attempting to cancel. You can retrieve
|
341
|
+
# a task ID by using the `ListTasks` operation.
|
342
|
+
#
|
343
|
+
# @return [Types::CancelTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
344
|
+
#
|
345
|
+
# * {Types::CancelTaskOutput#task_id #task_id} => String
|
346
|
+
#
|
347
|
+
# @example Request syntax with placeholder values
|
348
|
+
#
|
349
|
+
# resp = client.cancel_task({
|
350
|
+
# task_id: "TaskId", # required
|
351
|
+
# })
|
352
|
+
#
|
353
|
+
# @example Response structure
|
354
|
+
#
|
355
|
+
# resp.task_id #=> String
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CancelTask AWS API Documentation
|
358
|
+
#
|
359
|
+
# @overload cancel_task(params = {})
|
360
|
+
# @param [Hash] params ({})
|
361
|
+
def cancel_task(params = {}, options = {})
|
362
|
+
req = build_request(:cancel_task, params)
|
363
|
+
req.send_request(options)
|
364
|
+
end
|
365
|
+
|
366
|
+
# Instructs one or more devices to start a task, such as unlocking or
|
367
|
+
# rebooting.
|
368
|
+
#
|
369
|
+
# @option params [String] :client_token
|
370
|
+
# A token ensuring that the action is called only once with the
|
371
|
+
# specified details.
|
372
|
+
#
|
373
|
+
# **A suitable default value is auto-generated.** You should normally
|
374
|
+
# not need to pass this option.**
|
375
|
+
#
|
376
|
+
# @option params [required, Types::Command] :command
|
377
|
+
# The task to be performed. Only one task is executed on a device at a
|
378
|
+
# time.
|
379
|
+
#
|
380
|
+
# @option params [String] :description
|
381
|
+
# A description of the task and its targets.
|
382
|
+
#
|
383
|
+
# @option params [Hash<String,String>] :tags
|
384
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
385
|
+
# categorize a resource in different ways, such as by purpose, owner, or
|
386
|
+
# environment.
|
387
|
+
#
|
388
|
+
# @option params [required, Array<String>] :targets
|
389
|
+
# A list of managed device IDs.
|
390
|
+
#
|
391
|
+
# @return [Types::CreateTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
392
|
+
#
|
393
|
+
# * {Types::CreateTaskOutput#task_arn #task_arn} => String
|
394
|
+
# * {Types::CreateTaskOutput#task_id #task_id} => String
|
395
|
+
#
|
396
|
+
# @example Request syntax with placeholder values
|
397
|
+
#
|
398
|
+
# resp = client.create_task({
|
399
|
+
# client_token: "IdempotencyToken",
|
400
|
+
# command: { # required
|
401
|
+
# reboot: {
|
402
|
+
# },
|
403
|
+
# unlock: {
|
404
|
+
# },
|
405
|
+
# },
|
406
|
+
# description: "TaskDescriptionString",
|
407
|
+
# tags: {
|
408
|
+
# "String" => "String",
|
409
|
+
# },
|
410
|
+
# targets: ["String"], # required
|
411
|
+
# })
|
412
|
+
#
|
413
|
+
# @example Response structure
|
414
|
+
#
|
415
|
+
# resp.task_arn #=> String
|
416
|
+
# resp.task_id #=> String
|
417
|
+
#
|
418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CreateTask AWS API Documentation
|
419
|
+
#
|
420
|
+
# @overload create_task(params = {})
|
421
|
+
# @param [Hash] params ({})
|
422
|
+
def create_task(params = {}, options = {})
|
423
|
+
req = build_request(:create_task, params)
|
424
|
+
req.send_request(options)
|
425
|
+
end
|
426
|
+
|
427
|
+
# Checks device-specific information, such as the device type, software
|
428
|
+
# version, IP addresses, and lock status.
|
429
|
+
#
|
430
|
+
# @option params [required, String] :managed_device_id
|
431
|
+
# The ID of the device that you are checking the information of.
|
432
|
+
#
|
433
|
+
# @return [Types::DescribeDeviceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
434
|
+
#
|
435
|
+
# * {Types::DescribeDeviceOutput#associated_with_job #associated_with_job} => String
|
436
|
+
# * {Types::DescribeDeviceOutput#device_capacities #device_capacities} => Array<Types::Capacity>
|
437
|
+
# * {Types::DescribeDeviceOutput#device_state #device_state} => String
|
438
|
+
# * {Types::DescribeDeviceOutput#device_type #device_type} => String
|
439
|
+
# * {Types::DescribeDeviceOutput#last_reached_out_at #last_reached_out_at} => Time
|
440
|
+
# * {Types::DescribeDeviceOutput#last_updated_at #last_updated_at} => Time
|
441
|
+
# * {Types::DescribeDeviceOutput#managed_device_arn #managed_device_arn} => String
|
442
|
+
# * {Types::DescribeDeviceOutput#managed_device_id #managed_device_id} => String
|
443
|
+
# * {Types::DescribeDeviceOutput#physical_network_interfaces #physical_network_interfaces} => Array<Types::PhysicalNetworkInterface>
|
444
|
+
# * {Types::DescribeDeviceOutput#software #software} => Types::SoftwareInformation
|
445
|
+
# * {Types::DescribeDeviceOutput#tags #tags} => Hash<String,String>
|
446
|
+
#
|
447
|
+
# @example Request syntax with placeholder values
|
448
|
+
#
|
449
|
+
# resp = client.describe_device({
|
450
|
+
# managed_device_id: "ManagedDeviceId", # required
|
451
|
+
# })
|
452
|
+
#
|
453
|
+
# @example Response structure
|
454
|
+
#
|
455
|
+
# resp.associated_with_job #=> String
|
456
|
+
# resp.device_capacities #=> Array
|
457
|
+
# resp.device_capacities[0].available #=> Integer
|
458
|
+
# resp.device_capacities[0].name #=> String
|
459
|
+
# resp.device_capacities[0].total #=> Integer
|
460
|
+
# resp.device_capacities[0].unit #=> String
|
461
|
+
# resp.device_capacities[0].used #=> Integer
|
462
|
+
# resp.device_state #=> String, one of "UNLOCKED", "LOCKED", "UNLOCKING"
|
463
|
+
# resp.device_type #=> String
|
464
|
+
# resp.last_reached_out_at #=> Time
|
465
|
+
# resp.last_updated_at #=> Time
|
466
|
+
# resp.managed_device_arn #=> String
|
467
|
+
# resp.managed_device_id #=> String
|
468
|
+
# resp.physical_network_interfaces #=> Array
|
469
|
+
# resp.physical_network_interfaces[0].default_gateway #=> String
|
470
|
+
# resp.physical_network_interfaces[0].ip_address #=> String
|
471
|
+
# resp.physical_network_interfaces[0].ip_address_assignment #=> String, one of "DHCP", "STATIC"
|
472
|
+
# resp.physical_network_interfaces[0].mac_address #=> String
|
473
|
+
# resp.physical_network_interfaces[0].netmask #=> String
|
474
|
+
# resp.physical_network_interfaces[0].physical_connector_type #=> String, one of "RJ45", "SFP_PLUS", "QSFP", "RJ45_2", "WIFI"
|
475
|
+
# resp.physical_network_interfaces[0].physical_network_interface_id #=> String
|
476
|
+
# resp.software.install_state #=> String
|
477
|
+
# resp.software.installed_version #=> String
|
478
|
+
# resp.software.installing_version #=> String
|
479
|
+
# resp.tags #=> Hash
|
480
|
+
# resp.tags["String"] #=> String
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDevice AWS API Documentation
|
483
|
+
#
|
484
|
+
# @overload describe_device(params = {})
|
485
|
+
# @param [Hash] params ({})
|
486
|
+
def describe_device(params = {}, options = {})
|
487
|
+
req = build_request(:describe_device, params)
|
488
|
+
req.send_request(options)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Checks the current state of the Amazon EC2 instances. The output is
|
492
|
+
# similar to `describeDevice`, but the results are sourced from the
|
493
|
+
# device cache in the Amazon Web Services Cloud and include a subset of
|
494
|
+
# the available fields.
|
495
|
+
#
|
496
|
+
# @option params [required, Array<String>] :instance_ids
|
497
|
+
# A list of instance IDs associated with the managed device.
|
498
|
+
#
|
499
|
+
# @option params [required, String] :managed_device_id
|
500
|
+
# The ID of the managed device.
|
501
|
+
#
|
502
|
+
# @return [Types::DescribeDeviceEc2Output] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
503
|
+
#
|
504
|
+
# * {Types::DescribeDeviceEc2Output#instances #instances} => Array<Types::InstanceSummary>
|
505
|
+
#
|
506
|
+
# @example Request syntax with placeholder values
|
507
|
+
#
|
508
|
+
# resp = client.describe_device_ec2_instances({
|
509
|
+
# instance_ids: ["String"], # required
|
510
|
+
# managed_device_id: "ManagedDeviceId", # required
|
511
|
+
# })
|
512
|
+
#
|
513
|
+
# @example Response structure
|
514
|
+
#
|
515
|
+
# resp.instances #=> Array
|
516
|
+
# resp.instances[0].instance.ami_launch_index #=> Integer
|
517
|
+
# resp.instances[0].instance.block_device_mappings #=> Array
|
518
|
+
# resp.instances[0].instance.block_device_mappings[0].device_name #=> String
|
519
|
+
# resp.instances[0].instance.block_device_mappings[0].ebs.attach_time #=> Time
|
520
|
+
# resp.instances[0].instance.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
|
521
|
+
# resp.instances[0].instance.block_device_mappings[0].ebs.status #=> String, one of "ATTACHING", "ATTACHED", "DETACHING", "DETACHED"
|
522
|
+
# resp.instances[0].instance.block_device_mappings[0].ebs.volume_id #=> String
|
523
|
+
# resp.instances[0].instance.cpu_options.core_count #=> Integer
|
524
|
+
# resp.instances[0].instance.cpu_options.threads_per_core #=> Integer
|
525
|
+
# resp.instances[0].instance.created_at #=> Time
|
526
|
+
# resp.instances[0].instance.image_id #=> String
|
527
|
+
# resp.instances[0].instance.instance_id #=> String
|
528
|
+
# resp.instances[0].instance.instance_type #=> String
|
529
|
+
# resp.instances[0].instance.private_ip_address #=> String
|
530
|
+
# resp.instances[0].instance.public_ip_address #=> String
|
531
|
+
# resp.instances[0].instance.root_device_name #=> String
|
532
|
+
# resp.instances[0].instance.security_groups #=> Array
|
533
|
+
# resp.instances[0].instance.security_groups[0].group_id #=> String
|
534
|
+
# resp.instances[0].instance.security_groups[0].group_name #=> String
|
535
|
+
# resp.instances[0].instance.state.code #=> Integer
|
536
|
+
# resp.instances[0].instance.state.name #=> String, one of "PENDING", "RUNNING", "SHUTTING_DOWN", "TERMINATED", "STOPPING", "STOPPED"
|
537
|
+
# resp.instances[0].instance.updated_at #=> Time
|
538
|
+
# resp.instances[0].last_updated_at #=> Time
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceEc2Instances AWS API Documentation
|
541
|
+
#
|
542
|
+
# @overload describe_device_ec2_instances(params = {})
|
543
|
+
# @param [Hash] params ({})
|
544
|
+
def describe_device_ec2_instances(params = {}, options = {})
|
545
|
+
req = build_request(:describe_device_ec2_instances, params)
|
546
|
+
req.send_request(options)
|
547
|
+
end
|
548
|
+
|
549
|
+
# Checks the status of a remote task running on one or more target
|
550
|
+
# devices.
|
551
|
+
#
|
552
|
+
# @option params [required, String] :managed_device_id
|
553
|
+
# The ID of the managed device.
|
554
|
+
#
|
555
|
+
# @option params [required, String] :task_id
|
556
|
+
# The ID of the task that the action is describing.
|
557
|
+
#
|
558
|
+
# @return [Types::DescribeExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
559
|
+
#
|
560
|
+
# * {Types::DescribeExecutionOutput#execution_id #execution_id} => String
|
561
|
+
# * {Types::DescribeExecutionOutput#last_updated_at #last_updated_at} => Time
|
562
|
+
# * {Types::DescribeExecutionOutput#managed_device_id #managed_device_id} => String
|
563
|
+
# * {Types::DescribeExecutionOutput#started_at #started_at} => Time
|
564
|
+
# * {Types::DescribeExecutionOutput#state #state} => String
|
565
|
+
# * {Types::DescribeExecutionOutput#task_id #task_id} => String
|
566
|
+
#
|
567
|
+
# @example Request syntax with placeholder values
|
568
|
+
#
|
569
|
+
# resp = client.describe_execution({
|
570
|
+
# managed_device_id: "ManagedDeviceId", # required
|
571
|
+
# task_id: "TaskId", # required
|
572
|
+
# })
|
573
|
+
#
|
574
|
+
# @example Response structure
|
575
|
+
#
|
576
|
+
# resp.execution_id #=> String
|
577
|
+
# resp.last_updated_at #=> Time
|
578
|
+
# resp.managed_device_id #=> String
|
579
|
+
# resp.started_at #=> Time
|
580
|
+
# resp.state #=> String, one of "QUEUED", "IN_PROGRESS", "CANCELED", "FAILED", "SUCCEEDED", "REJECTED", "TIMED_OUT"
|
581
|
+
# resp.task_id #=> String
|
582
|
+
#
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeExecution AWS API Documentation
|
584
|
+
#
|
585
|
+
# @overload describe_execution(params = {})
|
586
|
+
# @param [Hash] params ({})
|
587
|
+
def describe_execution(params = {}, options = {})
|
588
|
+
req = build_request(:describe_execution, params)
|
589
|
+
req.send_request(options)
|
590
|
+
end
|
591
|
+
|
592
|
+
# Checks the metadata for a given task on a device.
|
593
|
+
#
|
594
|
+
# @option params [required, String] :task_id
|
595
|
+
# The ID of the task to be described.
|
596
|
+
#
|
597
|
+
# @return [Types::DescribeTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
598
|
+
#
|
599
|
+
# * {Types::DescribeTaskOutput#completed_at #completed_at} => Time
|
600
|
+
# * {Types::DescribeTaskOutput#created_at #created_at} => Time
|
601
|
+
# * {Types::DescribeTaskOutput#description #description} => String
|
602
|
+
# * {Types::DescribeTaskOutput#last_updated_at #last_updated_at} => Time
|
603
|
+
# * {Types::DescribeTaskOutput#state #state} => String
|
604
|
+
# * {Types::DescribeTaskOutput#tags #tags} => Hash<String,String>
|
605
|
+
# * {Types::DescribeTaskOutput#targets #targets} => Array<String>
|
606
|
+
# * {Types::DescribeTaskOutput#task_arn #task_arn} => String
|
607
|
+
# * {Types::DescribeTaskOutput#task_id #task_id} => String
|
608
|
+
#
|
609
|
+
# @example Request syntax with placeholder values
|
610
|
+
#
|
611
|
+
# resp = client.describe_task({
|
612
|
+
# task_id: "TaskId", # required
|
613
|
+
# })
|
614
|
+
#
|
615
|
+
# @example Response structure
|
616
|
+
#
|
617
|
+
# resp.completed_at #=> Time
|
618
|
+
# resp.created_at #=> Time
|
619
|
+
# resp.description #=> String
|
620
|
+
# resp.last_updated_at #=> Time
|
621
|
+
# resp.state #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED"
|
622
|
+
# resp.tags #=> Hash
|
623
|
+
# resp.tags["String"] #=> String
|
624
|
+
# resp.targets #=> Array
|
625
|
+
# resp.targets[0] #=> String
|
626
|
+
# resp.task_arn #=> String
|
627
|
+
# resp.task_id #=> String
|
628
|
+
#
|
629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTask AWS API Documentation
|
630
|
+
#
|
631
|
+
# @overload describe_task(params = {})
|
632
|
+
# @param [Hash] params ({})
|
633
|
+
def describe_task(params = {}, options = {})
|
634
|
+
req = build_request(:describe_task, params)
|
635
|
+
req.send_request(options)
|
636
|
+
end
|
637
|
+
|
638
|
+
# Returns a list of the Amazon Web Services resources available for a
|
639
|
+
# device. Currently, Amazon EC2 instances are the only supported
|
640
|
+
# resource type.
|
641
|
+
#
|
642
|
+
# @option params [required, String] :managed_device_id
|
643
|
+
# The ID of the managed device that you are listing the resources of.
|
644
|
+
#
|
645
|
+
# @option params [Integer] :max_results
|
646
|
+
# The maximum number of resources per page.
|
647
|
+
#
|
648
|
+
# @option params [String] :next_token
|
649
|
+
# A pagination token to continue to the next page of results.
|
650
|
+
#
|
651
|
+
# @option params [String] :type
|
652
|
+
# A structure used to filter the results by type of resource.
|
653
|
+
#
|
654
|
+
# @return [Types::ListDeviceResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
655
|
+
#
|
656
|
+
# * {Types::ListDeviceResourcesOutput#next_token #next_token} => String
|
657
|
+
# * {Types::ListDeviceResourcesOutput#resources #resources} => Array<Types::ResourceSummary>
|
658
|
+
#
|
659
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
660
|
+
#
|
661
|
+
# @example Request syntax with placeholder values
|
662
|
+
#
|
663
|
+
# resp = client.list_device_resources({
|
664
|
+
# managed_device_id: "ManagedDeviceId", # required
|
665
|
+
# max_results: 1,
|
666
|
+
# next_token: "NextToken",
|
667
|
+
# type: "ListDeviceResourcesInputTypeString",
|
668
|
+
# })
|
669
|
+
#
|
670
|
+
# @example Response structure
|
671
|
+
#
|
672
|
+
# resp.next_token #=> String
|
673
|
+
# resp.resources #=> Array
|
674
|
+
# resp.resources[0].arn #=> String
|
675
|
+
# resp.resources[0].id #=> String
|
676
|
+
# resp.resources[0].resource_type #=> String
|
677
|
+
#
|
678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDeviceResources AWS API Documentation
|
679
|
+
#
|
680
|
+
# @overload list_device_resources(params = {})
|
681
|
+
# @param [Hash] params ({})
|
682
|
+
def list_device_resources(params = {}, options = {})
|
683
|
+
req = build_request(:list_device_resources, params)
|
684
|
+
req.send_request(options)
|
685
|
+
end
|
686
|
+
|
687
|
+
# Returns a list of all devices on your Amazon Web Services account that
|
688
|
+
# have Amazon Web Services Snow Device Management enabled in the Amazon
|
689
|
+
# Web Services Region where the command is run.
|
690
|
+
#
|
691
|
+
# @option params [String] :job_id
|
692
|
+
# The ID of the job used to order the device.
|
693
|
+
#
|
694
|
+
# @option params [Integer] :max_results
|
695
|
+
# The maximum number of devices to list per page.
|
696
|
+
#
|
697
|
+
# @option params [String] :next_token
|
698
|
+
# A pagination token to continue to the next page of results.
|
699
|
+
#
|
700
|
+
# @return [Types::ListDevicesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
701
|
+
#
|
702
|
+
# * {Types::ListDevicesOutput#devices #devices} => Array<Types::DeviceSummary>
|
703
|
+
# * {Types::ListDevicesOutput#next_token #next_token} => String
|
704
|
+
#
|
705
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
706
|
+
#
|
707
|
+
# @example Request syntax with placeholder values
|
708
|
+
#
|
709
|
+
# resp = client.list_devices({
|
710
|
+
# job_id: "JobId",
|
711
|
+
# max_results: 1,
|
712
|
+
# next_token: "NextToken",
|
713
|
+
# })
|
714
|
+
#
|
715
|
+
# @example Response structure
|
716
|
+
#
|
717
|
+
# resp.devices #=> Array
|
718
|
+
# resp.devices[0].associated_with_job #=> String
|
719
|
+
# resp.devices[0].managed_device_arn #=> String
|
720
|
+
# resp.devices[0].managed_device_id #=> String
|
721
|
+
# resp.devices[0].tags #=> Hash
|
722
|
+
# resp.devices[0].tags["String"] #=> String
|
723
|
+
# resp.next_token #=> String
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDevices AWS API Documentation
|
726
|
+
#
|
727
|
+
# @overload list_devices(params = {})
|
728
|
+
# @param [Hash] params ({})
|
729
|
+
def list_devices(params = {}, options = {})
|
730
|
+
req = build_request(:list_devices, params)
|
731
|
+
req.send_request(options)
|
732
|
+
end
|
733
|
+
|
734
|
+
# Returns the status of tasks for one or more target devices.
|
735
|
+
#
|
736
|
+
# @option params [Integer] :max_results
|
737
|
+
# The maximum number of tasks to list per page.
|
738
|
+
#
|
739
|
+
# @option params [String] :next_token
|
740
|
+
# A pagination token to continue to the next page of tasks.
|
741
|
+
#
|
742
|
+
# @option params [String] :state
|
743
|
+
# A structure used to filter the tasks by their current state.
|
744
|
+
#
|
745
|
+
# @option params [required, String] :task_id
|
746
|
+
# The ID of the task.
|
747
|
+
#
|
748
|
+
# @return [Types::ListExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
749
|
+
#
|
750
|
+
# * {Types::ListExecutionsOutput#executions #executions} => Array<Types::ExecutionSummary>
|
751
|
+
# * {Types::ListExecutionsOutput#next_token #next_token} => String
|
752
|
+
#
|
753
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
754
|
+
#
|
755
|
+
# @example Request syntax with placeholder values
|
756
|
+
#
|
757
|
+
# resp = client.list_executions({
|
758
|
+
# max_results: 1,
|
759
|
+
# next_token: "NextToken",
|
760
|
+
# state: "QUEUED", # accepts QUEUED, IN_PROGRESS, CANCELED, FAILED, SUCCEEDED, REJECTED, TIMED_OUT
|
761
|
+
# task_id: "TaskId", # required
|
762
|
+
# })
|
763
|
+
#
|
764
|
+
# @example Response structure
|
765
|
+
#
|
766
|
+
# resp.executions #=> Array
|
767
|
+
# resp.executions[0].execution_id #=> String
|
768
|
+
# resp.executions[0].managed_device_id #=> String
|
769
|
+
# resp.executions[0].state #=> String, one of "QUEUED", "IN_PROGRESS", "CANCELED", "FAILED", "SUCCEEDED", "REJECTED", "TIMED_OUT"
|
770
|
+
# resp.executions[0].task_id #=> String
|
771
|
+
# resp.next_token #=> String
|
772
|
+
#
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListExecutions AWS API Documentation
|
774
|
+
#
|
775
|
+
# @overload list_executions(params = {})
|
776
|
+
# @param [Hash] params ({})
|
777
|
+
def list_executions(params = {}, options = {})
|
778
|
+
req = build_request(:list_executions, params)
|
779
|
+
req.send_request(options)
|
780
|
+
end
|
781
|
+
|
782
|
+
# Returns a list of tags for a managed device or task.
|
783
|
+
#
|
784
|
+
# @option params [required, String] :resource_arn
|
785
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
786
|
+
#
|
787
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
788
|
+
#
|
789
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
790
|
+
#
|
791
|
+
# @example Request syntax with placeholder values
|
792
|
+
#
|
793
|
+
# resp = client.list_tags_for_resource({
|
794
|
+
# resource_arn: "String", # required
|
795
|
+
# })
|
796
|
+
#
|
797
|
+
# @example Response structure
|
798
|
+
#
|
799
|
+
# resp.tags #=> Hash
|
800
|
+
# resp.tags["String"] #=> String
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTagsForResource AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload list_tags_for_resource(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def list_tags_for_resource(params = {}, options = {})
|
807
|
+
req = build_request(:list_tags_for_resource, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
811
|
+
# Returns a list of tasks that can be filtered by state.
|
812
|
+
#
|
813
|
+
# @option params [Integer] :max_results
|
814
|
+
# The maximum number of tasks per page.
|
815
|
+
#
|
816
|
+
# @option params [String] :next_token
|
817
|
+
# A pagination token to continue to the next page of tasks.
|
818
|
+
#
|
819
|
+
# @option params [String] :state
|
820
|
+
# A structure used to filter the list of tasks.
|
821
|
+
#
|
822
|
+
# @return [Types::ListTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
823
|
+
#
|
824
|
+
# * {Types::ListTasksOutput#next_token #next_token} => String
|
825
|
+
# * {Types::ListTasksOutput#tasks #tasks} => Array<Types::TaskSummary>
|
826
|
+
#
|
827
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
828
|
+
#
|
829
|
+
# @example Request syntax with placeholder values
|
830
|
+
#
|
831
|
+
# resp = client.list_tasks({
|
832
|
+
# max_results: 1,
|
833
|
+
# next_token: "NextToken",
|
834
|
+
# state: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED
|
835
|
+
# })
|
836
|
+
#
|
837
|
+
# @example Response structure
|
838
|
+
#
|
839
|
+
# resp.next_token #=> String
|
840
|
+
# resp.tasks #=> Array
|
841
|
+
# resp.tasks[0].state #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED"
|
842
|
+
# resp.tasks[0].tags #=> Hash
|
843
|
+
# resp.tasks[0].tags["String"] #=> String
|
844
|
+
# resp.tasks[0].task_arn #=> String
|
845
|
+
# resp.tasks[0].task_id #=> String
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasks AWS API Documentation
|
848
|
+
#
|
849
|
+
# @overload list_tasks(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def list_tasks(params = {}, options = {})
|
852
|
+
req = build_request(:list_tasks, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
856
|
+
# Adds or replaces tags on a device or task.
|
857
|
+
#
|
858
|
+
# @option params [required, String] :resource_arn
|
859
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
860
|
+
#
|
861
|
+
# @option params [required, Hash<String,String>] :tags
|
862
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
863
|
+
# categorize a resource in different ways, such as by purpose, owner, or
|
864
|
+
# environment.
|
865
|
+
#
|
866
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
867
|
+
#
|
868
|
+
# @example Request syntax with placeholder values
|
869
|
+
#
|
870
|
+
# resp = client.tag_resource({
|
871
|
+
# resource_arn: "String", # required
|
872
|
+
# tags: { # required
|
873
|
+
# "String" => "String",
|
874
|
+
# },
|
875
|
+
# })
|
876
|
+
#
|
877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/TagResource AWS API Documentation
|
878
|
+
#
|
879
|
+
# @overload tag_resource(params = {})
|
880
|
+
# @param [Hash] params ({})
|
881
|
+
def tag_resource(params = {}, options = {})
|
882
|
+
req = build_request(:tag_resource, params)
|
883
|
+
req.send_request(options)
|
884
|
+
end
|
885
|
+
|
886
|
+
# Removes a tag from a device or task.
|
887
|
+
#
|
888
|
+
# @option params [required, String] :resource_arn
|
889
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
890
|
+
#
|
891
|
+
# @option params [required, Array<String>] :tag_keys
|
892
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
893
|
+
# categorize a resource in different ways, such as by purpose, owner, or
|
894
|
+
# environment.
|
895
|
+
#
|
896
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
897
|
+
#
|
898
|
+
# @example Request syntax with placeholder values
|
899
|
+
#
|
900
|
+
# resp = client.untag_resource({
|
901
|
+
# resource_arn: "String", # required
|
902
|
+
# tag_keys: ["String"], # required
|
903
|
+
# })
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/UntagResource AWS API Documentation
|
906
|
+
#
|
907
|
+
# @overload untag_resource(params = {})
|
908
|
+
# @param [Hash] params ({})
|
909
|
+
def untag_resource(params = {}, options = {})
|
910
|
+
req = build_request(:untag_resource, params)
|
911
|
+
req.send_request(options)
|
912
|
+
end
|
913
|
+
|
914
|
+
# @!endgroup
|
915
|
+
|
916
|
+
# @param params ({})
|
917
|
+
# @api private
|
918
|
+
def build_request(operation_name, params = {})
|
919
|
+
handlers = @handlers.for(operation_name)
|
920
|
+
context = Seahorse::Client::RequestContext.new(
|
921
|
+
operation_name: operation_name,
|
922
|
+
operation: config.api.operation(operation_name),
|
923
|
+
client: self,
|
924
|
+
params: params,
|
925
|
+
config: config)
|
926
|
+
context[:gem_name] = 'aws-sdk-snowdevicemanagement'
|
927
|
+
context[:gem_version] = '1.0.0'
|
928
|
+
Seahorse::Client::Request.new(handlers, context)
|
929
|
+
end
|
930
|
+
|
931
|
+
# @api private
|
932
|
+
# @deprecated
|
933
|
+
def waiter_names
|
934
|
+
[]
|
935
|
+
end
|
936
|
+
|
937
|
+
class << self
|
938
|
+
|
939
|
+
# @api private
|
940
|
+
attr_reader :identifier
|
941
|
+
|
942
|
+
# @api private
|
943
|
+
def errors_module
|
944
|
+
Errors
|
945
|
+
end
|
946
|
+
|
947
|
+
end
|
948
|
+
end
|
949
|
+
end
|