aws-sdk-account 1.8.0 → 1.10.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.
@@ -59,27 +59,25 @@ module Aws::Account
59
59
  include Aws::Structure
60
60
  end
61
61
 
62
+ # The request could not be processed because of a conflict in the
63
+ # current status of the resource. For example, this happens if you try
64
+ # to enable a Region that is currently being disabled (in a status of
65
+ # DISABLING).
66
+ #
67
+ # @!attribute [rw] message
68
+ # @return [String]
69
+ #
70
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ConflictException AWS API Documentation
71
+ #
72
+ class ConflictException < Struct.new(
73
+ :message)
74
+ SENSITIVE = []
75
+ include Aws::Structure
76
+ end
77
+
62
78
  # Contains the details of the primary contact information associated
63
79
  # with an Amazon Web Services account.
64
80
  #
65
- # @note When making an API call, you may pass ContactInformation
66
- # data as a hash:
67
- #
68
- # {
69
- # address_line_1: "AddressLine", # required
70
- # address_line_2: "AddressLine",
71
- # address_line_3: "AddressLine",
72
- # city: "City", # required
73
- # company_name: "CompanyName",
74
- # country_code: "CountryCode", # required
75
- # district_or_county: "DistrictOrCounty",
76
- # full_name: "FullName", # required
77
- # phone_number: "ContactInformationPhoneNumber", # required
78
- # postal_code: "PostalCode", # required
79
- # state_or_region: "StateOrRegion",
80
- # website_url: "WebsiteUrl",
81
- # }
82
- #
83
81
  # @!attribute [rw] address_line_1
84
82
  # The first line of the primary contact address.
85
83
  # @return [String]
@@ -152,14 +150,6 @@ module Aws::Account
152
150
  include Aws::Structure
153
151
  end
154
152
 
155
- # @note When making an API call, you may pass DeleteAlternateContactRequest
156
- # data as a hash:
157
- #
158
- # {
159
- # account_id: "AccountId",
160
- # alternate_contact_type: "BILLING", # required, accepts BILLING, OPERATIONS, SECURITY
161
- # }
162
- #
163
153
  # @!attribute [rw] account_id
164
154
  # Specifies the 12 digit account ID number of the Amazon Web Services
165
155
  # account that you want to access or modify with this operation.
@@ -207,14 +197,107 @@ module Aws::Account
207
197
  include Aws::Structure
208
198
  end
209
199
 
210
- # @note When making an API call, you may pass GetAlternateContactRequest
211
- # data as a hash:
200
+ # @!attribute [rw] account_id
201
+ # Specifies the 12-digit account ID number of the Amazon Web Services
202
+ # account that you want to access or modify with this operation. If
203
+ # you don't specify this parameter, it defaults to the Amazon Web
204
+ # Services account of the identity used to call the operation. To use
205
+ # this parameter, the caller must be an identity in the
206
+ # [organization's management account][1] or a delegated administrator
207
+ # account. The specified account ID must also be a member account in
208
+ # the same organization. The organization must have [all features
209
+ # enabled][2], and the organization must have [trusted access][3]
210
+ # enabled for the Account Management service, and optionally a
211
+ # [delegated admin][4] account assigned.
212
+ #
213
+ # <note markdown="1"> The management account can't specify its own `AccountId`. It must
214
+ # call the operation in standalone context by not including the
215
+ # `AccountId` parameter.
216
+ #
217
+ # </note>
218
+ #
219
+ # To call this operation on an account that is not a member of an
220
+ # organization, don't specify this parameter. Instead, call the
221
+ # operation using an identity belonging to the account whose contacts
222
+ # you wish to retrieve or modify.
223
+ #
224
+ #
225
+ #
226
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
227
+ # [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
228
+ # [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
229
+ # [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] region_name
233
+ # Specifies the Region-code for a given Region name (for example,
234
+ # `af-south-1`). When you disable a Region, AWS performs actions to
235
+ # deactivate that Region in your account, such as destroying IAM
236
+ # resources in the Region. This process takes a few minutes for most
237
+ # accounts, but this can take several hours. You cannot enable the
238
+ # Region until the disabling process is fully completed.
239
+ # @return [String]
240
+ #
241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DisableRegionRequest AWS API Documentation
242
+ #
243
+ class DisableRegionRequest < Struct.new(
244
+ :account_id,
245
+ :region_name)
246
+ SENSITIVE = []
247
+ include Aws::Structure
248
+ end
249
+
250
+ # @!attribute [rw] account_id
251
+ # Specifies the 12-digit account ID number of the Amazon Web Services
252
+ # account that you want to access or modify with this operation. If
253
+ # you don't specify this parameter, it defaults to the Amazon Web
254
+ # Services account of the identity used to call the operation. To use
255
+ # this parameter, the caller must be an identity in the
256
+ # [organization's management account][1] or a delegated administrator
257
+ # account. The specified account ID must also be a member account in
258
+ # the same organization. The organization must have [all features
259
+ # enabled][2], and the organization must have [trusted access][3]
260
+ # enabled for the Account Management service, and optionally a
261
+ # [delegated admin][4] account assigned.
262
+ #
263
+ # <note markdown="1"> The management account can't specify its own `AccountId`. It must
264
+ # call the operation in standalone context by not including the
265
+ # `AccountId` parameter.
266
+ #
267
+ # </note>
268
+ #
269
+ # To call this operation on an account that is not a member of an
270
+ # organization, don't specify this parameter. Instead, call the
271
+ # operation using an identity belonging to the account whose contacts
272
+ # you wish to retrieve or modify.
273
+ #
274
+ #
275
+ #
276
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
277
+ # [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
278
+ # [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
279
+ # [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
280
+ # @return [String]
212
281
  #
