String handshakeId
The unique identifier (ID) of the handshake that you want to accept.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Handshake handshake
A structure that contains details about the accepted handshake.
String reason
String id
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
String arn
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String email
The email address associated with the AWS account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
String name
The friendly name of the account.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String status
The status of the account in the organization.
String joinedMethod
The method by which the account joined the organization.
Date joinedTimestamp
The date the account became a part of the organization.
String policyId
The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
String targetId
The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String handshakeId
The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Handshake handshake
A structure that contains details about the handshake that you canceled.
String id
The unique identifier (ID) of this child entity.
The regex pattern for a child ID string requires one of the following:
Account: A string that consists of exactly 12 digits.
Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
String type
The type of this child entity.
String reason
String email
The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.
String accountName
The friendly name of the member account.
String roleName
(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide. Also see steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
String iamUserAccessToBilling
If set to ALLOW, the new account enables IAM users to access account billing information if
they have the required permissions. If set to DENY, only the root user of the new account can access
account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User
Guide.
If you don't specify this parameter, the value defaults to ALLOW. This value allows IAM users and
roles with the required permissions to access billing information for the new account.
CreateAccountStatus createAccountStatus
A structure that contains details about the request to create an account. This response structure might not be
fully populated when you first receive it because account creation is an asynchronous process. You can pass the
returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status
about the progress of the request at later times. You can also check the AWS CloudTrail log for the
CreateAccountResult event. For more information, see Monitoring the Activity in
Your Organization in the AWS Organizations User Guide.
String id
The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.
The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.
String accountName
The account name given to the account when it was created.
String state
The status of the request.
Date requestedTimestamp
The date and time that the request was made for the account creation.
Date completedTimestamp
The date and time that the account was created and the request completed.
String accountId
If the account was created successfully, the unique identifier (ID) of the new account.
The regex pattern for an account ID string requires exactly 12 digits.
String govCloudAccountId
If the account was created successfully, the unique identifier (ID) of the new account in the AWS GovCloud (US) Region.
String failureReason
If the request failed, a description of the reason for the failure.
ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.
EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.
GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.
INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact AWS Support.
String email
The email address of the owner to assign to the new member account in the commercial Region. This email address
must not already be associated with another AWS account. You must use a valid email address to complete account
creation. You can't access the root user of the account or remove an account that was created with an invalid
email address. Like all request parameters for CreateGovCloudAccount, the request for the email
address for the AWS GovCloud (US) account originates from the commercial Region. It does not come from the AWS
GovCloud (US) Region.
String accountName
The friendly name of the member account.
String roleName
(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide. See also steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
String iamUserAccessToBilling
If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account
billing information if they have the required permissions. If set to DENY, only the root user
of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User
Guide.
If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the
required permissions can access billing information for the new account.
CreateAccountStatus createAccountStatus
String parentId
The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String name
The friendly name to assign to the new OU.
OrganizationalUnit organizationalUnit
A structure that contains details about the newly created OU.
String featureSet
Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master
account. For more information, see Consolidated billing in the AWS Organizations User Guide.
The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.
ALL: In addition to all the features that consolidated billing feature set supports, the master
account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.
Organization organization
A structure that contains details about the newly created organization.
String content
The policy content to add to the new policy. For example, you could create a service control policy (SCP) that specifies the permissions that administrators in attached accounts can delegate to their users, groups, and roles. The string for this SCP must be JSON text. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.
String description
An optional description to assign to the policy.
String name
The friendly name to assign to the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String type
The type of policy to create.
Policy policy
A structure that contains details about the newly created policy.
String handshakeId
The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Handshake handshake
A structure that contains details about the declined handshake. The state is updated to show the value
DECLINED.
String organizationalUnitId
The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String policyId
The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
String accountId
The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.
The regex pattern for an account ID string requires exactly 12 digits.
Account account
A structure that contains information about the requested account.
String createAccountRequestId
Specifies the operationId that uniquely identifies the request. You can get the ID from the response
to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.
The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lowercase letters or digits.
CreateAccountStatus createAccountStatus
A structure that contains the current status of an account creation request.
EffectivePolicy effectivePolicy
The contents of the effective policy.
String handshakeId
The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Handshake handshake
A structure that contains information about the specified handshake.
String organizationalUnitId
The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
OrganizationalUnit organizationalUnit
A structure that contains details about the specified OU.
Organization organization
A structure that contains information about the organization.
String policyId
The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
Policy policy
A structure that contains details about the specified policy.
String policyId
The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
String targetId
The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String servicePrincipal
The service principal name of the AWS service for which you want to disable integration with your organization.
This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.
String rootId
The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
String policyType
The policy type that you want to disable in this root.
Root root
A structure that shows the root with the updated list of enabled policy types.
Handshake handshake
A structure that contains details about the handshake created to support this request to enable all features in the organization.
String servicePrincipal
The service principal name of the AWS service for which you want to enable integration with your organization.
This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.
String rootId
The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
String policyType
The policy type that you want to enable.
Root root
A structure that shows the root with the updated list of enabled policy types.
String id
The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
List<E> parties
Information about the two accounts that are participating in the handshake.
String state
The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
Date requestedTimestamp
The date and time that the handshake request was made.
Date expirationTimestamp
The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
String action
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member
accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and
signals the master that it can finalize the process to enable all features.
List<E> resources
Additional information that is needed to process the handshake.
String reason
String actionType
Specifies the type of handshake action.
If you specify ActionType, you cannot also specify ParentHandshakeId.
String parentHandshakeId
Specifies the parent handshake. Only used for handshake types that are a child of another type.
If you specify ParentHandshakeId, you cannot also specify ActionType.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
String id
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
String type
The type of party.
String value
The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
String type
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an AWS account ID number.
ORGANIZATION - Specifies an organization ID number.
EMAIL - Specifies the email address that is associated with the account that receives the handshake.
OWNER_EMAIL - Specifies the email address associated with the master account. Included as
information about an organization.
OWNER_NAME - Specifies the name associated with the master account. Included as information about an
organization.
NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
List<E> resources
When needed, contains an additional array of HandshakeResource objects.
String reason
HandshakeParty target
The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:
{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the AWS CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id.
If you specify "Type": "EMAIL", you must specify the email address that is associated with the
account.
--target Id=diego@example.com,Type=EMAIL
String notes
Additional information that you want to include in the generated email to the recipient account owner.
Handshake handshake
A structure that contains details about the handshake that is created to support this invitation request.
String parentId
The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> accounts
A list of the accounts in the specified root or OU.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> accounts
A list of objects in the organization.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> enabledServicePrincipals
A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with AWS Organizations.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String parentId
The unique identifier (ID) for the parent root or OU whose children you want to list.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String childType
Filters the output to include only the specified child type.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> children
The list of children of the specified parent container.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
List<E> states
A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> createAccountStatuses
A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
HandshakeFilter filter
Filters the handshakes that you want included in the response. The default is all types. Use the
ActionType element to limit the output to only a specified type, such as INVITE,
ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, you can specify the
ENABLE_ALL_FEATURES handshake, which generates a separate child handshake for each member account.
When you do specify ParentHandshakeId to see only the handshakes that were generated by that parent
request.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> handshakes
A list of Handshake objects with details about each of the handshakes that is associated with the specified account.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
HandshakeFilter filter
A filter of the handshakes that you want included in the response. The default is all types. Use the
ActionType element to limit the output to only a specified type, such as INVITE,
ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, you can specify the
ENABLE-ALL-FEATURES handshake, which generates a separate child handshake for each member account.
When you do, specify the ParentHandshakeId to see only the handshakes that were generated by that
parent request.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> handshakes
A list of Handshake objects with details about each of the handshakes that are associated with an organization.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String parentId
The unique identifier (ID) of the root or OU whose child OUs you want to list.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> organizationalUnits
A list of the OUs in the specified root or parent OU.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String childId
The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.
The regex pattern for a child ID string requires one of the following:
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> parents
A list of parents for the specified child account or OU.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String targetId
The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String filter
The type of policy that you want to include in the returned list.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> policies
The list of policies that match the criteria in the request.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String filter
Specifies the type of policy that you want to include in the response.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> policies
A list of policies that match the filter criteria in the request. The output list doesn't include the policy contents. To see the content for a policy, see DescribePolicy.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> roots
A list of roots that are defined in an organization.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String resourceId
The ID of the resource that you want to retrieve tags for.
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
List<E> tags
The tags that are assigned to the resource.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String policyId
The unique identifier (ID) of the policy whose attachments you want to know.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
String nextToken
Use this parameter if you receive a NextToken response in a previous request that indicates that
there is more output available. Set it to the value of the previous call's NextToken response to
indicate where the output should continue from.
Integer maxResults
(Optional) Use this to limit the number of results you want included per page in the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value (is not
null). Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
List<E> targets
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
String nextToken
If present, this value indicates that there is more output available than is included in the current response.
Use this value in the NextToken request parameter in a subsequent call to the operation to get the
next part of the output. You should repeat this until the NextToken response element comes back as
null.
String accountId
The unique identifier (ID) of the account that you want to move.
The regex pattern for an account ID string requires exactly 12 digits.
String sourceParentId
The unique identifier (ID) of the root or organizational unit that you want to move the account from.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String destinationParentId
The unique identifier (ID) of the root or organizational unit that you want to move the account to.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String id
The unique identifier (ID) of an organization.
The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of an organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String featureSet
Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
String masterAccountArn
The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String masterAccountId
The unique identifier (ID) of the master account of an organization.
The regex pattern for an account ID string requires exactly 12 digits.
String masterAccountEmail
The email address that is associated with the AWS account that is designated as the master account for the organization.
List<E> availablePolicyTypes
A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.
Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.
String id
The unique identifier (ID) associated with this OU.
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String name
The friendly name of this OU.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String id
The unique identifier (ID) of the parent entity.
The regex pattern for a parent ID string requires one of the following:
Root: A string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
String type
The type of the parent entity.
PolicySummary policySummary
A structure that contains additional details about the policy.
String content
The text content of the policy.
String id
The unique identifier (ID) of the policy.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String name
The friendly name of the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String description
The description of the policy.
String type
The type of policy.
Boolean awsManaged
A Boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
String targetId
The unique identifier (ID) of the policy target.
The regex pattern for a target ID string requires one of the following:
Root: A string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Account: A string that consists of exactly 12 digits.
Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of the policy target.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String name
The friendly name of the policy target.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String type
The type of the policy target.
String type
The name of the policy type.
String status
The status of the policy type as it relates to the associated root. You can attach a policy of the specified type to a root or to an OU or account in that root. To do so, the policy must be available in the organization and enabled for that root.
String accountId
The unique identifier (ID) of the member account that you want to remove from the organization.
The regex pattern for an account ID string requires exactly 12 digits.
String id
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.
String arn
The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
String name
The friendly name of the root.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
List<E> policyTypes
The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.
Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.
String type
String organizationalUnitId
The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
String name
The new name that you want to assign to the OU.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
OrganizationalUnit organizationalUnit
A structure that contains the details about the specified OU, including its new name.
String policyId
The unique identifier (ID) of the policy that you want to update.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
String name
If provided, the new name for the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
String description
If provided, the new description for the policy.
String content
If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide.
Policy policy
A structure that contains details about the updated policy, showing the requested changes.
Copyright © 2020. All rights reserved.