aws-sdk-organizations 1.48.0 → 1.53.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 +4 -4
- data/lib/aws-sdk-organizations.rb +3 -2
- data/lib/aws-sdk-organizations/client.rb +327 -82
- data/lib/aws-sdk-organizations/client_api.rb +6 -0
- data/lib/aws-sdk-organizations/types.rb +279 -70
- metadata +4 -4
@@ -312,6 +312,7 @@ module Aws::Organizations
|
|
312
312
|
CreateAccountRequest.add_member(:account_name, Shapes::ShapeRef.new(shape: AccountName, required: true, location_name: "AccountName"))
|
313
313
|
CreateAccountRequest.add_member(:role_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "RoleName"))
|
314
314
|
CreateAccountRequest.add_member(:iam_user_access_to_billing, Shapes::ShapeRef.new(shape: IAMUserAccessToBilling, location_name: "IamUserAccessToBilling"))
|
315
|
+
CreateAccountRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
315
316
|
CreateAccountRequest.struct_class = Types::CreateAccountRequest
|
316
317
|
|
317
318
|
CreateAccountResponse.add_member(:create_account_status, Shapes::ShapeRef.new(shape: CreateAccountStatus, location_name: "CreateAccountStatus"))
|
@@ -338,6 +339,7 @@ module Aws::Organizations
|
|
338
339
|
CreateGovCloudAccountRequest.add_member(:account_name, Shapes::ShapeRef.new(shape: AccountName, required: true, location_name: "AccountName"))
|
339
340
|
CreateGovCloudAccountRequest.add_member(:role_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "RoleName"))
|
340
341
|
CreateGovCloudAccountRequest.add_member(:iam_user_access_to_billing, Shapes::ShapeRef.new(shape: IAMUserAccessToBilling, location_name: "IamUserAccessToBilling"))
|
342
|
+
CreateGovCloudAccountRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
341
343
|
CreateGovCloudAccountRequest.struct_class = Types::CreateGovCloudAccountRequest
|
342
344
|
|
343
345
|
CreateGovCloudAccountResponse.add_member(:create_account_status, Shapes::ShapeRef.new(shape: CreateAccountStatus, location_name: "CreateAccountStatus"))
|
@@ -351,6 +353,7 @@ module Aws::Organizations
|
|
351
353
|
|
352
354
|
CreateOrganizationalUnitRequest.add_member(:parent_id, Shapes::ShapeRef.new(shape: ParentId, required: true, location_name: "ParentId"))
|
353
355
|
CreateOrganizationalUnitRequest.add_member(:name, Shapes::ShapeRef.new(shape: OrganizationalUnitName, required: true, location_name: "Name"))
|
356
|
+
CreateOrganizationalUnitRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
354
357
|
CreateOrganizationalUnitRequest.struct_class = Types::CreateOrganizationalUnitRequest
|
355
358
|
|
356
359
|
CreateOrganizationalUnitResponse.add_member(:organizational_unit, Shapes::ShapeRef.new(shape: OrganizationalUnit, location_name: "OrganizationalUnit"))
|
@@ -360,6 +363,7 @@ module Aws::Organizations
|
|
360
363
|
CreatePolicyRequest.add_member(:description, Shapes::ShapeRef.new(shape: PolicyDescription, required: true, location_name: "Description"))
|
361
364
|
CreatePolicyRequest.add_member(:name, Shapes::ShapeRef.new(shape: PolicyName, required: true, location_name: "Name"))
|
362
365
|
CreatePolicyRequest.add_member(:type, Shapes::ShapeRef.new(shape: PolicyType, required: true, location_name: "Type"))
|
366
|
+
CreatePolicyRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
363
367
|
CreatePolicyRequest.struct_class = Types::CreatePolicyRequest
|
364
368
|
|
365
369
|
CreatePolicyResponse.add_member(:policy, Shapes::ShapeRef.new(shape: Policy, location_name: "Policy"))
|
@@ -552,6 +556,7 @@ module Aws::Organizations
|
|
552
556
|
|
553
557
|
InviteAccountToOrganizationRequest.add_member(:target, Shapes::ShapeRef.new(shape: HandshakeParty, required: true, location_name: "Target"))
|
554
558
|
InviteAccountToOrganizationRequest.add_member(:notes, Shapes::ShapeRef.new(shape: HandshakeNotes, location_name: "Notes"))
|
559
|
+
InviteAccountToOrganizationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
555
560
|
InviteAccountToOrganizationRequest.struct_class = Types::InviteAccountToOrganizationRequest
|
556
561
|
|
557
562
|
InviteAccountToOrganizationResponse.add_member(:handshake, Shapes::ShapeRef.new(shape: Handshake, location_name: "Handshake"))
|
@@ -1322,6 +1327,7 @@ module Aws::Organizations
|
|
1322
1327
|
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
1323
1328
|
o.errors << Shapes::ShapeRef.new(shape: HandshakeConstraintViolationException)
|
1324
1329
|
o.errors << Shapes::ShapeRef.new(shape: DuplicateHandshakeException)
|
1330
|
+
o.errors << Shapes::ShapeRef.new(shape: ConstraintViolationException)
|
1325
1331
|
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1326
1332
|
o.errors << Shapes::ShapeRef.new(shape: FinalizingOrganizationException)
|
1327
1333
|
o.errors << Shapes::ShapeRef.new(shape: ServiceException)
|
@@ -358,13 +358,13 @@ module Aws::Organizations
|
|
358
358
|
# The [regex pattern][1] for a child ID string requires one of the
|
359
359
|
# following:
|
360
360
|
#
|
361
|
-
# * Account
|
361
|
+
# * **Account** - A string that consists of exactly 12 digits.
|
362
362
|
#
|
363
|
-
# * Organizational unit (OU)
|
364
|
-
# followed by from 4 to 32
|
363
|
+
# * **Organizational unit (OU)** - A string that begins with "ou-"
|
364
|
+
# followed by from 4 to 32 lowercase letters or digits (the ID of
|
365
365
|
# the root that contains the OU). This string is followed by a
|
366
|
-
# second "-" dash and from 8 to 32 additional
|
367
|
-
#
|
366
|
+
# second "-" dash and from 8 to 32 additional lowercase letters or
|
367
|
+
# digits.
|
368
368
|
#
|
369
369
|
#
|
370
370
|
#
|
@@ -597,6 +597,12 @@ module Aws::Organizations
|
|
597
597
|
# account_name: "AccountName", # required
|
598
598
|
# role_name: "RoleName",
|
599
599
|
# iam_user_access_to_billing: "ALLOW", # accepts ALLOW, DENY
|
600
|
+
# tags: [
|
601
|
+
# {
|
602
|
+
# key: "TagKey", # required
|
603
|
+
# value: "TagValue", # required
|
604
|
+
# },
|
605
|
+
# ],
|
600
606
|
# }
|
601
607
|
#
|
602
608
|
# @!attribute [rw] email
|
@@ -660,13 +666,32 @@ module Aws::Organizations
|
|
660
666
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate
|
661
667
|
# @return [String]
|
662
668
|
#
|
669
|
+
# @!attribute [rw] tags
|
670
|
+
# A list of tags that you want to attach to the newly created account.
|
671
|
+
# For each tag in the list, you must specify both a tag key and a
|
672
|
+
# value. You can set the value to an empty string, but you can't set
|
673
|
+
# it to `null`. For more information about tagging, see [Tagging AWS
|
674
|
+
# Organizations resources][1] in the AWS Organizations User Guide.
|
675
|
+
#
|
676
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
677
|
+
# number of tags for an account, then the entire request fails and the
|
678
|
+
# account is not created.
|
679
|
+
#
|
680
|
+
# </note>
|
681
|
+
#
|
682
|
+
#
|
683
|
+
#
|
684
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
|
685
|
+
# @return [Array<Types::Tag>]
|
686
|
+
#
|
663
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/CreateAccountRequest AWS API Documentation
|
664
688
|
#
|
665
689
|
class CreateAccountRequest < Struct.new(
|
666
690
|
:email,
|
667
691
|
:account_name,
|
668
692
|
:role_name,
|
669
|
-
:iam_user_access_to_billing
|
693
|
+
:iam_user_access_to_billing,
|
694
|
+
:tags)
|
670
695
|
SENSITIVE = [:email, :account_name]
|
671
696
|
include Aws::Structure
|
672
697
|
end
|
@@ -705,7 +730,7 @@ module Aws::Organizations
|
|
705
730
|
# create the account.
|
706
731
|
#
|
707
732
|
# The [regex pattern][1] for a create account request ID string
|
708
|
-
# requires "car-" followed by from 8 to 32
|
733
|
+
# requires "car-" followed by from 8 to 32 lowercase letters or
|
709
734
|
# digits.
|
710
735
|
#
|
711
736
|
#
|
@@ -819,6 +844,12 @@ module Aws::Organizations
|
|
819
844
|
# account_name: "AccountName", # required
|
820
845
|
# role_name: "RoleName",
|
821
846
|
# iam_user_access_to_billing: "ALLOW", # accepts ALLOW, DENY
|
847
|
+
# tags: [
|
848
|
+
# {
|
849
|
+
# key: "TagKey", # required
|
850
|
+
# value: "TagValue", # required
|
851
|
+
# },
|
852
|
+
# ],
|
822
853
|
# }
|
823
854
|
#
|
824
855
|
# @!attribute [rw] email
|
@@ -885,13 +916,37 @@ module Aws::Organizations
|
|
885
916
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate
|
886
917
|
# @return [String]
|
887
918
|
#
|
919
|
+
# @!attribute [rw] tags
|
920
|
+
# A list of tags that you want to attach to the newly created account.
|
921
|
+
# These tags are attached to the commercial account associated with
|
922
|
+
# the GovCloud account, and not to the GovCloud account itself. To add
|
923
|
+
# tags to the actual GovCloud account, call the TagResource operation
|
924
|
+
# in the GovCloud region after the new GovCloud account exists.
|
925
|
+
#
|
926
|
+
# For each tag in the list, you must specify both a tag key and a
|
927
|
+
# value. You can set the value to an empty string, but you can't set
|
928
|
+
# it to `null`. For more information about tagging, see [Tagging AWS
|
929
|
+
# Organizations resources][1] in the AWS Organizations User Guide.
|
930
|
+
#
|
931
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
932
|
+
# number of tags for an account, then the entire request fails and the
|
933
|
+
# account is not created.
|
934
|
+
#
|
935
|
+
# </note>
|
936
|
+
#
|
937
|
+
#
|
938
|
+
#
|
939
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
|
940
|
+
# @return [Array<Types::Tag>]
|
941
|
+
#
|
888
942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/CreateGovCloudAccountRequest AWS API Documentation
|
889
943
|
#
|
890
944
|
class CreateGovCloudAccountRequest < Struct.new(
|
891
945
|
:email,
|
892
946
|
:account_name,
|
893
947
|
:role_name,
|
894
|
-
:iam_user_access_to_billing
|
948
|
+
:iam_user_access_to_billing,
|
949
|
+
:tags)
|
895
950
|
SENSITIVE = [:email, :account_name]
|
896
951
|
include Aws::Structure
|
897
952
|
end
|
@@ -968,6 +1023,12 @@ module Aws::Organizations
|
|
968
1023
|
# {
|
969
1024
|
# parent_id: "ParentId", # required
|
970
1025
|
# name: "OrganizationalUnitName", # required
|
1026
|
+
# tags: [
|
1027
|
+
# {
|
1028
|
+
# key: "TagKey", # required
|
1029
|
+
# value: "TagValue", # required
|
1030
|
+
# },
|
1031
|
+
# ],
|
971
1032
|
# }
|
972
1033
|
#
|
973
1034
|
# @!attribute [rw] parent_id
|
@@ -995,11 +1056,30 @@ module Aws::Organizations
|
|
995
1056
|
# The friendly name to assign to the new OU.
|
996
1057
|
# @return [String]
|
997
1058
|
#
|
1059
|
+
# @!attribute [rw] tags
|
1060
|
+
# A list of tags that you want to attach to the newly created OU. For
|
1061
|
+
# each tag in the list, you must specify both a tag key and a value.
|
1062
|
+
# You can set the value to an empty string, but you can't set it to
|
1063
|
+
# `null`. For more information about tagging, see [Tagging AWS
|
1064
|
+
# Organizations resources][1] in the AWS Organizations User Guide.
|
1065
|
+
#
|
1066
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
1067
|
+
# number of tags for an OU, then the entire request fails and the OU
|
1068
|
+
# is not created.
|
1069
|
+
#
|
1070
|
+
# </note>
|
1071
|
+
#
|
1072
|
+
#
|
1073
|
+
#
|
1074
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
|
1075
|
+
# @return [Array<Types::Tag>]
|
1076
|
+
#
|
998
1077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/CreateOrganizationalUnitRequest AWS API Documentation
|
999
1078
|
#
|
1000
1079
|
class CreateOrganizationalUnitRequest < Struct.new(
|
1001
1080
|
:parent_id,
|
1002
|
-
:name
|
1081
|
+
:name,
|
1082
|
+
:tags)
|
1003
1083
|
SENSITIVE = []
|
1004
1084
|
include Aws::Structure
|
1005
1085
|
end
|
@@ -1024,6 +1104,12 @@ module Aws::Organizations
|
|
1024
1104
|
# description: "PolicyDescription", # required
|
1025
1105
|
# name: "PolicyName", # required
|
1026
1106
|
# type: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY
|
1107
|
+
# tags: [
|
1108
|
+
# {
|
1109
|
+
# key: "TagKey", # required
|
1110
|
+
# value: "TagValue", # required
|
1111
|
+
# },
|
1112
|
+
# ],
|
1027
1113
|
# }
|
1028
1114
|
#
|
1029
1115
|
# @!attribute [rw] content
|
@@ -1061,19 +1147,38 @@ module Aws::Organizations
|
|
1061
1147
|
#
|
1062
1148
|
#
|
1063
1149
|
#
|
1064
|
-
# [1]:
|
1065
|
-
# [2]:
|
1066
|
-
# [3]:
|
1067
|
-
# [4]:
|
1150
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
1151
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
1152
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html
|
1153
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
1068
1154
|
# @return [String]
|
1069
1155
|
#
|
1156
|
+
# @!attribute [rw] tags
|
1157
|
+
# A list of tags that you want to attach to the newly created policy.
|
1158
|
+
# For each tag in the list, you must specify both a tag key and a
|
1159
|
+
# value. You can set the value to an empty string, but you can't set
|
1160
|
+
# it to `null`. For more information about tagging, see [Tagging AWS
|
1161
|
+
# Organizations resources][1] in the AWS Organizations User Guide.
|
1162
|
+
#
|
1163
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
1164
|
+
# number of tags for a policy, then the entire request fails and the
|
1165
|
+
# policy is not created.
|
1166
|
+
#
|
1167
|
+
# </note>
|
1168
|
+
#
|
1169
|
+
#
|
1170
|
+
#
|
1171
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
|
1172
|
+
# @return [Array<Types::Tag>]
|
1173
|
+
#
|
1070
1174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/CreatePolicyRequest AWS API Documentation
|
1071
1175
|
#
|
1072
1176
|
class CreatePolicyRequest < Struct.new(
|
1073
1177
|
:content,
|
1074
1178
|
:description,
|
1075
1179
|
:name,
|
1076
|
-
:type
|
1180
|
+
:type,
|
1181
|
+
:tags)
|
1077
1182
|
SENSITIVE = []
|
1078
1183
|
include Aws::Structure
|
1079
1184
|
end
|
@@ -1350,8 +1455,9 @@ module Aws::Organizations
|
|
1350
1455
|
# }
|
1351
1456
|
#
|
1352
1457
|
# @!attribute [rw] create_account_request_id
|
1353
|
-
# Specifies the `
|
1354
|
-
# You can get the
|
1458
|
+
# Specifies the `Id` value that uniquely identifies the
|
1459
|
+
# `CreateAccount` request. You can get the value from the
|
1460
|
+
# `CreateAccountStatus.Id` response in an earlier CreateAccount
|
1355
1461
|
# request, or from the ListCreateAccountStatus operation.
|
1356
1462
|
#
|
1357
1463
|
# The [regex pattern][1] for a create account request ID string
|
@@ -1404,9 +1510,9 @@ module Aws::Organizations
|
|
1404
1510
|
#
|
1405
1511
|
#
|
1406
1512
|
#
|
1407
|
-
# [1]:
|
1408
|
-
# [2]:
|
1409
|
-
# [3]:
|
1513
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
1514
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
1515
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
1410
1516
|
# @return [String]
|
1411
1517
|
#
|
1412
1518
|
# @!attribute [rw] target_id
|
@@ -1703,10 +1809,10 @@ module Aws::Organizations
|
|
1703
1809
|
#
|
1704
1810
|
#
|
1705
1811
|
#
|
1706
|
-
# [1]:
|
1707
|
-
# [2]:
|
1708
|
-
# [3]:
|
1709
|
-
# [4]:
|
1812
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
1813
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
1814
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html
|
1815
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
1710
1816
|
# @return [String]
|
1711
1817
|
#
|
1712
1818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/DisablePolicyTypeRequest AWS API Documentation
|
@@ -1923,10 +2029,10 @@ module Aws::Organizations
|
|
1923
2029
|
#
|
1924
2030
|
#
|
1925
2031
|
#
|
1926
|
-
# [1]:
|
1927
|
-
# [2]:
|
1928
|
-
# [3]:
|
1929
|
-
# [4]:
|
2032
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
2033
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
2034
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html
|
2035
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
1930
2036
|
# @return [String]
|
1931
2037
|
#
|
1932
2038
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/EnablePolicyTypeRequest AWS API Documentation
|
@@ -2009,7 +2115,7 @@ module Aws::Organizations
|
|
2009
2115
|
# creates the ID when it initiates the handshake.
|
2010
2116
|
#
|
2011
2117
|
# The [regex pattern][1] for handshake ID string requires "h-"
|
2012
|
-
# followed by from 8 to 32
|
2118
|
+
# followed by from 8 to 32 lowercase letters or digits.
|
2013
2119
|
#
|
2014
2120
|
#
|
2015
2121
|
#
|
@@ -2217,7 +2323,7 @@ module Aws::Organizations
|
|
2217
2323
|
# `ActionType`.
|
2218
2324
|
#
|
2219
2325
|
# The [regex pattern][1] for handshake ID string requires "h-"
|
2220
|
-
# followed by from 8 to 32
|
2326
|
+
# followed by from 8 to 32 lowercase letters or digits.
|
2221
2327
|
#
|
2222
2328
|
#
|
2223
2329
|
#
|
@@ -2260,7 +2366,7 @@ module Aws::Organizations
|
|
2260
2366
|
# The unique identifier (ID) for the party.
|
2261
2367
|
#
|
2262
2368
|
# The [regex pattern][1] for handshake ID string requires "h-"
|
2263
|
-
# followed by from 8 to 32
|
2369
|
+
# followed by from 8 to 32 lowercase letters or digits.
|
2264
2370
|
#
|
2265
2371
|
#
|
2266
2372
|
#
|
@@ -2348,6 +2454,9 @@ module Aws::Organizations
|
|
2348
2454
|
#
|
2349
2455
|
# </note>
|
2350
2456
|
#
|
2457
|
+
# * DUPLICATE\_TAG\_KEY: Tag keys must be unique among the tags attached
|
2458
|
+
# to the same entity.
|
2459
|
+
#
|
2351
2460
|
# * IMMUTABLE\_POLICY: You specified a policy that is managed by AWS and
|
2352
2461
|
# can't be modified.
|
2353
2462
|
#
|
@@ -2356,6 +2465,9 @@ module Aws::Organizations
|
|
2356
2465
|
#
|
2357
2466
|
# * INVALID\_ENUM: You specified an invalid value.
|
2358
2467
|
#
|
2468
|
+
# * INVALID\_ENUM\_POLICY\_TYPE: You specified an invalid policy type
|
2469
|
+
# string.
|
2470
|
+
#
|
2359
2471
|
# * INVALID\_FULL\_NAME\_TARGET: You specified a full name that contains
|
2360
2472
|
# invalid characters.
|
2361
2473
|
#
|
@@ -2405,6 +2517,12 @@ module Aws::Organizations
|
|
2405
2517
|
# * MOVING\_ACCOUNT\_BETWEEN\_DIFFERENT\_ROOTS: You can move an account
|
2406
2518
|
# only between entities in the same root.
|
2407
2519
|
#
|
2520
|
+
# * TARGET\_NOT\_SUPPORTED: You can't perform the specified operation
|
2521
|
+
# on that target entity.
|
2522
|
+
#
|
2523
|
+
# * UNRECOGNIZED\_SERVICE\_PRINCIPAL: You specified a service principal
|
2524
|
+
# that isn't recognized.
|
2525
|
+
#
|
2408
2526
|
# @!attribute [rw] message
|
2409
2527
|
# @return [String]
|
2410
2528
|
#
|
@@ -2429,6 +2547,12 @@ module Aws::Organizations
|
|
2429
2547
|
# type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, EMAIL
|
2430
2548
|
# },
|
2431
2549
|
# notes: "HandshakeNotes",
|
2550
|
+
# tags: [
|
2551
|
+
# {
|
2552
|
+
# key: "TagKey", # required
|
2553
|
+
# value: "TagValue", # required
|
2554
|
+
# },
|
2555
|
+
# ],
|
2432
2556
|
# }
|
2433
2557
|
#
|
2434
2558
|
# @!attribute [rw] target
|
@@ -2455,11 +2579,40 @@ module Aws::Organizations
|
|
2455
2579
|
# email to the recipient account owner.
|
2456
2580
|
# @return [String]
|
2457
2581
|
#
|
2582
|
+
# @!attribute [rw] tags
|
2583
|
+
# A list of tags that you want to attach to the account when it
|
2584
|
+
# becomes a member of the organization. For each tag in the list, you
|
2585
|
+
# must specify both a tag key and a value. You can set the value to an
|
2586
|
+
# empty string, but you can't set it to `null`. For more information
|
2587
|
+
# about tagging, see [Tagging AWS Organizations resources][1] in the
|
2588
|
+
# AWS Organizations User Guide.
|
2589
|
+
#
|
2590
|
+
# Any tags in the request are checked for compliance with any
|
2591
|
+
# applicable tag policies when the request is made. The request is
|
2592
|
+
# rejected if the tags in the request don't match the requirements of
|
2593
|
+
# the policy at that time. Tag policy compliance is <i> <b>not</b>
|
2594
|
+
# </i> checked again when the invitation is accepted and the tags are
|
2595
|
+
# actually attached to the account. That means that if the tag policy
|
2596
|
+
# changes between the invitation and the acceptance, then that tags
|
2597
|
+
# could potentially be non-compliant.
|
2598
|
+
#
|
2599
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
2600
|
+
# number of tags for an account, then the entire request fails and
|
2601
|
+
# invitations are not sent.
|
2602
|
+
#
|
2603
|
+
# </note>
|
2604
|
+
#
|
2605
|
+
#
|
2606
|
+
#
|
2607
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
|
2608
|
+
# @return [Array<Types::Tag>]
|
2609
|
+
#
|
2458
2610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/InviteAccountToOrganizationRequest AWS API Documentation
|
2459
2611
|
#
|
2460
2612
|
class InviteAccountToOrganizationRequest < Struct.new(
|
2461
2613
|
:target,
|
2462
|
-
:notes
|
2614
|
+
:notes,
|
2615
|
+
:tags)
|
2463
2616
|
SENSITIVE = [:notes]
|
2464
2617
|
include Aws::Structure
|
2465
2618
|
end
|
@@ -3318,10 +3471,10 @@ module Aws::Organizations
|
|
3318
3471
|
#
|
3319
3472
|
#
|
3320
3473
|
#
|
3321
|
-
# [1]:
|
3322
|
-
# [2]:
|
3323
|
-
# [3]:
|
3324
|
-
# [4]:
|
3474
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
3475
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
3476
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html
|
3477
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
3325
3478
|
# @return [String]
|
3326
3479
|
#
|
3327
3480
|
# @!attribute [rw] next_token
|
@@ -3400,10 +3553,10 @@ module Aws::Organizations
|
|
3400
3553
|
#
|
3401
3554
|
#
|
3402
3555
|
#
|
3403
|
-
# [1]:
|
3404
|
-
# [2]:
|
3405
|
-
# [3]:
|
3406
|
-
# [4]:
|
3556
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
3557
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html
|
3558
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html
|
3559
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
3407
3560
|
# @return [String]
|
3408
3561
|
#
|
3409
3562
|
# @!attribute [rw] next_token
|
@@ -3528,7 +3681,20 @@ module Aws::Organizations
|
|
3528
3681
|
# }
|
3529
3682
|
#
|
3530
3683
|
# @!attribute [rw] resource_id
|
3531
|
-
# The ID of the resource
|
3684
|
+
# The ID of the resource with the tags to list.
|
3685
|
+
#
|
3686
|
+
# You can specify any of the following taggable resources.
|
3687
|
+
#
|
3688
|
+
# * AWS account – specify the account ID number.
|
3689
|
+
#
|
3690
|
+
# * Organizational unit – specify the OU ID that begins with `ou-` and
|
3691
|
+
# looks similar to: `ou-1a2b-34uvwxyz `
|
3692
|
+
#
|
3693
|
+
# * Root – specify the root ID that begins with `r-` and looks similar
|
3694
|
+
# to: `r-1a2b `
|
3695
|
+
#
|
3696
|
+
# * Policy – specify the policy ID that begins with `p-` andlooks
|
3697
|
+
# similar to: `p-12abcdefg3 `
|
3532
3698
|
# @return [String]
|
3533
3699
|
#
|
3534
3700
|
# @!attribute [rw] next_token
|
@@ -3760,7 +3926,7 @@ module Aws::Organizations
|
|
3760
3926
|
# The unique identifier (ID) of an organization.
|
3761
3927
|
#
|
3762
3928
|
# The [regex pattern][1] for an organization ID string requires "o-"
|
3763
|
-
# followed by from 10 to 32
|
3929
|
+
# followed by from 10 to 32 lowercase letters or digits.
|
3764
3930
|
#
|
3765
3931
|
#
|
3766
3932
|
#
|
@@ -3868,9 +4034,9 @@ module Aws::Organizations
|
|
3868
4034
|
# The unique identifier (ID) associated with this OU.
|
3869
4035
|
#
|
3870
4036
|
# The [regex pattern][1] for an organizational unit ID string requires
|
3871
|
-
# "ou-" followed by from 4 to 32
|
3872
|
-
#
|
3873
|
-
# second "-" dash and from 8 to 32 additional
|
4037
|
+
# "ou-" followed by from 4 to 32 lowercase letters or digits (the ID
|
4038
|
+
# of the root that contains the OU). This string is followed by a
|
4039
|
+
# second "-" dash and from 8 to 32 additional lowercase letters or
|
3874
4040
|
# digits.
|
3875
4041
|
#
|
3876
4042
|
#
|
@@ -3948,13 +4114,13 @@ module Aws::Organizations
|
|
3948
4114
|
# The [regex pattern][1] for a parent ID string requires one of the
|
3949
4115
|
# following:
|
3950
4116
|
#
|
3951
|
-
# * Root
|
3952
|
-
#
|
4117
|
+
# * **Root** - A string that begins with "r-" followed by from 4 to
|
4118
|
+
# 32 lowercase letters or digits.
|
3953
4119
|
#
|
3954
|
-
# * Organizational unit (OU)
|
3955
|
-
# followed by from 4 to 32
|
4120
|
+
# * **Organizational unit (OU)** - A string that begins with "ou-"
|
4121
|
+
# followed by from 4 to 32 lowercase letters or digits (the ID of
|
3956
4122
|
# the root that the OU is in). This string is followed by a second
|
3957
|
-
# "-" dash and from 8 to 32 additional
|
4123
|
+
# "-" dash and from 8 to 32 additional lowercase letters or
|
3958
4124
|
# digits.
|
3959
4125
|
#
|
3960
4126
|
#
|
@@ -4071,7 +4237,8 @@ module Aws::Organizations
|
|
4071
4237
|
# The unique identifier (ID) of the policy.
|
4072
4238
|
#
|
4073
4239
|
# The [regex pattern][1] for a policy ID string requires "p-"
|
4074
|
-
# followed by from 8 to 128
|
4240
|
+
# followed by from 8 to 128 lowercase or uppercase letters, digits, or
|
4241
|
+
# the underscore character (\_).
|
4075
4242
|
#
|
4076
4243
|
#
|
4077
4244
|
#
|
@@ -4137,15 +4304,15 @@ module Aws::Organizations
|
|
4137
4304
|
# The [regex pattern][1] for a target ID string requires one of the
|
4138
4305
|
# following:
|
4139
4306
|
#
|
4140
|
-
# * Root
|
4141
|
-
#
|
4307
|
+
# * **Root** - A string that begins with "r-" followed by from 4 to
|
4308
|
+
# 32 lowercase letters or digits.
|
4142
4309
|
#
|
4143
|
-
# * Account
|
4310
|
+
# * **Account** - A string that consists of exactly 12 digits.
|
4144
4311
|
#
|
4145
|
-
# * Organizational unit (OU)
|
4146
|
-
# followed by from 4 to 32
|
4312
|
+
# * **Organizational unit (OU)** - A string that begins with "ou-"
|
4313
|
+
# followed by from 4 to 32 lowercase letters or digits (the ID of
|
4147
4314
|
# the root that the OU is in). This string is followed by a second
|
4148
|
-
# "-" dash and from 8 to 32 additional
|
4315
|
+
# "-" dash and from 8 to 32 additional lowercase letters or
|
4149
4316
|
# digits.
|
4150
4317
|
#
|
4151
4318
|
#
|
@@ -4325,16 +4492,14 @@ module Aws::Organizations
|
|
4325
4492
|
|
4326
4493
|
# Contains details about a root. A root is a top-level parent node in
|
4327
4494
|
# the hierarchy of an organization that can contain organizational units
|
4328
|
-
# (OUs) and accounts.
|
4329
|
-
# organization.
|
4330
|
-
# different way and to have different policy types enabled for use in
|
4331
|
-
# that root.
|
4495
|
+
# (OUs) and accounts. The root contains every AWS account in the
|
4496
|
+
# organization.
|
4332
4497
|
#
|
4333
4498
|
# @!attribute [rw] id
|
4334
4499
|
# The unique identifier (ID) for the root.
|
4335
4500
|
#
|
4336
4501
|
# The [regex pattern][1] for a root ID string requires "r-" followed
|
4337
|
-
# by from 4 to 32
|
4502
|
+
# by from 4 to 32 lowercase letters or digits.
|
4338
4503
|
#
|
4339
4504
|
#
|
4340
4505
|
#
|
@@ -4428,8 +4593,18 @@ module Aws::Organizations
|
|
4428
4593
|
include Aws::Structure
|
4429
4594
|
end
|
4430
4595
|
|
4431
|
-
# A custom key-value pair associated with a resource
|
4432
|
-
#
|
4596
|
+
# A custom key-value pair associated with a resource within your
|
4597
|
+
# organization.
|
4598
|
+
#
|
4599
|
+
# You can attach tags to any of the following organization resources.
|
4600
|
+
#
|
4601
|
+
# * AWS account
|
4602
|
+
#
|
4603
|
+
# * Organizational unit (OU)
|
4604
|
+
#
|
4605
|
+
# * Organization root
|
4606
|
+
#
|
4607
|
+
# * Policy
|
4433
4608
|
#
|
4434
4609
|
# @note When making an API call, you may pass Tag
|
4435
4610
|
# data as a hash:
|
@@ -4476,9 +4651,30 @@ module Aws::Organizations
|
|
4476
4651
|
# @return [String]
|
4477
4652
|
#
|
4478
4653
|
# @!attribute [rw] tags
|
4479
|
-
#
|
4480
|
-
#
|
4481
|
-
#
|
4654
|
+
# A list of tags to add to the specified resource.
|
4655
|
+
#
|
4656
|
+
# You can specify any of the following taggable resources.
|
4657
|
+
#
|
4658
|
+
# * AWS account – specify the account ID number.
|
4659
|
+
#
|
4660
|
+
# * Organizational unit – specify the OU ID that begins with `ou-` and
|
4661
|
+
# looks similar to: `ou-1a2b-34uvwxyz `
|
4662
|
+
#
|
4663
|
+
# * Root – specify the root ID that begins with `r-` and looks similar
|
4664
|
+
# to: `r-1a2b `
|
4665
|
+
#
|
4666
|
+
# * Policy – specify the policy ID that begins with `p-` andlooks
|
4667
|
+
# similar to: `p-12abcdefg3 `
|
4668
|
+
#
|
4669
|
+
# For each tag in the list, you must specify both a tag key and a
|
4670
|
+
# value. You can set the value to an empty string, but you can't set
|
4671
|
+
# it to `null`.
|
4672
|
+
#
|
4673
|
+
# <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed
|
4674
|
+
# number of tags for an account user, then the entire request fails
|
4675
|
+
# and the account is not created.
|
4676
|
+
#
|
4677
|
+
# </note>
|
4482
4678
|
# @return [Array<Types::Tag>]
|
4483
4679
|
#
|
4484
4680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/TagResourceRequest AWS API Documentation
|
@@ -4490,8 +4686,8 @@ module Aws::Organizations
|
|
4490
4686
|
include Aws::Structure
|
4491
4687
|
end
|
4492
4688
|
|
4493
|
-
# We can't find a root, OU, or
|
4494
|
-
# specified.
|
4689
|
+
# We can't find a root, OU, account, or policy with the `TargetId` that
|
4690
|
+
# you specified.
|
4495
4691
|
#
|
4496
4692
|
# @!attribute [rw] message
|
4497
4693
|
# @return [String]
|
@@ -4553,11 +4749,24 @@ module Aws::Organizations
|
|
4553
4749
|
# }
|
4554
4750
|
#
|
4555
4751
|
# @!attribute [rw] resource_id
|
4556
|
-
# The ID of the resource to remove
|
4752
|
+
# The ID of the resource to remove a tag from.
|
4753
|
+
#
|
4754
|
+
# You can specify any of the following taggable resources.
|
4755
|
+
#
|
4756
|
+
# * AWS account – specify the account ID number.
|
4757
|
+
#
|
4758
|
+
# * Organizational unit – specify the OU ID that begins with `ou-` and
|
4759
|
+
# looks similar to: `ou-1a2b-34uvwxyz `
|
4760
|
+
#
|
4761
|
+
# * Root – specify the root ID that begins with `r-` and looks similar
|
4762
|
+
# to: `r-1a2b `
|
4763
|
+
#
|
4764
|
+
# * Policy – specify the policy ID that begins with `p-` andlooks
|
4765
|
+
# similar to: `p-12abcdefg3 `
|
4557
4766
|
# @return [String]
|
4558
4767
|
#
|
4559
4768
|
# @!attribute [rw] tag_keys
|
4560
|
-
# The
|
4769
|
+
# The list of keys for tags to remove from the specified resource.
|
4561
4770
|
# @return [Array<String>]
|
4562
4771
|
#
|
4563
4772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/UntagResourceRequest AWS API Documentation
|