aws-sdk-snowdevicemanagement 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
File without changes
|
@@ -0,0 +1,146 @@
|
|
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
|
+
module Aws::SnowDeviceManagement
|
11
|
+
|
12
|
+
# When SnowDeviceManagement returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::SnowDeviceManagement::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all SnowDeviceManagement errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::SnowDeviceManagement::Errors::ServiceError
|
20
|
+
# # rescues all SnowDeviceManagement API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {InternalServerException}
|
32
|
+
# * {ResourceNotFoundException}
|
33
|
+
# * {ServiceQuotaExceededException}
|
34
|
+
# * {ThrottlingException}
|
35
|
+
# * {ValidationException}
|
36
|
+
#
|
37
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
38
|
+
# if they are not defined above.
|
39
|
+
module Errors
|
40
|
+
|
41
|
+
extend Aws::Errors::DynamicErrors
|
42
|
+
|
43
|
+
class AccessDeniedException < ServiceError
|
44
|
+
|
45
|
+
# @param [Seahorse::Client::RequestContext] context
|
46
|
+
# @param [String] message
|
47
|
+
# @param [Aws::SnowDeviceManagement::Types::AccessDeniedException] data
|
48
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
49
|
+
super(context, message, data)
|
50
|
+
end
|
51
|
+
|
52
|
+
# @return [String]
|
53
|
+
def message
|
54
|
+
@message || @data[:message]
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
class InternalServerException < ServiceError
|
59
|
+
|
60
|
+
# @param [Seahorse::Client::RequestContext] context
|
61
|
+
# @param [String] message
|
62
|
+
# @param [Aws::SnowDeviceManagement::Types::InternalServerException] data
|
63
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
64
|
+
super(context, message, data)
|
65
|
+
end
|
66
|
+
|
67
|
+
# @return [String]
|
68
|
+
def message
|
69
|
+
@message || @data[:message]
|
70
|
+
end
|
71
|
+
|
72
|
+
def retryable?
|
73
|
+
true
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
class ResourceNotFoundException < ServiceError
|
78
|
+
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
80
|
+
# @param [String] message
|
81
|
+
# @param [Aws::SnowDeviceManagement::Types::ResourceNotFoundException] data
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
83
|
+
super(context, message, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @return [String]
|
87
|
+
def message
|
88
|
+
@message || @data[:message]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
class ServiceQuotaExceededException < ServiceError
|
93
|
+
|
94
|
+
# @param [Seahorse::Client::RequestContext] context
|
95
|
+
# @param [String] message
|
96
|
+
# @param [Aws::SnowDeviceManagement::Types::ServiceQuotaExceededException] data
|
97
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
98
|
+
super(context, message, data)
|
99
|
+
end
|
100
|
+
|
101
|
+
# @return [String]
|
102
|
+
def message
|
103
|
+
@message || @data[:message]
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
class ThrottlingException < ServiceError
|
108
|
+
|
109
|
+
# @param [Seahorse::Client::RequestContext] context
|
110
|
+
# @param [String] message
|
111
|
+
# @param [Aws::SnowDeviceManagement::Types::ThrottlingException] data
|
112
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
113
|
+
super(context, message, data)
|
114
|
+
end
|
115
|
+
|
116
|
+
# @return [String]
|
117
|
+
def message
|
118
|
+
@message || @data[:message]
|
119
|
+
end
|
120
|
+
|
121
|
+
def retryable?
|
122
|
+
true
|
123
|
+
end
|
124
|
+
|
125
|
+
def throttling?
|
126
|
+
true
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
class ValidationException < ServiceError
|
131
|
+
|
132
|
+
# @param [Seahorse::Client::RequestContext] context
|
133
|
+
# @param [String] message
|
134
|
+
# @param [Aws::SnowDeviceManagement::Types::ValidationException] data
|
135
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
136
|
+
super(context, message, data)
|
137
|
+
end
|
138
|
+
|
139
|
+
# @return [String]
|
140
|
+
def message
|
141
|
+
@message || @data[:message]
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
145
|
+
end
|
146
|
+
end
|
@@ -0,0 +1,26 @@
|
|
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
|
+
module Aws::SnowDeviceManagement
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,1242 @@
|
|
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
|
+
module Aws::SnowDeviceManagement
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @note When making an API call, you may pass CancelTaskInput
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# task_id: "TaskId", # required
|
31
|
+
# }
|
32
|
+
#
|
33
|
+
# @!attribute [rw] task_id
|
34
|
+
# The ID of the task that you are attempting to cancel. You can
|
35
|
+
# retrieve a task ID by using the `ListTasks` operation.
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CancelTaskInput AWS API Documentation
|
39
|
+
#
|
40
|
+
class CancelTaskInput < Struct.new(
|
41
|
+
:task_id)
|
42
|
+
SENSITIVE = []
|
43
|
+
include Aws::Structure
|
44
|
+
end
|
45
|
+
|
46
|
+
# @!attribute [rw] task_id
|
47
|
+
# The ID of the task that you are attempting to cancel.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CancelTaskOutput AWS API Documentation
|
51
|
+
#
|
52
|
+
class CancelTaskOutput < Struct.new(
|
53
|
+
:task_id)
|
54
|
+
SENSITIVE = []
|
55
|
+
include Aws::Structure
|
56
|
+
end
|
57
|
+
|
58
|
+
# The physical capacity of the Amazon Web Services Snow Family device.
|
59
|
+
#
|
60
|
+
# @!attribute [rw] available
|
61
|
+
# The amount of capacity available for use on the device.
|
62
|
+
# @return [Integer]
|
63
|
+
#
|
64
|
+
# @!attribute [rw] name
|
65
|
+
# The name of the type of capacity, such as memory.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] total
|
69
|
+
# The total capacity on the device.
|
70
|
+
# @return [Integer]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] unit
|
73
|
+
# The unit of measure for the type of capacity.
|
74
|
+
# @return [String]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] used
|
77
|
+
# The amount of capacity used on the device.
|
78
|
+
# @return [Integer]
|
79
|
+
#
|
80
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/Capacity AWS API Documentation
|
81
|
+
#
|
82
|
+
class Capacity < Struct.new(
|
83
|
+
:available,
|
84
|
+
:name,
|
85
|
+
:total,
|
86
|
+
:unit,
|
87
|
+
:used)
|
88
|
+
SENSITIVE = []
|
89
|
+
include Aws::Structure
|
90
|
+
end
|
91
|
+
|
92
|
+
# The command given to the device to execute.
|
93
|
+
#
|
94
|
+
# @note Command is a union - when making an API calls you must set exactly one of the members.
|
95
|
+
#
|
96
|
+
# @!attribute [rw] reboot
|
97
|
+
# Reboots the device.
|
98
|
+
# @return [Types::Reboot]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] unlock
|
101
|
+
# Unlocks the device.
|
102
|
+
# @return [Types::Unlock]
|
103
|
+
#
|
104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/Command AWS API Documentation
|
105
|
+
#
|
106
|
+
class Command < Struct.new(
|
107
|
+
:reboot,
|
108
|
+
:unlock,
|
109
|
+
:unknown)
|
110
|
+
SENSITIVE = []
|
111
|
+
include Aws::Structure
|
112
|
+
include Aws::Structure::Union
|
113
|
+
|
114
|
+
class Reboot < Command; end
|
115
|
+
class Unlock < Command; end
|
116
|
+
class Unknown < Command; end
|
117
|
+
end
|
118
|
+
|
119
|
+
# The options for how a device's CPU is configured.
|
120
|
+
#
|
121
|
+
# @!attribute [rw] core_count
|
122
|
+
# The number of cores that the CPU can use.
|
123
|
+
# @return [Integer]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] threads_per_core
|
126
|
+
# The number of threads per core in the CPU.
|
127
|
+
# @return [Integer]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CpuOptions AWS API Documentation
|
130
|
+
#
|
131
|
+
class CpuOptions < Struct.new(
|
132
|
+
:core_count,
|
133
|
+
:threads_per_core)
|
134
|
+
SENSITIVE = []
|
135
|
+
include Aws::Structure
|
136
|
+
end
|
137
|
+
|
138
|
+
# @note When making an API call, you may pass CreateTaskInput
|
139
|
+
# data as a hash:
|
140
|
+
#
|
141
|
+
# {
|
142
|
+
# client_token: "IdempotencyToken",
|
143
|
+
# command: { # required
|
144
|
+
# reboot: {
|
145
|
+
# },
|
146
|
+
# unlock: {
|
147
|
+
# },
|
148
|
+
# },
|
149
|
+
# description: "TaskDescriptionString",
|
150
|
+
# tags: {
|
151
|
+
# "String" => "String",
|
152
|
+
# },
|
153
|
+
# targets: ["String"], # required
|
154
|
+
# }
|
155
|
+
#
|
156
|
+
# @!attribute [rw] client_token
|
157
|
+
# A token ensuring that the action is called only once with the
|
158
|
+
# specified details.
|
159
|
+
#
|
160
|
+
# **A suitable default value is auto-generated.** You should normally
|
161
|
+
# not need to pass this option.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] command
|
165
|
+
# The task to be performed. Only one task is executed on a device at a
|
166
|
+
# time.
|
167
|
+
# @return [Types::Command]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] description
|
170
|
+
# A description of the task and its targets.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] tags
|
174
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
175
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
176
|
+
# or environment.
|
177
|
+
# @return [Hash<String,String>]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] targets
|
180
|
+
# A list of managed device IDs.
|
181
|
+
# @return [Array<String>]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CreateTaskInput AWS API Documentation
|
184
|
+
#
|
185
|
+
class CreateTaskInput < Struct.new(
|
186
|
+
:client_token,
|
187
|
+
:command,
|
188
|
+
:description,
|
189
|
+
:tags,
|
190
|
+
:targets)
|
191
|
+
SENSITIVE = []
|
192
|
+
include Aws::Structure
|
193
|
+
end
|
194
|
+
|
195
|
+
# @!attribute [rw] task_arn
|
196
|
+
# The Amazon Resource Name (ARN) of the task that you created.
|
197
|
+
# @return [String]
|
198
|
+
#
|
199
|
+
# @!attribute [rw] task_id
|
200
|
+
# The ID of the task that you created.
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CreateTaskOutput AWS API Documentation
|
204
|
+
#
|
205
|
+
class CreateTaskOutput < Struct.new(
|
206
|
+
:task_arn,
|
207
|
+
:task_id)
|
208
|
+
SENSITIVE = []
|
209
|
+
include Aws::Structure
|
210
|
+
end
|
211
|
+
|
212
|
+
# @note When making an API call, you may pass DescribeDeviceEc2Input
|
213
|
+
# data as a hash:
|
214
|
+
#
|
215
|
+
# {
|
216
|
+
# instance_ids: ["String"], # required
|
217
|
+
# managed_device_id: "ManagedDeviceId", # required
|
218
|
+
# }
|
219
|
+
#
|
220
|
+
# @!attribute [rw] instance_ids
|
221
|
+
# A list of instance IDs associated with the managed device.
|
222
|
+
# @return [Array<String>]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] managed_device_id
|
225
|
+
# The ID of the managed device.
|
226
|
+
# @return [String]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceEc2Input AWS API Documentation
|
229
|
+
#
|
230
|
+
class DescribeDeviceEc2Input < Struct.new(
|
231
|
+
:instance_ids,
|
232
|
+
:managed_device_id)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# @!attribute [rw] instances
|
238
|
+
# A list of structures containing information about each instance.
|
239
|
+
# @return [Array<Types::InstanceSummary>]
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceEc2Output AWS API Documentation
|
242
|
+
#
|
243
|
+
class DescribeDeviceEc2Output < Struct.new(
|
244
|
+
:instances)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
249
|
+
# @note When making an API call, you may pass DescribeDeviceInput
|
250
|
+
# data as a hash:
|
251
|
+
#
|
252
|
+
# {
|
253
|
+
# managed_device_id: "ManagedDeviceId", # required
|
254
|
+
# }
|
255
|
+
#
|
256
|
+
# @!attribute [rw] managed_device_id
|
257
|
+
# The ID of the device that you are checking the information of.
|
258
|
+
# @return [String]
|
259
|
+
#
|
260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceInput AWS API Documentation
|
261
|
+
#
|
262
|
+
class DescribeDeviceInput < Struct.new(
|
263
|
+
:managed_device_id)
|
264
|
+
SENSITIVE = []
|
265
|
+
include Aws::Structure
|
266
|
+
end
|
267
|
+
|
268
|
+
# @!attribute [rw] associated_with_job
|
269
|
+
# The ID of the job used when ordering the device.
|
270
|
+
# @return [String]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] device_capacities
|
273
|
+
# The hardware specifications of the device.
|
274
|
+
# @return [Array<Types::Capacity>]
|
275
|
+
#
|
276
|
+
# @!attribute [rw] device_state
|
277
|
+
# The current state of the device.
|
278
|
+
# @return [String]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] device_type
|
281
|
+
# The type of Amazon Web Services Snow Family device.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] last_reached_out_at
|
285
|
+
# When the device last contacted the Amazon Web Services Cloud.
|
286
|
+
# Indicates that the device is online.
|
287
|
+
# @return [Time]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] last_updated_at
|
290
|
+
# When the device last pushed an update to the Amazon Web Services
|
291
|
+
# Cloud. Indicates when the device cache was refreshed.
|
292
|
+
# @return [Time]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] managed_device_arn
|
295
|
+
# The Amazon Resource Name (ARN) of the device.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] managed_device_id
|
299
|
+
# The ID of the device that you checked the information for.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @!attribute [rw] physical_network_interfaces
|
303
|
+
# The network interfaces available on the device.
|
304
|
+
# @return [Array<Types::PhysicalNetworkInterface>]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] software
|
307
|
+
# The software installed on the device.
|
308
|
+
# @return [Types::SoftwareInformation]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] tags
|
311
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
312
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
313
|
+
# or environment.
|
314
|
+
# @return [Hash<String,String>]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceOutput AWS API Documentation
|
317
|
+
#
|
318
|
+
class DescribeDeviceOutput < Struct.new(
|
319
|
+
:associated_with_job,
|
320
|
+
:device_capacities,
|
321
|
+
:device_state,
|
322
|
+
:device_type,
|
323
|
+
:last_reached_out_at,
|
324
|
+
:last_updated_at,
|
325
|
+
:managed_device_arn,
|
326
|
+
:managed_device_id,
|
327
|
+
:physical_network_interfaces,
|
328
|
+
:software,
|
329
|
+
:tags)
|
330
|
+
SENSITIVE = []
|
331
|
+
include Aws::Structure
|
332
|
+
end
|
333
|
+
|
334
|
+
# @note When making an API call, you may pass DescribeExecutionInput
|
335
|
+
# data as a hash:
|
336
|
+
#
|
337
|
+
# {
|
338
|
+
# managed_device_id: "ManagedDeviceId", # required
|
339
|
+
# task_id: "TaskId", # required
|
340
|
+
# }
|
341
|
+
#
|
342
|
+
# @!attribute [rw] managed_device_id
|
343
|
+
# The ID of the managed device.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] task_id
|
347
|
+
# The ID of the task that the action is describing.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeExecutionInput AWS API Documentation
|
351
|
+
#
|
352
|
+
class DescribeExecutionInput < Struct.new(
|
353
|
+
:managed_device_id,
|
354
|
+
:task_id)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
359
|
+
# @!attribute [rw] execution_id
|
360
|
+
# The ID of the execution.
|
361
|
+
# @return [String]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] last_updated_at
|
364
|
+
# When the status of the execution was last updated.
|
365
|
+
# @return [Time]
|
366
|
+
#
|
367
|
+
# @!attribute [rw] managed_device_id
|
368
|
+
# The ID of the managed device that the task is being executed on.
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] started_at
|
372
|
+
# When the execution began.
|
373
|
+
# @return [Time]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] state
|
376
|
+
# The current state of the execution.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] task_id
|
380
|
+
# The ID of the task being executed on the device.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeExecutionOutput AWS API Documentation
|
384
|
+
#
|
385
|
+
class DescribeExecutionOutput < Struct.new(
|
386
|
+
:execution_id,
|
387
|
+
:last_updated_at,
|
388
|
+
:managed_device_id,
|
389
|
+
:started_at,
|
390
|
+
:state,
|
391
|
+
:task_id)
|
392
|
+
SENSITIVE = []
|
393
|
+
include Aws::Structure
|
394
|
+
end
|
395
|
+
|
396
|
+
# @note When making an API call, you may pass DescribeTaskInput
|
397
|
+
# data as a hash:
|
398
|
+
#
|
399
|
+
# {
|
400
|
+
# task_id: "TaskId", # required
|
401
|
+
# }
|
402
|
+
#
|
403
|
+
# @!attribute [rw] task_id
|
404
|
+
# The ID of the task to be described.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTaskInput AWS API Documentation
|
408
|
+
#
|
409
|
+
class DescribeTaskInput < Struct.new(
|
410
|
+
:task_id)
|
411
|
+
SENSITIVE = []
|
412
|
+
include Aws::Structure
|
413
|
+
end
|
414
|
+
|
415
|
+
# @!attribute [rw] completed_at
|
416
|
+
# When the task was completed.
|
417
|
+
# @return [Time]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] created_at
|
420
|
+
# When the `CreateTask` operation was called.
|
421
|
+
# @return [Time]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] description
|
424
|
+
# The description provided of the task and managed devices.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] last_updated_at
|
428
|
+
# When the state of the task was last updated.
|
429
|
+
# @return [Time]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] state
|
432
|
+
# The current state of the task.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] tags
|
436
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
437
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
438
|
+
# or environment.
|
439
|
+
# @return [Hash<String,String>]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] targets
|
442
|
+
# The managed devices that the task was sent to.
|
443
|
+
# @return [Array<String>]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] task_arn
|
446
|
+
# The Amazon Resource Name (ARN) of the task.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] task_id
|
450
|
+
# The ID of the task.
|
451
|
+
# @return [String]
|
452
|
+
#
|
453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTaskOutput AWS API Documentation
|
454
|
+
#
|
455
|
+
class DescribeTaskOutput < Struct.new(
|
456
|
+
:completed_at,
|
457
|
+
:created_at,
|
458
|
+
:description,
|
459
|
+
:last_updated_at,
|
460
|
+
:state,
|
461
|
+
:tags,
|
462
|
+
:targets,
|
463
|
+
:task_arn,
|
464
|
+
:task_id)
|
465
|
+
SENSITIVE = []
|
466
|
+
include Aws::Structure
|
467
|
+
end
|
468
|
+
|
469
|
+
# Identifying information about the device.
|
470
|
+
#
|
471
|
+
# @!attribute [rw] associated_with_job
|
472
|
+
# The ID of the job used to order the device.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] managed_device_arn
|
476
|
+
# The Amazon Resource Name (ARN) of the device.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] managed_device_id
|
480
|
+
# The ID of the device.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] tags
|
484
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
485
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
486
|
+
# or environment.
|
487
|
+
# @return [Hash<String,String>]
|
488
|
+
#
|
489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DeviceSummary AWS API Documentation
|
490
|
+
#
|
491
|
+
class DeviceSummary < Struct.new(
|
492
|
+
:associated_with_job,
|
493
|
+
:managed_device_arn,
|
494
|
+
:managed_device_id,
|
495
|
+
:tags)
|
496
|
+
SENSITIVE = []
|
497
|
+
include Aws::Structure
|
498
|
+
end
|
499
|
+
|
500
|
+
# Describes a parameter used to set up an Amazon Elastic Block Store
|
501
|
+
# (Amazon EBS) volume in a block device mapping.
|
502
|
+
#
|
503
|
+
# @!attribute [rw] attach_time
|
504
|
+
# When the attachment was initiated.
|
505
|
+
# @return [Time]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] delete_on_termination
|
508
|
+
# A value that indicates whether the volume is deleted on instance
|
509
|
+
# termination.
|
510
|
+
# @return [Boolean]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] status
|
513
|
+
# The attachment state.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] volume_id
|
517
|
+
# The ID of the Amazon EBS volume.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/EbsInstanceBlockDevice AWS API Documentation
|
521
|
+
#
|
522
|
+
class EbsInstanceBlockDevice < Struct.new(
|
523
|
+
:attach_time,
|
524
|
+
:delete_on_termination,
|
525
|
+
:status,
|
526
|
+
:volume_id)
|
527
|
+
SENSITIVE = []
|
528
|
+
include Aws::Structure
|
529
|
+
end
|
530
|
+
|
531
|
+
# The summary of a task execution on a specified device.
|
532
|
+
#
|
533
|
+
# @!attribute [rw] execution_id
|
534
|
+
# The ID of the execution.
|
535
|
+
# @return [String]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] managed_device_id
|
538
|
+
# The ID of the managed device that the task is being executed on.
|
539
|
+
# @return [String]
|
540
|
+
#
|
541
|
+
# @!attribute [rw] state
|
542
|
+
# The state of the execution.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] task_id
|
546
|
+
# The ID of the task.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ExecutionSummary AWS API Documentation
|
550
|
+
#
|
551
|
+
class ExecutionSummary < Struct.new(
|
552
|
+
:execution_id,
|
553
|
+
:managed_device_id,
|
554
|
+
:state,
|
555
|
+
:task_id)
|
556
|
+
SENSITIVE = []
|
557
|
+
include Aws::Structure
|
558
|
+
end
|
559
|
+
|
560
|
+
# The description of an instance. Currently, Amazon EC2 instances are
|
561
|
+
# the only supported instance type.
|
562
|
+
#
|
563
|
+
# @!attribute [rw] ami_launch_index
|
564
|
+
# The Amazon Machine Image (AMI) launch index, which you can use to
|
565
|
+
# find this instance in the launch group.
|
566
|
+
# @return [Integer]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] block_device_mappings
|
569
|
+
# Any block device mapping entries for the instance.
|
570
|
+
# @return [Array<Types::InstanceBlockDeviceMapping>]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] cpu_options
|
573
|
+
# The CPU options for the instance.
|
574
|
+
# @return [Types::CpuOptions]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] created_at
|
577
|
+
# When the instance was created.
|
578
|
+
# @return [Time]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] image_id
|
581
|
+
# The ID of the AMI used to launch the instance.
|
582
|
+
# @return [String]
|
583
|
+
#
|
584
|
+
# @!attribute [rw] instance_id
|
585
|
+
# The ID of the instance.
|
586
|
+
# @return [String]
|
587
|
+
#
|
588
|
+
# @!attribute [rw] instance_type
|
589
|
+
# The instance type.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] private_ip_address
|
593
|
+
# The private IPv4 address assigned to the instance.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] public_ip_address
|
597
|
+
# The public IPv4 address assigned to the instance.
|
598
|
+
# @return [String]
|
599
|
+
#
|
600
|
+
# @!attribute [rw] root_device_name
|
601
|
+
# The device name of the root device volume (for example,
|
602
|
+
# `/dev/sda1`).
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] security_groups
|
606
|
+
# The security groups for the instance.
|
607
|
+
# @return [Array<Types::SecurityGroupIdentifier>]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] state
|
610
|
+
# The description of the current state of an instance.
|
611
|
+
# @return [Types::InstanceState]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] updated_at
|
614
|
+
# When the instance was last updated.
|
615
|
+
# @return [Time]
|
616
|
+
#
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/Instance AWS API Documentation
|
618
|
+
#
|
619
|
+
class Instance < Struct.new(
|
620
|
+
:ami_launch_index,
|
621
|
+
:block_device_mappings,
|
622
|
+
:cpu_options,
|
623
|
+
:created_at,
|
624
|
+
:image_id,
|
625
|
+
:instance_id,
|
626
|
+
:instance_type,
|
627
|
+
:private_ip_address,
|
628
|
+
:public_ip_address,
|
629
|
+
:root_device_name,
|
630
|
+
:security_groups,
|
631
|
+
:state,
|
632
|
+
:updated_at)
|
633
|
+
SENSITIVE = []
|
634
|
+
include Aws::Structure
|
635
|
+
end
|
636
|
+
|
637
|
+
# The description of a block device mapping.
|
638
|
+
#
|
639
|
+
# @!attribute [rw] device_name
|
640
|
+
# The block device name.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] ebs
|
644
|
+
# The parameters used to automatically set up Amazon Elastic Block
|
645
|
+
# Store (Amazon EBS) volumes when the instance is launched.
|
646
|
+
# @return [Types::EbsInstanceBlockDevice]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/InstanceBlockDeviceMapping AWS API Documentation
|
649
|
+
#
|
650
|
+
class InstanceBlockDeviceMapping < Struct.new(
|
651
|
+
:device_name,
|
652
|
+
:ebs)
|
653
|
+
SENSITIVE = []
|
654
|
+
include Aws::Structure
|
655
|
+
end
|
656
|
+
|
657
|
+
# The description of the current state of an instance.
|
658
|
+
#
|
659
|
+
# @!attribute [rw] code
|
660
|
+
# The state of the instance as a 16-bit unsigned integer.
|
661
|
+
#
|
662
|
+
# The high byte is all of the bits between 2^8 and (2^16)-1, which
|
663
|
+
# equals decimal values between 256 and 65,535. These numerical values
|
664
|
+
# are used for internal purposes and should be ignored.
|
665
|
+
#
|
666
|
+
# The low byte is all of the bits between 2^0 and (2^8)-1, which
|
667
|
+
# equals decimal values between 0 and 255.
|
668
|
+
#
|
669
|
+
# The valid values for the instance state code are all in the range of
|
670
|
+
# the low byte. These values are:
|
671
|
+
#
|
672
|
+
# * `0`\: `pending`
|
673
|
+
#
|
674
|
+
# * `16`\: `running`
|
675
|
+
#
|
676
|
+
# * `32`\: `shutting-down`
|
677
|
+
#
|
678
|
+
# * `48`\: `terminated`
|
679
|
+
#
|
680
|
+
# * `64`\: `stopping`
|
681
|
+
#
|
682
|
+
# * `80`\: `stopped`
|
683
|
+
#
|
684
|
+
# You can ignore the high byte value by zeroing out all of the bits
|
685
|
+
# above 2^8 or 256 in decimal.
|
686
|
+
# @return [Integer]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] name
|
689
|
+
# The current state of the instance.
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/InstanceState AWS API Documentation
|
693
|
+
#
|
694
|
+
class InstanceState < Struct.new(
|
695
|
+
:code,
|
696
|
+
:name)
|
697
|
+
SENSITIVE = []
|
698
|
+
include Aws::Structure
|
699
|
+
end
|
700
|
+
|
701
|
+
# The details about the instance.
|
702
|
+
#
|
703
|
+
# @!attribute [rw] instance
|
704
|
+
# A structure containing details about the instance.
|
705
|
+
# @return [Types::Instance]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] last_updated_at
|
708
|
+
# When the instance summary was last updated.
|
709
|
+
# @return [Time]
|
710
|
+
#
|
711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/InstanceSummary AWS API Documentation
|
712
|
+
#
|
713
|
+
class InstanceSummary < Struct.new(
|
714
|
+
:instance,
|
715
|
+
:last_updated_at)
|
716
|
+
SENSITIVE = []
|
717
|
+
include Aws::Structure
|
718
|
+
end
|
719
|
+
|
720
|
+
# An unexpected error occurred while processing the request.
|
721
|
+
#
|
722
|
+
# @!attribute [rw] message
|
723
|
+
# @return [String]
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/InternalServerException AWS API Documentation
|
726
|
+
#
|
727
|
+
class InternalServerException < Struct.new(
|
728
|
+
:message)
|
729
|
+
SENSITIVE = []
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
733
|
+
# @note When making an API call, you may pass ListDeviceResourcesInput
|
734
|
+
# data as a hash:
|
735
|
+
#
|
736
|
+
# {
|
737
|
+
# managed_device_id: "ManagedDeviceId", # required
|
738
|
+
# max_results: 1,
|
739
|
+
# next_token: "NextToken",
|
740
|
+
# type: "ListDeviceResourcesInputTypeString",
|
741
|
+
# }
|
742
|
+
#
|
743
|
+
# @!attribute [rw] managed_device_id
|
744
|
+
# The ID of the managed device that you are listing the resources of.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] max_results
|
748
|
+
# The maximum number of resources per page.
|
749
|
+
# @return [Integer]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] next_token
|
752
|
+
# A pagination token to continue to the next page of results.
|
753
|
+
# @return [String]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] type
|
756
|
+
# A structure used to filter the results by type of resource.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDeviceResourcesInput AWS API Documentation
|
760
|
+
#
|
761
|
+
class ListDeviceResourcesInput < Struct.new(
|
762
|
+
:managed_device_id,
|
763
|
+
:max_results,
|
764
|
+
:next_token,
|
765
|
+
:type)
|
766
|
+
SENSITIVE = []
|
767
|
+
include Aws::Structure
|
768
|
+
end
|
769
|
+
|
770
|
+
# @!attribute [rw] next_token
|
771
|
+
# A pagination token to continue to the next page of results.
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] resources
|
775
|
+
# A structure defining the resource's type, Amazon Resource Name
|
776
|
+
# (ARN), and ID.
|
777
|
+
# @return [Array<Types::ResourceSummary>]
|
778
|
+
#
|
779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDeviceResourcesOutput AWS API Documentation
|
780
|
+
#
|
781
|
+
class ListDeviceResourcesOutput < Struct.new(
|
782
|
+
:next_token,
|
783
|
+
:resources)
|
784
|
+
SENSITIVE = []
|
785
|
+
include Aws::Structure
|
786
|
+
end
|
787
|
+
|
788
|
+
# @note When making an API call, you may pass ListDevicesInput
|
789
|
+
# data as a hash:
|
790
|
+
#
|
791
|
+
# {
|
792
|
+
# job_id: "JobId",
|
793
|
+
# max_results: 1,
|
794
|
+
# next_token: "NextToken",
|
795
|
+
# }
|
796
|
+
#
|
797
|
+
# @!attribute [rw] job_id
|
798
|
+
# The ID of the job used to order the device.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] max_results
|
802
|
+
# The maximum number of devices to list per page.
|
803
|
+
# @return [Integer]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] next_token
|
806
|
+
# A pagination token to continue to the next page of results.
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDevicesInput AWS API Documentation
|
810
|
+
#
|
811
|
+
class ListDevicesInput < Struct.new(
|
812
|
+
:job_id,
|
813
|
+
:max_results,
|
814
|
+
:next_token)
|
815
|
+
SENSITIVE = []
|
816
|
+
include Aws::Structure
|
817
|
+
end
|
818
|
+
|
819
|
+
# @!attribute [rw] devices
|
820
|
+
# A list of device structures that contain information about the
|
821
|
+
# device.
|
822
|
+
# @return [Array<Types::DeviceSummary>]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] next_token
|
825
|
+
# A pagination token to continue to the next page of devices.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDevicesOutput AWS API Documentation
|
829
|
+
#
|
830
|
+
class ListDevicesOutput < Struct.new(
|
831
|
+
:devices,
|
832
|
+
:next_token)
|
833
|
+
SENSITIVE = []
|
834
|
+
include Aws::Structure
|
835
|
+
end
|
836
|
+
|
837
|
+
# @note When making an API call, you may pass ListExecutionsInput
|
838
|
+
# data as a hash:
|
839
|
+
#
|
840
|
+
# {
|
841
|
+
# max_results: 1,
|
842
|
+
# next_token: "NextToken",
|
843
|
+
# state: "QUEUED", # accepts QUEUED, IN_PROGRESS, CANCELED, FAILED, SUCCEEDED, REJECTED, TIMED_OUT
|
844
|
+
# task_id: "TaskId", # required
|
845
|
+
# }
|
846
|
+
#
|
847
|
+
# @!attribute [rw] max_results
|
848
|
+
# The maximum number of tasks to list per page.
|
849
|
+
# @return [Integer]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] next_token
|
852
|
+
# A pagination token to continue to the next page of tasks.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
# @!attribute [rw] state
|
856
|
+
# A structure used to filter the tasks by their current state.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] task_id
|
860
|
+
# The ID of the task.
|
861
|
+
# @return [String]
|
862
|
+
#
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListExecutionsInput AWS API Documentation
|
864
|
+
#
|
865
|
+
class ListExecutionsInput < Struct.new(
|
866
|
+
:max_results,
|
867
|
+
:next_token,
|
868
|
+
:state,
|
869
|
+
:task_id)
|
870
|
+
SENSITIVE = []
|
871
|
+
include Aws::Structure
|
872
|
+
end
|
873
|
+
|
874
|
+
# @!attribute [rw] executions
|
875
|
+
# A list of executions. Each execution contains the task ID, the
|
876
|
+
# device that the task is executing on, the execution ID, and the
|
877
|
+
# status of the execution.
|
878
|
+
# @return [Array<Types::ExecutionSummary>]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] next_token
|
881
|
+
# A pagination token to continue to the next page of executions.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListExecutionsOutput AWS API Documentation
|
885
|
+
#
|
886
|
+
class ListExecutionsOutput < Struct.new(
|
887
|
+
:executions,
|
888
|
+
:next_token)
|
889
|
+
SENSITIVE = []
|
890
|
+
include Aws::Structure
|
891
|
+
end
|
892
|
+
|
893
|
+
# @note When making an API call, you may pass ListTagsForResourceInput
|
894
|
+
# data as a hash:
|
895
|
+
#
|
896
|
+
# {
|
897
|
+
# resource_arn: "String", # required
|
898
|
+
# }
|
899
|
+
#
|
900
|
+
# @!attribute [rw] resource_arn
|
901
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTagsForResourceInput AWS API Documentation
|
905
|
+
#
|
906
|
+
class ListTagsForResourceInput < Struct.new(
|
907
|
+
:resource_arn)
|
908
|
+
SENSITIVE = []
|
909
|
+
include Aws::Structure
|
910
|
+
end
|
911
|
+
|
912
|
+
# @!attribute [rw] tags
|
913
|
+
# The list of tags for the device or task.
|
914
|
+
# @return [Hash<String,String>]
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTagsForResourceOutput AWS API Documentation
|
917
|
+
#
|
918
|
+
class ListTagsForResourceOutput < Struct.new(
|
919
|
+
:tags)
|
920
|
+
SENSITIVE = []
|
921
|
+
include Aws::Structure
|
922
|
+
end
|
923
|
+
|
924
|
+
# @note When making an API call, you may pass ListTasksInput
|
925
|
+
# data as a hash:
|
926
|
+
#
|
927
|
+
# {
|
928
|
+
# max_results: 1,
|
929
|
+
# next_token: "NextToken",
|
930
|
+
# state: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED
|
931
|
+
# }
|
932
|
+
#
|
933
|
+
# @!attribute [rw] max_results
|
934
|
+
# The maximum number of tasks per page.
|
935
|
+
# @return [Integer]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] next_token
|
938
|
+
# A pagination token to continue to the next page of tasks.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] state
|
942
|
+
# A structure used to filter the list of tasks.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasksInput AWS API Documentation
|
946
|
+
#
|
947
|
+
class ListTasksInput < Struct.new(
|
948
|
+
:max_results,
|
949
|
+
:next_token,
|
950
|
+
:state)
|
951
|
+
SENSITIVE = []
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
955
|
+
# @!attribute [rw] next_token
|
956
|
+
# A pagination token to continue to the next page of tasks.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] tasks
|
960
|
+
# A list of task structures containing details about each task.
|
961
|
+
# @return [Array<Types::TaskSummary>]
|
962
|
+
#
|
963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasksOutput AWS API Documentation
|
964
|
+
#
|
965
|
+
class ListTasksOutput < Struct.new(
|
966
|
+
:next_token,
|
967
|
+
:tasks)
|
968
|
+
SENSITIVE = []
|
969
|
+
include Aws::Structure
|
970
|
+
end
|
971
|
+
|
972
|
+
# The details about the physical network interface for the device.
|
973
|
+
#
|
974
|
+
# @!attribute [rw] default_gateway
|
975
|
+
# The default gateway of the device.
|
976
|
+
# @return [String]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] ip_address
|
979
|
+
# The IP address of the device.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] ip_address_assignment
|
983
|
+
# A value that describes whether the IP address is dynamic or
|
984
|
+
# persistent.
|
985
|
+
# @return [String]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] mac_address
|
988
|
+
# The MAC address of the device.
|
989
|
+
# @return [String]
|
990
|
+
#
|
991
|
+
# @!attribute [rw] netmask
|
992
|
+
# The netmask used to divide the IP address into subnets.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] physical_connector_type
|
996
|
+
# The physical connector type.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] physical_network_interface_id
|
1000
|
+
# The physical network interface ID.
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
1003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/PhysicalNetworkInterface AWS API Documentation
|
1004
|
+
#
|
1005
|
+
class PhysicalNetworkInterface < Struct.new(
|
1006
|
+
:default_gateway,
|
1007
|
+
:ip_address,
|
1008
|
+
:ip_address_assignment,
|
1009
|
+
:mac_address,
|
1010
|
+
:netmask,
|
1011
|
+
:physical_connector_type,
|
1012
|
+
:physical_network_interface_id)
|
1013
|
+
SENSITIVE = []
|
1014
|
+
include Aws::Structure
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# A structure used to reboot the device.
|
1018
|
+
#
|
1019
|
+
# @api private
|
1020
|
+
#
|
1021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/Reboot AWS API Documentation
|
1022
|
+
#
|
1023
|
+
class Reboot < Aws::EmptyStructure; end
|
1024
|
+
|
1025
|
+
# The request references a resource that doesn't exist.
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] message
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
1030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ResourceNotFoundException AWS API Documentation
|
1031
|
+
#
|
1032
|
+
class ResourceNotFoundException < Struct.new(
|
1033
|
+
:message)
|
1034
|
+
SENSITIVE = []
|
1035
|
+
include Aws::Structure
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# A summary of a resource available on the device.
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] arn
|
1041
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] id
|
1045
|
+
# The ID of the resource.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] resource_type
|
1049
|
+
# The resource type.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ResourceSummary AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class ResourceSummary < Struct.new(
|
1055
|
+
:arn,
|
1056
|
+
:id,
|
1057
|
+
:resource_type)
|
1058
|
+
SENSITIVE = []
|
1059
|
+
include Aws::Structure
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
# Information about the device's security group.
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] group_id
|
1065
|
+
# The security group ID.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] group_name
|
1069
|
+
# The security group name.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/SecurityGroupIdentifier AWS API Documentation
|
1073
|
+
#
|
1074
|
+
class SecurityGroupIdentifier < Struct.new(
|
1075
|
+
:group_id,
|
1076
|
+
:group_name)
|
1077
|
+
SENSITIVE = []
|
1078
|
+
include Aws::Structure
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# The request would cause a service quota to be exceeded.
|
1082
|
+
#
|
1083
|
+
# @!attribute [rw] message
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ServiceQuotaExceededException AWS API Documentation
|
1087
|
+
#
|
1088
|
+
class ServiceQuotaExceededException < Struct.new(
|
1089
|
+
:message)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Information about the software on the device.
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] install_state
|
1097
|
+
# The state of the software that is installed or that is being
|
1098
|
+
# installed on the device.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] installed_version
|
1102
|
+
# The version of the software currently installed on the device.
|
1103
|
+
# @return [String]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] installing_version
|
1106
|
+
# The version of the software being installed on the device.
|
1107
|
+
# @return [String]
|
1108
|
+
#
|
1109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/SoftwareInformation AWS API Documentation
|
1110
|
+
#
|
1111
|
+
class SoftwareInformation < Struct.new(
|
1112
|
+
:install_state,
|
1113
|
+
:installed_version,
|
1114
|
+
:installing_version)
|
1115
|
+
SENSITIVE = []
|
1116
|
+
include Aws::Structure
|
1117
|
+
end
|
1118
|
+
|
1119
|
+
# @note When making an API call, you may pass TagResourceInput
|
1120
|
+
# data as a hash:
|
1121
|
+
#
|
1122
|
+
# {
|
1123
|
+
# resource_arn: "String", # required
|
1124
|
+
# tags: { # required
|
1125
|
+
# "String" => "String",
|
1126
|
+
# },
|
1127
|
+
# }
|
1128
|
+
#
|
1129
|
+
# @!attribute [rw] resource_arn
|
1130
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
1131
|
+
# @return [String]
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] tags
|
1134
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
1135
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
1136
|
+
# or environment.
|
1137
|
+
# @return [Hash<String,String>]
|
1138
|
+
#
|
1139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/TagResourceInput AWS API Documentation
|
1140
|
+
#
|
1141
|
+
class TagResourceInput < Struct.new(
|
1142
|
+
:resource_arn,
|
1143
|
+
:tags)
|
1144
|
+
SENSITIVE = []
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# Information about the task assigned to one or many devices.
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] state
|
1151
|
+
# The state of the task assigned to one or many devices.
|
1152
|
+
# @return [String]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] tags
|
1155
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
1156
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
1157
|
+
# or environment.
|
1158
|
+
# @return [Hash<String,String>]
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] task_arn
|
1161
|
+
# The Amazon Resource Name (ARN) of the task.
|
1162
|
+
# @return [String]
|
1163
|
+
#
|
1164
|
+
# @!attribute [rw] task_id
|
1165
|
+
# The task ID.
|
1166
|
+
# @return [String]
|
1167
|
+
#
|
1168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/TaskSummary AWS API Documentation
|
1169
|
+
#
|
1170
|
+
class TaskSummary < Struct.new(
|
1171
|
+
:state,
|
1172
|
+
:tags,
|
1173
|
+
:task_arn,
|
1174
|
+
:task_id)
|
1175
|
+
SENSITIVE = []
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# The request was denied due to request throttling.
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] message
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ThrottlingException AWS API Documentation
|
1185
|
+
#
|
1186
|
+
class ThrottlingException < Struct.new(
|
1187
|
+
:message)
|
1188
|
+
SENSITIVE = []
|
1189
|
+
include Aws::Structure
|
1190
|
+
end
|
1191
|
+
|
1192
|
+
# A structure used to unlock a device.
|
1193
|
+
#
|
1194
|
+
# @api private
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/Unlock AWS API Documentation
|
1197
|
+
#
|
1198
|
+
class Unlock < Aws::EmptyStructure; end
|
1199
|
+
|
1200
|
+
# @note When making an API call, you may pass UntagResourceInput
|
1201
|
+
# data as a hash:
|
1202
|
+
#
|
1203
|
+
# {
|
1204
|
+
# resource_arn: "String", # required
|
1205
|
+
# tag_keys: ["String"], # required
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] resource_arn
|
1209
|
+
# The Amazon Resource Name (ARN) of the device or task.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] tag_keys
|
1213
|
+
# Optional metadata that you assign to a resource. You can use tags to
|
1214
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
1215
|
+
# or environment.
|
1216
|
+
# @return [Array<String>]
|
1217
|
+
#
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/UntagResourceInput AWS API Documentation
|
1219
|
+
#
|
1220
|
+
class UntagResourceInput < Struct.new(
|
1221
|
+
:resource_arn,
|
1222
|
+
:tag_keys)
|
1223
|
+
SENSITIVE = []
|
1224
|
+
include Aws::Structure
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
1228
|
+
# Services service.
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] message
|
1231
|
+
# @return [String]
|
1232
|
+
#
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ValidationException AWS API Documentation
|
1234
|
+
#
|
1235
|
+
class ValidationException < Struct.new(
|
1236
|
+
:message)
|
1237
|
+
SENSITIVE = []
|
1238
|
+
include Aws::Structure
|
1239
|
+
end
|
1240
|
+
|
1241
|
+
end
|
1242
|
+
end
|