213
- # {
214
- # account_id: "AccountId",
215
- # alternate_contact_type: "BILLING", # required, accepts BILLING, OPERATIONS, SECURITY
216
- # }
282
+ # @!attribute [rw] region_name
283
+ # Specifies the Region-code for a given Region name (for example,
284
+ # `af-south-1`). When you enable a Region, AWS performs actions to
285
+ # prepare your account in that Region, such as distributing your IAM
286
+ # resources to the Region. This process takes a few minutes for most
287
+ # accounts, but it can take several hours. You cannot use the Region
288
+ # until this process is complete. Furthermore, you cannot disable the
289
+ # Region until the enabling process is fully completed.
290
+ # @return [String]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/EnableRegionRequest AWS API Documentation
217
293
  #
294
+ class EnableRegionRequest < Struct.new(
295
+ :account_id,
296
+ :region_name)
297
+ SENSITIVE = []
298
+ include Aws::Structure
299
+ end
300
+
218
301
  # @!attribute [rw] account_id
219
302
  # Specifies the 12 digit account ID number of the Amazon Web Services
220
303
  # account that you want to access or modify with this operation.
@@ -275,13 +358,6 @@ module Aws::Account
275
358
  include Aws::Structure
276
359
  end
277
360
 
278
- # @note When making an API call, you may pass GetContactInformationRequest
279
- # data as a hash:
280
- #
281
- # {
282
- # account_id: "AccountId",
283
- # }
284
- #
285
361
  # @!attribute [rw] account_id
286
362
  # Specifies the 12-digit account ID number of the Amazon Web Services
287
363
  # account that you want to access or modify with this operation. If
@@ -335,6 +411,71 @@ module Aws::Account
335
411
  include Aws::Structure
336
412
  end
337
413
 
414
+ # @!attribute [rw] account_id
415
+ # Specifies the 12-digit account ID number of the Amazon Web Services
416
+ # account that you want to access or modify with this operation. If
417
+ # you don't specify this parameter, it defaults to the Amazon Web
418
+ # Services account of the identity used to call the operation. To use
419
+ # this parameter, the caller must be an identity in the
420
+ # [organization's management account][1] or a delegated administrator
421
+ # account. The specified account ID must also be a member account in
422
+ # the same organization. The organization must have [all features
423
+ # enabled][2], and the organization must have [trusted access][3]
424
+ # enabled for the Account Management service, and optionally a
425
+ # [delegated admin][4] account assigned.
426
+ #
427
+ # <note markdown="1"> The management account can't specify its own `AccountId`. It must
428
+ # call the operation in standalone context by not including the
429
+ # `AccountId` parameter.
430
+ #
431
+ # </note>
432
+ #
433
+ # To call this operation on an account that is not a member of an
434
+ # organization, don't specify this parameter. Instead, call the
435
+ # operation using an identity belonging to the account whose contacts
436
+ # you wish to retrieve or modify.
437
+ #
438
+ #
439
+ #
440
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
441
+ # [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
442
+ # [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
443
+ # [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] region_name
447
+ # Specifies the Region-code for a given Region name (for example,
448
+ # `af-south-1`). This function will return the status of whatever
449
+ # Region you pass into this parameter.
450
+ # @return [String]
451
+ #
452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetRegionOptStatusRequest AWS API Documentation
453
+ #
454
+ class GetRegionOptStatusRequest < Struct.new(
455
+ :account_id,
456
+ :region_name)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @!attribute [rw] region_name
462
+ # The Region code that was passed in.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] region_opt_status
466
+ # One of the potential statuses a Region can undergo (Enabled,
467
+ # Enabling, Disabled, Disabling, Enabled\_By\_Default).
468
+ # @return [String]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetRegionOptStatusResponse AWS API Documentation
471
+ #
472
+ class GetRegionOptStatusResponse < Struct.new(
473
+ :region_name,
474
+ :region_opt_status)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
338
479
  # The operation failed because of an error internal to Amazon Web
