aws-sdk-licensemanagerlinuxsubscriptions 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,434 @@
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::LicenseManagerLinuxSubscriptions
11
+ module Types
12
+
13
+ # A filter object that is used to return more specific results from a
14
+ # describe operation. Filters can be used to match a set of resources by
15
+ # specific criteria.
16
+ #
17
+ # @!attribute [rw] name
18
+ # The type of name to filter by.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] operator
22
+ # An operator for filtering results.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] values
26
+ # One or more values for the name to filter by.
27
+ # @return [Array<String>]
28
+ #
29
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/Filter AWS API Documentation
30
+ #
31
+ class Filter < Struct.new(
32
+ :name,
33
+ :operator,
34
+ :values)
35
+ SENSITIVE = []
36
+ include Aws::Structure
37
+ end
38
+
39
+ # @api private
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/GetServiceSettingsRequest AWS API Documentation
42
+ #
43
+ class GetServiceSettingsRequest < Aws::EmptyStructure; end
44
+
45
+ # @!attribute [rw] home_regions
46
+ # The Region in which License Manager displays the aggregated data for
47
+ # Linux subscriptions.
48
+ # @return [Array<String>]
49
+ #
50
+ # @!attribute [rw] linux_subscriptions_discovery
51
+ # Lists if discovery has been enabled for Linux subscriptions.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] linux_subscriptions_discovery_settings
55
+ # Lists the settings defined for Linux subscriptions discovery. The
56
+ # settings include if Organizations integration has been enabled, and
57
+ # which Regions data will be aggregated from.
58
+ # @return [Types::LinuxSubscriptionsDiscoverySettings]
59
+ #
60
+ # @!attribute [rw] status
61
+ # Indicates the status of Linux subscriptions settings being applied.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] status_message
65
+ # A message which details the Linux subscriptions service settings
66
+ # current status.
67
+ # @return [Hash<String,String>]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/GetServiceSettingsResponse AWS API Documentation
70
+ #
71
+ class GetServiceSettingsResponse < Struct.new(
72
+ :home_regions,
73
+ :linux_subscriptions_discovery,
74
+ :linux_subscriptions_discovery_settings,
75
+ :status,
76
+ :status_message)
77
+ SENSITIVE = []
78
+ include Aws::Structure
79
+ end
80
+
81
+ # Details discovered information about a running instance using Linux
82
+ # subscriptions.
83
+ #
84
+ # @!attribute [rw] account_id
85
+ # The account ID which owns the instance.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] ami_id
89
+ # The AMI ID used to launch the instance.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] instance_id
93
+ # The instance ID of the resource.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] instance_type
97
+ # The instance type of the resource.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] last_updated_time
101
+ # The time in which the last discovery updated the instance details.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] product_code
105
+ # The product code for the instance. For more information, see [Usage
106
+ # operation values][1] in the *License Manager User Guide* .
107
+ #
108
+ #
109
+ #
110
+ # [1]: https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html
111
+ # @return [Array<String>]
112
+ #
113
+ # @!attribute [rw] region
114
+ # The Region the instance is running in.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] status
118
+ # The status of the instance.
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] subscription_name
122
+ # The name of the subscription being used by the instance.
123
+ # @return [String]
124
+ #
125
+ # @!attribute [rw] usage_operation
126
+ # The usage operation of the instance. For more information, see For
127
+ # more information, see [Usage operation values][1] in the *License
128
+ # Manager User Guide*.
129
+ #
130
+ #
131
+ #
132
+ # [1]: https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html
133
+ # @return [String]
134
+ #
135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/Instance AWS API Documentation
136
+ #
137
+ class Instance < Struct.new(
138
+ :account_id,
139
+ :ami_id,
140
+ :instance_id,
141
+ :instance_type,
142
+ :last_updated_time,
143
+ :product_code,
144
+ :region,
145
+ :status,
146
+ :subscription_name,
147
+ :usage_operation)
148
+ SENSITIVE = []
149
+ include Aws::Structure
150
+ end
151
+
152
+ # An exception occurred with the service.
153
+ #
154
+ # @!attribute [rw] message
155
+ # @return [String]
156
+ #
157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/InternalServerException AWS API Documentation
158
+ #
159
+ class InternalServerException < Struct.new(
160
+ :message)
161
+ SENSITIVE = []
162
+ include Aws::Structure
163
+ end
164
+
165
+ # Lists the settings defined for discovering Linux subscriptions.
166
+ #
167
+ # @!attribute [rw] organization_integration
168
+ # Details if you have enabled resource discovery across your accounts
169
+ # in Organizations.
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] source_regions
173
+ # The Regions in which to discover data for Linux subscriptions.
174
+ # @return [Array<String>]
175
+ #
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/LinuxSubscriptionsDiscoverySettings AWS API Documentation
177
+ #
178
+ class LinuxSubscriptionsDiscoverySettings < Struct.new(
179
+ :organization_integration,
180
+ :source_regions)
181
+ SENSITIVE = []
182
+ include Aws::Structure
183
+ end
184
+
185
+ # NextToken length limit is half of ddb accepted limit. Increase this
186
+ # limit if parameters in request increases.
187
+ #
188
+ # @!attribute [rw] filters
189
+ # An array of structures that you can use to filter the results to
190
+ # those that match one or more sets of key-value pairs that you
191
+ # specify. For example, you can filter by the name of `AmiID` with an
192
+ # optional operator to see subscriptions that match, partially match,
193
+ # or don't match a certain Amazon Machine Image (AMI) ID.
194
+ #
195
+ # The valid names for this filter are:
196
+ #
197
+ # * `AmiID`
198
+ #
199
+ # * `InstanceID`
200
+ #
201
+ # * `AccountID`
202
+ #
203
+ # * `Status`
204
+ #
205
+ # * `Region`
206
+ #
207
+ # * `UsageOperation`
208
+ #
209
+ # * `ProductCode`
210
+ #
211
+ # * `InstanceType`
212
+ #
213
+ # The valid Operators for this filter are:
214
+ #
215
+ # * `contains`
216
+ #
217
+ # * `equals`
218
+ #
219
+ # * `Notequal`
220
+ # @return [Array<Types::Filter>]
221
+ #
222
+ # @!attribute [rw] max_results
223
+ # Maximum number of results to return in a single call.
224
+ # @return [Integer]
225
+ #
226
+ # @!attribute [rw] next_token
227
+ # Token for the next set of results.
228
+ # @return [String]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionInstancesRequest AWS API Documentation
231
+ #
232
+ class ListLinuxSubscriptionInstancesRequest < Struct.new(
233
+ :filters,
234
+ :max_results,
235
+ :next_token)
236
+ SENSITIVE = []
237
+ include Aws::Structure
238
+ end
239
+
240
+ # @!attribute [rw] instances
241
+ # An array that contains instance objects.
242
+ # @return [Array<Types::Instance>]
243
+ #
244
+ # @!attribute [rw] next_token
245
+ # Token for the next set of results.
246
+ # @return [String]
247
+ #
248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionInstancesResponse AWS API Documentation
249
+ #
250
+ class ListLinuxSubscriptionInstancesResponse < Struct.new(
251
+ :instances,
252
+ :next_token)
253
+ SENSITIVE = []
254
+ include Aws::Structure
255
+ end
256
+
257
+ # NextToken length limit is half of ddb accepted limit. Increase this
258
+ # limit if parameters in request increases.
259
+ #
260
+ # @!attribute [rw] filters
261
+ # An array of structures that you can use to filter the results to
262
+ # those that match one or more sets of key-value pairs that you
263
+ # specify. For example, you can filter by the name of `Subscription`
264
+ # with an optional operator to see subscriptions that match, partially
265
+ # match, or don't match a certain subscription's name.
266
+ #
267
+ # The valid names for this filter are:
268
+ #
269
+ # * `Subscription`
270
+ #
271
+ # ^
272
+ #
273
+ # The valid Operators for this filter are:
274
+ #
275
+ # * `contains`
276
+ #
277
+ # * `equals`
278
+ #
279
+ # * `Notequal`
280
+ # @return [Array<Types::Filter>]
281
+ #
282
+ # @!attribute [rw] max_results
283
+ # Maximum number of results to return in a single call.
284
+ # @return [Integer]
285
+ #
286
+ # @!attribute [rw] next_token
287
+ # Token for the next set of results.
288
+ # @return [String]
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionsRequest AWS API Documentation
291
+ #
292
+ class ListLinuxSubscriptionsRequest < Struct.new(
293
+ :filters,
294
+ :max_results,
295
+ :next_token)
296
+ SENSITIVE = []
297
+ include Aws::Structure
298
+ end
299
+
300
+ # @!attribute [rw] next_token
301
+ # Token for the next set of results.
302
+ # @return [String]
303
+ #
304
+ # @!attribute [rw] subscriptions
305
+ # An array that contains subscription objects.
306
+ # @return [Array<Types::Subscription>]
307
+ #
308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionsResponse AWS API Documentation
309
+ #
310
+ class ListLinuxSubscriptionsResponse < Struct.new(
311
+ :next_token,
312
+ :subscriptions)
313
+ SENSITIVE = []
314
+ include Aws::Structure
315
+ end
316
+
317
+ # An object which details a discovered Linux subscription.
318
+ #
319
+ # @!attribute [rw] instance_count
320
+ # The total amount of running instances using this subscription.
321
+ # @return [Integer]
322
+ #
323
+ # @!attribute [rw] name
324
+ # The name of the subscription.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] type
328
+ # The type of subscription. The type can be subscription-included with
329
+ # Amazon EC2, Bring Your Own Subscription model (BYOS), or from the
330
+ # Amazon Web Services Marketplace. Certain subscriptions may use
331
+ # licensing from the Amazon Web Services Marketplace as well as OS
332
+ # licensing from Amazon EC2 or BYOS.
333
+ # @return [String]
334
+ #
335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/Subscription AWS API Documentation
336
+ #
337
+ class Subscription < Struct.new(
338
+ :instance_count,
339
+ :name,
340
+ :type)
341
+ SENSITIVE = []
342
+ include Aws::Structure
343
+ end
344
+
345
+ # The request was denied due to request throttling.
346
+ #
347
+ # @!attribute [rw] message
348
+ # @return [String]
349
+ #
350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ThrottlingException AWS API Documentation
351
+ #
352
+ class ThrottlingException < Struct.new(
353
+ :message)
354
+ SENSITIVE = []
355
+ include Aws::Structure
356
+ end
357
+
358
+ # @!attribute [rw] allow_update
359
+ # Describes if updates are allowed to the service settings for Linux
360
+ # subscriptions. If you allow updates, you can aggregate Linux
361
+ # subscription data in more than one home Region.
362
+ # @return [Boolean]
363
+ #
364
+ # @!attribute [rw] linux_subscriptions_discovery
365
+ # Describes if the discovery of Linux subscriptions is enabled.
366
+ # @return [String]
367
+ #
368
+ # @!attribute [rw] linux_subscriptions_discovery_settings
369
+ # The settings defined for Linux subscriptions discovery. The settings
370
+ # include if Organizations integration has been enabled, and which
371
+ # Regions data will be aggregated from.
372
+ # @return [Types::LinuxSubscriptionsDiscoverySettings]
373
+ #
374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/UpdateServiceSettingsRequest AWS API Documentation
375
+ #
376
+ class UpdateServiceSettingsRequest < Struct.new(
377
+ :allow_update,
378
+ :linux_subscriptions_discovery,
379
+ :linux_subscriptions_discovery_settings)
380
+ SENSITIVE = []
381
+ include Aws::Structure
382
+ end
383
+
384
+ # @!attribute [rw] home_regions
385
+ # The Region in which License Manager displays the aggregated data for
386
+ # Linux subscriptions.
387
+ # @return [Array<String>]
388
+ #
389
+ # @!attribute [rw] linux_subscriptions_discovery
390
+ # Lists if discovery has been enabled for Linux subscriptions.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] linux_subscriptions_discovery_settings
394
+ # The settings defined for Linux subscriptions discovery. The settings
395
+ # include if Organizations integration has been enabled, and which
396
+ # Regions data will be aggregated from.
397
+ # @return [Types::LinuxSubscriptionsDiscoverySettings]
398
+ #
399
+ # @!attribute [rw] status
400
+ # Indicates the status of Linux subscriptions settings being applied.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] status_message
404
+ # A message which details the Linux subscriptions service settings
405
+ # current status.
406
+ # @return [Hash<String,String>]
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/UpdateServiceSettingsResponse AWS API Documentation
409
+ #
410
+ class UpdateServiceSettingsResponse < Struct.new(
411
+ :home_regions,
412
+ :linux_subscriptions_discovery,
413
+ :linux_subscriptions_discovery_settings,
414
+ :status,
415
+ :status_message)
416
+ SENSITIVE = []
417
+ include Aws::Structure
418
+ end
419
+
420
+ # The provided input is not valid. Try your request again.
421
+ #
422
+ # @!attribute [rw] message
423
+ # @return [String]
424
+ #
425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ValidationException AWS API Documentation
426
+ #
427
+ class ValidationException < Struct.new(
428
+ :message)
429
+ SENSITIVE = []
430
+ include Aws::Structure
431
+ end
432
+
433
+ end
434
+ end
@@ -0,0 +1,57 @@
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-licensemanagerlinuxsubscriptions/types'
15
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/client_api'
16
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/plugins/endpoints.rb'
17
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/client'
18
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/errors'
19
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/resource'
20
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/endpoint_parameters'
21
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/endpoint_provider'
22
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/endpoints'
23
+ require_relative 'aws-sdk-licensemanagerlinuxsubscriptions/customizations'
24
+
25
+ # This module provides support for AWS License Manager Linux Subscriptions. This module is available in the
26
+ # `aws-sdk-licensemanagerlinuxsubscriptions` gem.
27
+ #
28
+ # # Client
29
+ #
30
+ # The {Client} class provides one method for each API operation. Operation
31
+ # methods each accept a hash of request parameters and return a response
32
+ # structure.
33
+ #
34
+ # license_manager_linux_subscriptions = Aws::LicenseManagerLinuxSubscriptions::Client.new
35
+ # resp = license_manager_linux_subscriptions.get_service_settings(params)
36
+ #
37
+ # See {Client} for more information.
38
+ #
39
+ # # Errors
40
+ #
41
+ # Errors returned from AWS License Manager Linux Subscriptions are defined in the
42
+ # {Errors} module and all extend {Errors::ServiceError}.
43
+ #
44
+ # begin
45
+ # # do stuff
46
+ # rescue Aws::LicenseManagerLinuxSubscriptions::Errors::ServiceError
47
+ # # rescues all AWS License Manager Linux Subscriptions API errors
48
+ # end
49
+ #
50
+ # See {Errors} for more information.
51
+ #
52
+ # @!group service
53
+ module Aws::LicenseManagerLinuxSubscriptions
54
+
55
+ GEM_VERSION = '1.0.0'
56
+
57
+ end
metadata ADDED
@@ -0,0 +1,94 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-licensemanagerlinuxsubscriptions
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-12-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.165.0
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.165.0
33
+ - !ruby/object:Gem::Dependency
34
+ name: aws-sigv4
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.1'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.1'
47
+ description: Official AWS Ruby gem for AWS License Manager Linux Subscriptions. This
48
+ gem is part of the AWS SDK for Ruby.
49
+ email:
50
+ - aws-dr-rubygems@amazon.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files: []
54
+ files:
55
+ - CHANGELOG.md
56
+ - LICENSE.txt
57
+ - VERSION
58
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions.rb
59
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb
60
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/client_api.rb
61
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/customizations.rb
62
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/endpoint_parameters.rb
63
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/endpoint_provider.rb
64
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/endpoints.rb
65
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/errors.rb
66
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/plugins/endpoints.rb
67
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/resource.rb
68
+ - lib/aws-sdk-licensemanagerlinuxsubscriptions/types.rb
69
+ homepage: https://github.com/aws/aws-sdk-ruby
70
+ licenses:
71
+ - Apache-2.0
72
+ metadata:
73
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-licensemanagerlinuxsubscriptions
74
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-licensemanagerlinuxsubscriptions/CHANGELOG.md
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '2.3'
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ requirements: []
90
+ rubygems_version: 3.1.6
91
+ signing_key:
92
+ specification_version: 4
93
+ summary: AWS SDK for Ruby - AWS License Manager Linux Subscriptions
94
+ test_files: []