339
480
  # Services. Try your operation again later.
340
481
  #
@@ -349,18 +490,103 @@ module Aws::Account
349
490
  include Aws::Structure
350
491
  end
351
492
 
352
- # @note When making an API call, you may pass PutAlternateContactRequest
353
- # data as a hash:
354
- #
355
- # {
356
- # account_id: "AccountId",
357
- # alternate_contact_type: "BILLING", # required, accepts BILLING, OPERATIONS, SECURITY
358
- # email_address: "EmailAddress", # required
359
- # name: "Name", # required
360
- # phone_number: "PhoneNumber", # required
361
- # title: "Title", # required
362
- # }
493
+ # @!attribute [rw] account_id
494
+ # Specifies the 12-digit account ID number of the Amazon Web Services
495
+ # account that you want to access or modify with this operation. If
496
+ # you don't specify this parameter, it defaults to the Amazon Web
497
+ # Services account of the identity used to call the operation. To use
498
+ # this parameter, the caller must be an identity in the
499
+ # [organization's management account][1] or a delegated administrator
500
+ # account. The specified account ID must also be a member account in
501
+ # the same organization. The organization must have [all features
502
+ # enabled][2], and the organization must have [trusted access][3]
503
+ # enabled for the Account Management service, and optionally a
504
+ # [delegated admin][4] account assigned.
505
+ #
506
+ # <note markdown="1"> The management account can't specify its own `AccountId`. It must
507
+ # call the operation in standalone context by not including the
508
+ # `AccountId` parameter.
509
+ #
510
+ # </note>
511
+ #
512
+ # To call this operation on an account that is not a member of an
513
+ # organization, don't specify this parameter. Instead, call the
514
+ # operation using an identity belonging to the account whose contacts
515
+ # you wish to retrieve or modify.
516
+ #
517
+ #
518
+ #
519
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
520
+ # [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
521
+ # [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
522
+ # [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] max_results
526
+ # The total number of items to return in the command’s output. If the
527
+ # total number of items available is more than the value specified, a
528
+ # `NextToken` is provided in the command’s output. To resume
529
+ # pagination, provide the `NextToken` value in the `starting-token`
530
+ # argument of a subsequent command. Do not use the `NextToken`
531
+ # response element directly outside of the Amazon Web Services CLI.
532
+ # For usage examples, see [Pagination][1] in the *Amazon Web Services
533
+ # Command Line Interface User Guide*.
534
+ #
535
+ #
536
+ #
537
+ # [1]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html
538
+ # @return [Integer]
539
+ #
540
+ # @!attribute [rw] next_token
541
+ # A token used to specify where to start paginating. This is the
542
+ # `NextToken` from a previously truncated response. For usage
543
+ # examples, see [Pagination][1] in the *Amazon Web Services Command
544
+ # Line Interface User Guide*.
545
+ #
546
+ #
547
+ #
548
+ # [1]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html
549
+ # @return [String]
550
+ #
551
+ # @!attribute [rw] region_opt_status_contains
552
+ # A list of Region statuses (Enabling, Enabled, Disabling, Disabled,
553
+ # Enabled\_by\_default) to use to filter the list of Regions for a
554
+ # given account. For example, passing in a value of ENABLING will only
555
+ # return a list of Regions with a Region status of ENABLING.
556
+ # @return [Array<String>]
557
+ #
558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ListRegionsRequest AWS API Documentation
559
+ #
560
+ class ListRegionsRequest < Struct.new(
561
+ :account_id,
562
+ :max_results,
563
+ :next_token,
564
+ :region_opt_status_contains)
565
+ SENSITIVE = []
566
+ include Aws::Structure
567
+ end
568
+
569
+ # @!attribute [rw] next_token
570
+ # If there is more data to be returned, this will be populated. It
571
+ # should be passed into the `next-token` request parameter of
572
+ # `list-regions`.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] regions
576
+ # This is a list of Regions for a given account, or if the filtered
577
+ # parameter was used, a list of Regions that match the filter criteria
578
+ # set in the `filter` parameter.
579
+ # @return [Array<Types::Region>]
580
+ #
581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ListRegionsResponse AWS API Documentation
363
582
  #
583
+ class ListRegionsResponse < Struct.new(
584
+ :next_token,
585
+ :regions)
586
+ SENSITIVE = []
587
+ include Aws::Structure
588
+ end
589
+
364
590
  # @!attribute [rw] account_id
365
591
  # Specifies the 12 digit account ID number of the Amazon Web Services
366
592
  # account that you want to access or modify with this operation.
@@ -428,27 +654,6 @@ module Aws::Account
428
654
  include Aws::Structure
429
655
  end
430
656
 
431
- # @note When making an API call, you may pass PutContactInformationRequest
432
- # data as a hash:
433
- #
434
- # {
435
- # account_id: "AccountId",
436
- # contact_information: { # required
437
- # address_line_1: "AddressLine", # required
438
- # address_line_2: "AddressLine",
439
- # address_line_3: "AddressLine",
440
- # city: "City", # required
441
- # company_name: "CompanyName",
442
- # country_code: "CountryCode", # required
443
- # district_or_county: "DistrictOrCounty",
444
- # full_name: "FullName", # required
445
- # phone_number: "ContactInformationPhoneNumber", # required
446
- # postal_code: "PostalCode", # required
447
- # state_or_region: "StateOrRegion",
448
- # website_url: "WebsiteUrl",
449
- # },
450
- # }
451
- #
452
657
  # @!attribute [rw] account_id
453
658
  # Specifies the 12-digit account ID number of the Amazon Web Services
454
659
  # account that you want to access or modify with this operation. If
@@ -495,6 +700,27 @@ module Aws::Account
495
700
  include Aws::Structure
496
701
  end
497
702
 
703
+ # This is a structure that expresses the Region for a given account,
704
+ # consisting of a name and opt-in status.
705
+ #
706
+ # @!attribute [rw] region_name
707
+ # The Region code of a given Region (for example, `us-east-1`).
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] region_opt_status
711
+ # One of potential statuses a Region can undergo (Enabled, Enabling,
712
+ # Disabled, Disabling, Enabled\_By\_Default).
713
+ # @return [String]
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/Region AWS API Documentation
716
+ #
717
+ class Region < Struct.new(
718
+ :region_name,
719
+ :region_opt_status)
720
+ SENSITIVE = []
721
+ include Aws::Structure
722
+ end
723
+
498
724
  # The operation failed because it specified a resource that can't be
499
725
  # found.
500
726
  #
@@ -525,14 +751,46 @@ module Aws::Account
525
751
 
526
752
  # The operation failed because one of the input parameters was invalid.
527
753
  #
754
+ # @!attribute [rw] field_list
755
+ # The field where the invalid entry was detected.
756
+ # @return [Array<Types::ValidationExceptionField>]
757
+ #
528
758
  # @!attribute [rw] message
759
+ # The message that informs you about what was invalid about the
760
+ # request.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] reason
764
+ # The reason that validation failed.
529
765
  # @return [String]
530
766
  #
531
767
  # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ValidationException AWS API Documentation
532
768
  #
533
769
  class ValidationException < Struct.new(
534
- :message)
535
- SENSITIVE = []
770
+ :field_list,
771
+ :message,
772
+ :reason)
773
+ SENSITIVE = [:message]
774
+ include Aws::Structure
775
+ end
776
+
777
+ # The input failed to meet the constraints specified by the AWS service
778
+ # in a specified field.
779
+ #
780
+ # @!attribute [rw] message
781
+ # A message about the validation exception.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] name
785
+ # The field name where the invalid entry was detected.
786
+ # @return [String]
787
+ #
788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ValidationExceptionField AWS API Documentation
789
+ #
790
+ class ValidationExceptionField < Struct.new(
791
+ :message,
792
+ :name)
793
+ SENSITIVE = [:message]
536
794
  include Aws::Structure
537
795
  end
538
796
 
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-account/customizations'
52
52
  # @!group service
53
53
  module Aws::Account
54
54
 
55
- GEM_VERSION = '1.8.0'
55
+ GEM_VERSION = '1.10.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-account
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 1.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-25 00:00:00.000000000 Z
11
+ date: 2023-02-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core