Table of Contents
Organizations.Client¶A low-level client representing AWS Organizations
Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations operations. For more information about using this service, see the Organizations User Guide .
Support and feedback for Organizations
We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the Organizations support forum . For more information about the Amazon Web Services support forums, see Forums Help .
Endpoint to call When using the CLI or the Amazon Web Services SDK
For the current release of Organizations, specify the us-east-1 region for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of China. If calling from one of the Amazon Web Services Regions in China, then specify cn-northwest-1 . You can do this in the CLI by using these parameters and commands:
--endpoint-url https://organizations.us-east-1.amazonaws.com (from commercial Amazon Web Services Regions outside of China) or --endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn (from Amazon Web Services Regions in China)aws configure set default.region us-east-1 (from commercial Amazon Web Services Regions outside of China) or aws configure set default.region cn-northwest-1 (from Amazon Web Services Regions in China)--region us-east-1 (from commercial Amazon Web Services Regions outside of China) or --region cn-northwest-1 (from Amazon Web Services Regions in China)Recording API Requests
Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see Logging Organizations Events with CloudTrail in the Organizations User Guide . To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide .
import boto3
client = boto3.client('organizations')
These are the available methods:
accept_handshake()attach_policy()can_paginate()cancel_handshake()close()close_account()create_account()create_gov_cloud_account()create_organization()create_organizational_unit()create_policy()decline_handshake()delete_organization()delete_organizational_unit()delete_policy()deregister_delegated_administrator()describe_account()describe_create_account_status()describe_effective_policy()describe_handshake()describe_organization()describe_organizational_unit()describe_policy()detach_policy()disable_aws_service_access()disable_policy_type()enable_all_features()enable_aws_service_access()enable_policy_type()get_paginator()get_waiter()invite_account_to_organization()leave_organization()list_accounts()list_accounts_for_parent()list_aws_service_access_for_organization()list_children()list_create_account_status()list_delegated_administrators()list_delegated_services_for_account()list_handshakes_for_account()list_handshakes_for_organization()list_organizational_units_for_parent()list_parents()list_policies()list_policies_for_target()list_roots()list_tags_for_resource()list_targets_for_policy()move_account()register_delegated_administrator()remove_account_from_organization()tag_resource()untag_resource()update_organizational_unit()update_policy()accept_handshake(**kwargs)¶Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
This operation can be called only by the following principals when they also have the relevant IAM permissions:
organizations:AcceptHandshake permission. If you enabled all features in the organization, the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations . For more information, see Organizations and Service-Linked Roles in the Organizations User Guide .After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
See also: AWS API Documentation
Request Syntax
response = client.accept_handshake(
HandshakeId='string'
)
[REQUIRED]
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': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains details about the accepted handshake.
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 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
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:
The date and time that the handshake request was made.
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.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
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.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.HandshakeConstraintViolationExceptionOrganizations.Client.exceptions.HandshakeNotFoundExceptionOrganizations.Client.exceptions.InvalidHandshakeTransitionExceptionOrganizations.Client.exceptions.HandshakeAlreadyInStateExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.AccessDeniedForDependencyExceptionExamples
Bill is the owner of an organization, and he invites Juan's account (222222222222) to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation.
response = client.accept_handshake(
HandshakeId='h-examplehandshakeid111',
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 2, 28, 12, 15, 0, 1, 59, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 2, 14, 12, 15, 0, 1, 45, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@amazon.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Org Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'ALL',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'ACCOUNT',
'Value': '222222222222',
},
],
'State': 'ACCEPTED',
},
'ResponseMetadata': {
'...': '...',
},
}
attach_policy(**kwargs)¶Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type:
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.attach_policy(
PolicyId='string',
TargetId='string'
)
[REQUIRED]
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 (_).
[REQUIRED]
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:
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.DuplicatePolicyAttachmentExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.PolicyTypeNotEnabledExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionOrganizations.Client.exceptions.PolicyChangesInProgressExceptionExamples
The following example shows how to attach a service control policy (SCP) to an OU:
response = client.attach_policy(
PolicyId='p-examplepolicyid111',
TargetId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The following example shows how to attach a service control policy (SCP) to an account:
response = client.attach_policy(
PolicyId='p-examplepolicyid111',
TargetId='333333333333',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_handshake(**kwargs)¶Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED .
This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
See also: AWS API Documentation
Request Syntax
response = client.cancel_handshake(
HandshakeId='string'
)
[REQUIRED]
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': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains details about the handshake that you canceled.
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 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
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:
The date and time that the handshake request was made.
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.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
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.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeNotFoundExceptionOrganizations.Client.exceptions.InvalidHandshakeTransitionExceptionOrganizations.Client.exceptions.HandshakeAlreadyInStateExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
response = client.cancel_handshake(
HandshakeId='h-examplehandshakeid111',
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 2, 28, 12, 15, 0, 1, 59, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'susan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 2, 14, 12, 15, 0, 1, 45, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@example.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'CONSOLIDATED_BILLING',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'ACCOUNT',
'Value': '222222222222',
},
{
'Type': 'NOTES',
'Value': 'This is a request for Susan's account to join Bob's organization.',
},
],
'State': 'CANCELED',
},
'ResponseMetadata': {
'...': '...',
},
}
close()¶Closes underlying endpoint connections.
close_account(**kwargs)¶Closes an Amazon Web Services member account within an organization. You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following:
AccountId that you sent in the CloseAccount request to provide as a parameter to the DescribeAccount operation. While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED.CloseAccountResult event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.Note
CloseAccount request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide .For more information about closing accounts, see Closing an Amazon Web Services account in the Organizations User Guide.
See also: AWS API Documentation
Request Syntax
response = client.close_account(
AccountId='string'
)
[REQUIRED]
Retrieves the Amazon Web Services account Id for the current CloseAccount API request.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountAlreadyClosedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConflictExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptioncreate_account(**kwargs)¶Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Id member of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see Organizations and Service-Linked Roles in the Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide.
Warning
CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an Amazon Web Services account in the Organizations User Guide .Note
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools .
See also: AWS API Documentation
Request Syntax
response = client.create_account(
Email='string',
AccountName='string',
RoleName='string',
IamUserAccessToBilling='ALLOW'|'DENY',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.
The rules for a valid email address:
You can't access the root user of the account or remove an account that was created with an invalid email address.
[REQUIRED]
The friendly name of the member account.
(Optional)
The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management 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 the following links:
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: =,.@-
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 Amazon Web Services 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.
A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Note
If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
dict
Response Syntax
{
'CreateAccountStatus': {
'Id': 'string',
'AccountName': 'string',
'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'RequestedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'GovCloudAccountId': 'string',
'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INVALID_EMAIL'|'CONCURRENT_ACCOUNT_MODIFICATION'|'INTERNAL_FAILURE'|'GOVCLOUD_ACCOUNT_ALREADY_EXISTS'|'MISSING_BUSINESS_VALIDATION'|'FAILED_BUSINESS_VALIDATION'|'PENDING_BUSINESS_VALIDATION'|'INVALID_IDENTITY_FOR_BUSINESS_VALIDATION'|'UNKNOWN_BUSINESS_VALIDATION'|'MISSING_PAYMENT_INSTRUMENT'|'INVALID_PAYMENT_INSTRUMENT'
}
}
Response Structure
(dict) --
CreateAccountStatus (dict) --
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 CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the Organizations User Guide .
Id (string) --
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 lowercase letters or digits.
AccountName (string) --
The account name given to the account when it was created.
State (string) --
The status of the asynchronous request to create an Amazon Web Services account.
RequestedTimestamp (datetime) --
The date and time that the request was made for the account creation.
CompletedTimestamp (datetime) --
The date and time that the account was created and the request completed.
AccountId (string) --
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.
GovCloudAccountId (string) --
If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.
FailureReason (string) --
If the request failed, a description of the reason for the failure.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.FinalizingOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name "Production Account" and an owner email address of susan@example.com. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a "Welcome to AWS" email:
response = client.create_account(
AccountName='Production Account',
Email='susan@example.com',
)
print(response)
Expected Output:
{
'CreateAccountStatus': {
'Id': 'car-examplecreateaccountrequestid111',
'State': 'IN_PROGRESS',
},
'ResponseMetadata': {
'...': '...',
},
}
create_gov_cloud_account(**kwargs)¶This action is available if all of the following are true:
organizations:CreateGovCloudAccount permission.Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see Organizations and Service-Linked Roles in the Organizations User Guide.
Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following:
If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists.
You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide.
Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.CreateAccountResult event. For information on using CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the Organizations User Guide.When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide.
For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide.
Warning
CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an Amazon Web Services account in the Organizations User Guide .Note
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools .
See also: AWS API Documentation
Request Syntax
response = client.create_gov_cloud_account(
Email='string',
AccountName='string',
RoleName='string',
IamUserAccessToBilling='ALLOW'|'DENY',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies 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 Amazon Web Services account. You must use a valid email address to complete account creation.
The rules for a valid email address:
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 Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.
[REQUIRED]
The friendly name of the member account.
The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–).
(Optional)
The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management 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 Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across Amazon Web Services 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: =,.@-
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 Amazon Web Services 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.
A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud account exists.
For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Note
If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
dict
Response Syntax
{
'CreateAccountStatus': {
'Id': 'string',
'AccountName': 'string',
'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'RequestedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'GovCloudAccountId': 'string',
'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INVALID_EMAIL'|'CONCURRENT_ACCOUNT_MODIFICATION'|'INTERNAL_FAILURE'|'GOVCLOUD_ACCOUNT_ALREADY_EXISTS'|'MISSING_BUSINESS_VALIDATION'|'FAILED_BUSINESS_VALIDATION'|'PENDING_BUSINESS_VALIDATION'|'INVALID_IDENTITY_FOR_BUSINESS_VALIDATION'|'UNKNOWN_BUSINESS_VALIDATION'|'MISSING_PAYMENT_INSTRUMENT'|'INVALID_PAYMENT_INSTRUMENT'
}
}
Response Structure
(dict) --
CreateAccountStatus (dict) --
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.
Id (string) --
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 lowercase letters or digits.
AccountName (string) --
The account name given to the account when it was created.
State (string) --
The status of the asynchronous request to create an Amazon Web Services account.
RequestedTimestamp (datetime) --
The date and time that the request was made for the account creation.
CompletedTimestamp (datetime) --
The date and time that the account was created and the request completed.
AccountId (string) --
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.
GovCloudAccountId (string) --
If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.
FailureReason (string) --
If the request failed, a description of the reason for the failure.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.FinalizingOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptioncreate_organization(**kwargs)¶Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet parameter to ALL ), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING" , no policy types are enabled by default, and you can't use organization policies
See also: AWS API Documentation
Request Syntax
response = client.create_organization(
FeatureSet='ALL'|'CONSOLIDATED_BILLING'
)
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 management account. For more information, see Consolidated billing in the Organizations User Guide. The consolidated billing feature subset isn't available for organizations in the Amazon Web Services GovCloud (US) Region.ALL : In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see All features in the Organizations User Guide.{
'Organization': {
'Id': 'string',
'Arn': 'string',
'FeatureSet': 'ALL'|'CONSOLIDATED_BILLING',
'MasterAccountArn': 'string',
'MasterAccountId': 'string',
'MasterAccountEmail': 'string',
'AvailablePolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
}
}
Response Structure
A structure that contains details about the newly created organization.
The unique identifier (ID) of an organization.
The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.
The Amazon Resource Name (ARN) of an organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
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 Organizations User Guide .
The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
The unique identifier (ID) of the management account of an organization.
The regex pattern for an account ID string requires exactly 12 digits.
The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.
Warning
Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.
To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.
Contains information about a policy type and its status in the associated root.
The name of the policy type.
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AlreadyInOrganizationExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.AccessDeniedForDependencyExceptionExamples
Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:
response = client.create_organization(
)
print(response)
Expected Output:
{
'Organization': {
'Arn': 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
'AvailablePolicyTypes': [
{
'Status': 'ENABLED',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
'FeatureSet': 'ALL',
'Id': 'o-exampleorgid',
'MasterAccountArn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
'MasterAccountEmail': 'bill@example.com',
'MasterAccountId': '111111111111',
},
'ResponseMetadata': {
'...': '...',
},
}
In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:
response = client.create_organization(
FeatureSet='CONSOLIDATED_BILLING',
)
print(response)
Expected Output:
{
'Organization': {
'Arn': 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
'AvailablePolicyTypes': [
],
'FeatureSet': 'CONSOLIDATED_BILLING',
'Id': 'o-exampleorgid',
'MasterAccountArn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
'MasterAccountEmail': 'bill@example.com',
'MasterAccountId': '111111111111',
},
'ResponseMetadata': {
'...': '...',
},
}
create_organizational_unit(**kwargs)¶Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
For more information about OUs, see Managing Organizational Units in the Organizations User Guide.
If the request includes tags, then the requester must have the organizations:TagResource permission.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.create_organizational_unit(
ParentId='string',
Name='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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:
[REQUIRED]
The friendly name to assign to the new OU.
A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Note
If any one of the tags is invalid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
dict
Response Syntax
{
'OrganizationalUnit': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
OrganizationalUnit (dict) --
A structure that contains details about the newly created OU.
Id (string) --
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 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.
Arn (string) --
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.DuplicateOrganizationalUnitExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ParentNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:
response = client.create_organizational_unit(
Name='AccountingOU',
ParentId='r-examplerootid111',
)
print(response)
Expected Output:
{
'OrganizationalUnit': {
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
'Id': 'ou-examplerootid111-exampleouid111',
'Name': 'AccountingOU',
},
'ResponseMetadata': {
'...': '...',
},
}
create_policy(**kwargs)¶Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.
For more information about policies and their use, see Managing Organization Policies .
If the request includes tags, then the requester must have the organizations:TagResource permission.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.create_policy(
Content='string',
Description='string',
Name='string',
Type='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.
[REQUIRED]
An optional description to assign to the policy.
[REQUIRED]
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.
[REQUIRED]
The type of policy to create. You can specify one of the following values:
A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Note
If any one of the tags is invalid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
dict
Response Syntax
{
'Policy': {
'PolicySummary': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
'Content': 'string'
}
}
Response Structure
(dict) --
Policy (dict) --
A structure that contains details about the newly created policy.
PolicySummary (dict) --
A structure that contains additional details about the policy.
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
Content (string) --
The text content of the policy.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.DuplicatePolicyExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.MalformedPolicyDocumentExceptionOrganizations.Client.exceptions.PolicyTypeNotAvailableForOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:
response = client.create_policy(
Content='{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}',
Description='Enables admins of attached accounts to delegate all S3 permissions',
Name='AllowAllS3Actions',
Type='SERVICE_CONTROL_POLICY',
)
print(response)
Expected Output:
{
'Policy': {
'Content': '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"s3:*"}}',
'PolicySummary': {
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
'Description': 'Allows delegation of all S3 actions',
'Name': 'AllowAllS3Actions',
'Type': 'SERVICE_CONTROL_POLICY',
},
},
'ResponseMetadata': {
'...': '...',
},
}
decline_handshake(**kwargs)¶Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.
This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.
After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
See also: AWS API Documentation
Request Syntax
response = client.decline_handshake(
HandshakeId='string'
)
[REQUIRED]
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': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains details about the declined handshake. The state is updated to show the value DECLINED .
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 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
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:
The date and time that the handshake request was made.
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.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
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.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeNotFoundExceptionOrganizations.Client.exceptions.InvalidHandshakeTransitionExceptionOrganizations.Client.exceptions.HandshakeAlreadyInStateExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:
response = client.decline_handshake(
HandshakeId='h-examplehandshakeid111',
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2016, 12, 15, 19, 27, 58, 3, 350, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': '222222222222',
'Type': 'ACCOUNT',
},
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
],
'RequestedTimestamp': datetime(2016, 11, 30, 19, 27, 58, 2, 335, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@example.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Master Account',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'ACCOUNT',
'Value': '222222222222',
},
{
'Type': 'NOTES',
'Value': 'This is an invitation to Susan's account to join the Bill's organization.',
},
],
'State': 'DECLINED',
},
'ResponseMetadata': {
'...': '...',
},
}
delete_organization()¶Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.
See also: AWS API Documentation
Request Syntax
response = client.delete_organization()
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.OrganizationNotEmptyExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptiondelete_organizational_unit(**kwargs)¶Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.delete_organizational_unit(
OrganizationalUnitId='string'
)
[REQUIRED]
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.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.OrganizationalUnitNotEmptyExceptionOrganizations.Client.exceptions.OrganizationalUnitNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:
response = client.delete_organizational_unit(
OrganizationalUnitId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_policy(**kwargs)¶Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.delete_policy(
PolicyId='string'
)
[REQUIRED]
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 (_).
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyInUseExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:
response = client.delete_policy(
PolicyId='p-examplepolicyid111',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
deregister_delegated_administrator(**kwargs)¶Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.
Warning
Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.
You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.deregister_delegated_administrator(
AccountId='string',
ServicePrincipal='string'
)
[REQUIRED]
The account ID number of the member account in the organization that you want to deregister as a delegated administrator.
[REQUIRED]
The service principal name of an Amazon Web Services service for which the account is a delegated administrator.
Delegated administrator privileges are revoked for only the specified Amazon Web Services service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AccountNotRegisteredExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptiondescribe_account(**kwargs)¶Retrieves Organizations-related information about the specified account.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.describe_account(
AccountId='string'
)
[REQUIRED]
The unique identifier (ID) of the Amazon Web Services 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': {
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
A structure that contains information about the requested account.
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
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.
The status of the account in the organization.
The method by which the account joined the organization.
The date the account became a part of the organization.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows a user in the master account (111111111111) asking for details about account 555555555555:
response = client.describe_account(
AccountId='555555555555',
)
print(response)
Expected Output:
{
'Account': {
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555',
'Email': 'anika@example.com',
'Id': '555555555555',
'Name': 'Beta Account',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_create_account_status(**kwargs)¶Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.describe_create_account_status(
CreateAccountRequestId='string'
)
[REQUIRED]
Specifies the Id value that uniquely identifies the CreateAccount request. You can get the value from the CreateAccountStatus.Id response in 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': {
'Id': 'string',
'AccountName': 'string',
'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'RequestedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'GovCloudAccountId': 'string',
'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INVALID_EMAIL'|'CONCURRENT_ACCOUNT_MODIFICATION'|'INTERNAL_FAILURE'|'GOVCLOUD_ACCOUNT_ALREADY_EXISTS'|'MISSING_BUSINESS_VALIDATION'|'FAILED_BUSINESS_VALIDATION'|'PENDING_BUSINESS_VALIDATION'|'INVALID_IDENTITY_FOR_BUSINESS_VALIDATION'|'UNKNOWN_BUSINESS_VALIDATION'|'MISSING_PAYMENT_INSTRUMENT'|'INVALID_PAYMENT_INSTRUMENT'
}
}
Response Structure
A structure that contains the current status of an account creation request.
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 lowercase letters or digits.
The account name given to the account when it was created.
The status of the asynchronous request to create an Amazon Web Services account.
The date and time that the request was made for the account creation.
The date and time that the account was created and the request completed.
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.
If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.
If the request failed, a description of the reason for the failure.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.CreateAccountStatusNotFoundExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified "createAccountRequestId" comes from the response of the original call to "CreateAccount":
response = client.describe_create_account_status(
CreateAccountRequestId='car-exampleaccountcreationrequestid',
)
print(response)
Expected Output:
{
'CreateAccountStatus': {
'AccountId': '333333333333',
'Id': 'car-exampleaccountcreationrequestid',
'State': 'SUCCEEDED',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_effective_policy(**kwargs)¶Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.
This operation applies only to policy types other than service control policies (SCPs).
For more information about policy inheritance, see How Policy Inheritance Works in the Organizations User Guide .
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.describe_effective_policy(
PolicyType='TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
TargetId='string'
)
[REQUIRED]
The type of policy that you want information about. You can specify one of the following values:
dict
Response Syntax
{
'EffectivePolicy': {
'PolicyContent': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'TargetId': 'string',
'PolicyType': 'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY'
}
}
Response Structure
(dict) --
EffectivePolicy (dict) --
The contents of the effective policy.
PolicyContent (string) --
The text content of the policy.
LastUpdatedTimestamp (datetime) --
The time of the last update to this policy.
TargetId (string) --
The account ID of the policy target.
PolicyType (string) --
The policy type.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.EffectivePolicyNotFoundExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptiondescribe_handshake(**kwargs)¶Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.
You can access handshakes that are ACCEPTED , DECLINED , or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible.
This operation can be called from any account in the organization.
See also: AWS API Documentation
Request Syntax
response = client.describe_handshake(
HandshakeId='string'
)
[REQUIRED]
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': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains information about the specified handshake.
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 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
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:
The date and time that the handshake request was made.
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.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
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.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeNotFoundExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization":
response = client.describe_handshake(
HandshakeId='h-examplehandshakeid111',
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2016, 11, 30, 17, 24, 58, 2, 335, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': '333333333333',
'Type': 'ACCOUNT',
},
],
'RequestedTimestamp': datetime(2016, 11, 30, 17, 24, 58, 2, 335, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@example.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Master Account',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'ACCOUNT',
'Value': '333333333333',
},
],
'State': 'OPEN',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_organization()¶Retrieves information about the organization that the user's account belongs to.
This operation can be called from any account in the organization.
Note
Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType . Use ListRoots to see the status of policy types for a specified root.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization()
{
'Organization': {
'Id': 'string',
'Arn': 'string',
'FeatureSet': 'ALL'|'CONSOLIDATED_BILLING',
'MasterAccountArn': 'string',
'MasterAccountId': 'string',
'MasterAccountEmail': 'string',
'AvailablePolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
}
}
Response Structure
A structure that contains information about the organization.
Warning
The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the `` ListRoots `` operation.
The unique identifier (ID) of an organization.
The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.
The Amazon Resource Name (ARN) of an organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
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 Organizations User Guide .
The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
The unique identifier (ID) of the management account of an organization.
The regex pattern for an account ID string requires exactly 12 digits.
The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.
Warning
Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.
To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.
Contains information about a policy type and its status in the associated root.
The name of the policy type.
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to request information about the current user's organization:/n/n
response = client.describe_organization(
)
print(response)
Expected Output:
{
'Organization': {
'Arn': 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
'AvailablePolicyTypes': [
{
'Status': 'ENABLED',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
'FeatureSet': 'ALL',
'Id': 'o-exampleorgid',
'MasterAccountArn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
'MasterAccountEmail': 'bill@example.com',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_organizational_unit(**kwargs)¶Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.describe_organizational_unit(
OrganizationalUnitId='string'
)
[REQUIRED]
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': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
A structure that contains details about the specified OU.
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 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.
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
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.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.OrganizationalUnitNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to request details about an OU:/n/n
response = client.describe_organizational_unit(
OrganizationalUnitId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'OrganizationalUnit': {
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
'Id': 'ou-examplerootid111-exampleouid111',
'Name': 'Accounting Group',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_policy(**kwargs)¶Retrieves information about a policy.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.describe_policy(
PolicyId='string'
)
[REQUIRED]
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': {
'PolicySummary': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
'Content': 'string'
}
}
Response Structure
A structure that contains details about the specified policy.
A structure that contains additional details about the policy.
The unique identifier (ID) of the policy.
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 (_).
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
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.
The description of the policy.
The type of policy.
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
The text content of the policy.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to request information about a policy:/n/n
response = client.describe_policy(
PolicyId='p-examplepolicyid111',
)
print(response)
Expected Output:
{
'Policy': {
'Content': '{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}',
'PolicySummary': {
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
'AwsManaged': False,
'Description': 'Enables admins to delegate S3 permissions',
'Id': 'p-examplepolicyid111',
'Name': 'AllowAllS3Actions',
'Type': 'SERVICE_CONTROL_POLICY',
},
},
'ResponseMetadata': {
'...': '...',
},
}
detach_policy(**kwargs)¶Detaches a policy from a target root, organizational unit (OU), or account.
Warning
If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate.
Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an "allow list ". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a "deny list ".
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.detach_policy(
PolicyId='string',
TargetId='string'
)
[REQUIRED]
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 (_).
[REQUIRED]
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:
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyNotAttachedExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionOrganizations.Client.exceptions.PolicyChangesInProgressExceptionExamples
The following example shows how to detach a policy from an OU:/n/n
response = client.detach_policy(
PolicyId='p-examplepolicyid111',
TargetId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
disable_aws_service_access(**kwargs)¶Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal ) with Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations.
Warning
We ** strongly recommend ** that you don't use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access.
For information about how to disable trusted service access to your organization using the trusted service, see the Learn more link under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations . on this page.
If you disable access by using this command, it causes the following actions to occur:
Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts
For more information about integrating other services with Organizations, including the list of services that work with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.disable_aws_service_access(
ServicePrincipal='string'
)
[REQUIRED]
The service principal name of the Amazon Web Services 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`` .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptiondisable_policy_type(**kwargs)¶Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.
This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's management account.
To view the status of available policy types in the organization, use DescribeOrganization .
See also: AWS API Documentation
Request Syntax
response = client.disable_policy_type(
RootId='string',
PolicyType='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY'
)
[REQUIRED]
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.
[REQUIRED]
The policy type that you want to disable in this root. You can specify one of the following values:
dict
Response Syntax
{
'Root': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'PolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
}
}
Response Structure
(dict) --
Root (dict) --
A structure that shows the root with the updated list of enabled policy types.
Id (string) --
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
PolicyTypes (list) --
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.
Note
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.
(dict) --
Contains information about a policy type and its status in the associated root.
Type (string) --
The name of the policy type.
Status (string) --
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyTypeNotEnabledExceptionOrganizations.Client.exceptions.RootNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionOrganizations.Client.exceptions.PolicyChangesInProgressExceptionExamples
The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n
response = client.disable_policy_type(
PolicyType='SERVICE_CONTROL_POLICY',
RootId='r-examplerootid111',
)
print(response)
Expected Output:
{
'Root': {
'Arn': 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
'Id': 'r-examplerootid111',
'Name': 'Root',
'PolicyTypes': [
],
},
'ResponseMetadata': {
'...': '...',
},
}
enable_all_features()¶Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that Organizations supports. For more information, see Enabling All Features in Your Organization in the Organizations User Guide.
Warning
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.
After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType . To see the status of policy types in a root, use ListRoots .
After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains "Action": "ENABLE_ALL_FEATURES" . This completes the change.
After you enable all features in your organization, the management account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The management account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.enable_all_features()
{
'Handshake': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains details about the handshake created to support this request to enable all features in the organization.
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 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
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:
The date and time that the handshake request was made.
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.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
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.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n
response = client.enable_all_features(
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'ENABLE_ALL_FEATURES',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 2, 28, 9, 35, 40, 1, 59, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
],
'RequestedTimestamp': datetime(2017, 2, 13, 9, 35, 40, 0, 44, 0),
'Resources': [
{
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
],
'State': 'REQUESTED',
},
'ResponseMetadata': {
'...': '...',
},
}
enable_aws_service_access(**kwargs)¶Enables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal ) with Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.
Warning
We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
For more information about enabling services to integrate with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide.
This operation can be called only from the organization's management account and only if the organization has enabled all features .
See also: AWS API Documentation
Request Syntax
response = client.enable_aws_service_access(
ServicePrincipal='string'
)
[REQUIRED]
The service principal name of the Amazon Web Services 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`` .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionenable_policy_type(**kwargs)¶Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.
This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's management account.
You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use DescribeOrganization .
See also: AWS API Documentation
Request Syntax
response = client.enable_policy_type(
RootId='string',
PolicyType='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY'
)
[REQUIRED]
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.
[REQUIRED]
The policy type that you want to enable. You can specify one of the following values:
dict
Response Syntax
{
'Root': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'PolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
}
}
Response Structure
(dict) --
Root (dict) --
A structure that shows the root with the updated list of enabled policy types.
Id (string) --
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
PolicyTypes (list) --
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.
Note
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.
(dict) --
Contains information about a policy type and its status in the associated root.
Type (string) --
The name of the policy type.
Status (string) --
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyTypeAlreadyEnabledExceptionOrganizations.Client.exceptions.RootNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.PolicyTypeNotAvailableForOrganizationExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionOrganizations.Client.exceptions.PolicyChangesInProgressExceptionExamples
The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n
response = client.enable_policy_type(
PolicyType='SERVICE_CONTROL_POLICY',
RootId='r-examplerootid111',
)
print(response)
Expected Output:
{
'Root': {
'Arn': 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
'Id': 'r-examplerootid111',
'Name': 'Root',
'PolicyTypes': [
{
'Status': 'ENABLED',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
},
'ResponseMetadata': {
'...': '...',
},
}
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
invite_account_to_organization(**kwargs)¶Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.
Warning
If the request includes tags, then the requester must have the organizations:TagResource permission.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.invite_account_to_organization(
Target={
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
Notes='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier (ID) of the Amazon Web Services 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 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 Amazon Web Services 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
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Warning
Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is * not * checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
Note
If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
dict
Response Syntax
{
'Handshake': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
(dict) --
Handshake (dict) --
A structure that contains details about the handshake that is created to support this invitation request.
Id (string) --
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 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Parties (list) --
Information about the two accounts that are participating in the handshake.
(dict) --
Identifies a participant in a handshake.
Id (string) --
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Type (string) --
The type of party.
State (string) --
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:
RequestedTimestamp (datetime) --
The date and time that the handshake request was made.
ExpirationTimestamp (datetime) --
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.
Action (string) --
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Resources (list) --
Additional information that is needed to process the handshake.
(dict) --
Contains additional data that is needed to process a handshake.
Value (string) --
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.
Type (string) --
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.Resources (list) --
When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.AccountOwnerNotVerifiedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeConstraintViolationExceptionOrganizations.Client.exceptions.DuplicateHandshakeExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.FinalizingOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.
response = client.invite_account_to_organization(
Notes='This is a request for Juan's account to join Bill's organization',
Target={
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 2, 16, 9, 36, 5, 3, 47, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 2, 1, 9, 36, 5, 2, 32, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@amazon.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Org Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'FULL',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'EMAIL',
'Value': 'juan@example.com',
},
],
'State': 'OPEN',
},
'ResponseMetadata': {
'...': '...',
},
}
leave_organization()¶Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
Warning
LeaveOrganization and leaving the organization.Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the Organizations User Guide.
See also: AWS API Documentation
Request Syntax
response = client.leave_organization()
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.MasterCannotLeaveOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
TThe following example shows how to remove your member account from an organization:
response = client.leave_organization(
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
list_accounts(**kwargs)¶Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_accounts(
NextToken='string',
MaxResults=123
)
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Accounts': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accounts (list) --
A list of objects in the organization.
(dict) --
Contains information about an Amazon Web Services account that is a member of an organization.
Id (string) --
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
Arn (string) --
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Email (string) --
The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
Name (string) --
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.
Status (string) --
The status of the account in the organization.
JoinedMethod (string) --
The method by which the account joined the organization.
JoinedTimestamp (datetime) --
The date the account became a part of the organization.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows you how to request a list of the accounts in an organization:
response = client.list_accounts(
)
print(response)
Expected Output:
{
'Accounts': [
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
'Email': 'bill@example.com',
'Id': '111111111111',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': datetime(2016, 12, 15, 19, 30, 15, 3, 350, 0),
'Name': 'Master Account',
'Status': 'ACTIVE',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222',
'Email': 'alice@example.com',
'Id': '222222222222',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': datetime(2016, 12, 15, 21, 2, 21, 3, 350, 0),
'Name': 'Developer Account',
'Status': 'ACTIVE',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333',
'Email': 'juan@example.com',
'Id': '333333333333',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': datetime(2016, 12, 15, 21, 3, 47, 3, 350, 0),
'Name': 'Test Account',
'Status': 'ACTIVE',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444',
'Email': 'anika@example.com',
'Id': '444444444444',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': datetime(2016, 12, 15, 21, 3, 32, 3, 350, 0),
'Name': 'Production Account',
'Status': 'ACTIVE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_accounts_for_parent(**kwargs)¶Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_accounts_for_parent(
ParentId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Accounts': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accounts (list) --
A list of the accounts in the specified root or OU.
(dict) --
Contains information about an Amazon Web Services account that is a member of an organization.
Id (string) --
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
Arn (string) --
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Email (string) --
The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
Name (string) --
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.
Status (string) --
The status of the account in the organization.
JoinedMethod (string) --
The method by which the account joined the organization.
JoinedTimestamp (datetime) --
The date the account became a part of the organization.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ParentNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to request a list of the accounts in an OU:/n/n
response = client.list_accounts_for_parent(
ParentId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'Accounts': [
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333',
'Email': 'juan@example.com',
'Id': '333333333333',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': 1481835795.536,
'Name': 'Development Account',
'Status': 'ACTIVE',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444',
'Email': 'anika@example.com',
'Id': '444444444444',
'JoinedMethod': 'INVITED',
'JoinedTimestamp': 1481835812.143,
'Name': 'Test Account',
'Status': 'ACTIVE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_aws_service_access_for_organization(**kwargs)¶Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
For more information about integrating other services with Organizations, including the list of services that currently work with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_aws_service_access_for_organization(
NextToken='string',
MaxResults=123
)
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'EnabledServicePrincipals': [
{
'ServicePrincipal': 'string',
'DateEnabled': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EnabledServicePrincipals (list) --
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 Organizations.
(dict) --
A structure that contains details of a service principal that represents an Amazon Web Services service that is enabled to integrate with Organizations.
ServicePrincipal (string) --
The name of the service principal. This is typically in the form of a URL, such as: `` servicename .amazonaws.com`` .
DateEnabled (datetime) --
The date that the service principal was enabled for integration with Organizations.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionlist_children(**kwargs)¶Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_children(
ParentId='string',
ChildType='ACCOUNT'|'ORGANIZATIONAL_UNIT',
NextToken='string',
MaxResults=123
)
[REQUIRED]
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:
[REQUIRED]
Filters the output to include only the specified child type.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Children': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Children (list) --
The list of children of the specified parent container.
(dict) --
Contains a list of child entities, either OUs or accounts.
Id (string) --
The unique identifier (ID) of this child entity.
The regex pattern for a child ID string requires one of the following:
Type (string) --
The type of this child entity.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ParentNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to request a list of the child OUs in a parent root or OU:/n/n
response = client.list_children(
ChildType='ORGANIZATIONAL_UNIT',
ParentId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'Children': [
{
'Id': 'ou-examplerootid111-exampleouid111',
'Type': 'ORGANIZATIONAL_UNIT',
},
{
'Id': 'ou-examplerootid111-exampleouid222',
'Type': 'ORGANIZATIONAL_UNIT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_create_account_status(**kwargs)¶Lists the account creation requests that match the specified status that is currently being tracked for the organization.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_create_account_status(
States=[
'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
],
NextToken='string',
MaxResults=123
)
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.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'CreateAccountStatuses': [
{
'Id': 'string',
'AccountName': 'string',
'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'RequestedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'GovCloudAccountId': 'string',
'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INVALID_EMAIL'|'CONCURRENT_ACCOUNT_MODIFICATION'|'INTERNAL_FAILURE'|'GOVCLOUD_ACCOUNT_ALREADY_EXISTS'|'MISSING_BUSINESS_VALIDATION'|'FAILED_BUSINESS_VALIDATION'|'PENDING_BUSINESS_VALIDATION'|'INVALID_IDENTITY_FOR_BUSINESS_VALIDATION'|'UNKNOWN_BUSINESS_VALIDATION'|'MISSING_PAYMENT_INSTRUMENT'|'INVALID_PAYMENT_INSTRUMENT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CreateAccountStatuses (list) --
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.
(dict) --
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.
Id (string) --
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 lowercase letters or digits.
AccountName (string) --
The account name given to the account when it was created.
State (string) --
The status of the asynchronous request to create an Amazon Web Services account.
RequestedTimestamp (datetime) --
The date and time that the request was made for the account creation.
CompletedTimestamp (datetime) --
The date and time that the account was created and the request completed.
AccountId (string) --
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.
GovCloudAccountId (string) --
If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.
FailureReason (string) --
If the request failed, a description of the reason for the failure.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows a user requesting a list of only the completed account creation requests made for the current organization:
response = client.list_create_account_status(
States=[
'SUCCEEDED',
],
)
print(response)
Expected Output:
{
'CreateAccountStatuses': [
{
'AccountId': '444444444444',
'AccountName': 'Developer Test Account',
'CompletedTimestamp': datetime(2017, 1, 15, 13, 45, 23, 6, 15, 0),
'Id': 'car-exampleaccountcreationrequestid1',
'RequestedTimestamp': datetime(2017, 1, 15, 13, 45, 23, 6, 15, 0),
'State': 'SUCCEEDED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:
response = client.list_create_account_status(
States=[
'IN_PROGRESS',
],
)
print(response)
Expected Output:
{
'CreateAccountStatuses': [
{
'AccountName': 'Production Account',
'Id': 'car-exampleaccountcreationrequestid2',
'RequestedTimestamp': datetime(2017, 1, 15, 13, 45, 23, 6, 15, 0),
'State': 'IN_PROGRESS',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_delegated_administrators(**kwargs)¶Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_delegated_administrators(
ServicePrincipal='string',
NextToken='string',
MaxResults=123
)
Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.
If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'DelegatedAdministrators': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1),
'DelegationEnabledDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DelegatedAdministrators (list) --
The list of delegated administrators in your organization.
(dict) --
Contains information about the delegated administrator.
Id (string) --
The unique identifier (ID) of the delegated administrator's account.
Arn (string) --
The Amazon Resource Name (ARN) of the delegated administrator's account.
Email (string) --
The email address that is associated with the delegated administrator's Amazon Web Services account.
Name (string) --
The friendly name of the delegated administrator's account.
Status (string) --
The status of the delegated administrator's account in the organization.
JoinedMethod (string) --
The method by which the delegated administrator's account joined the organization.
JoinedTimestamp (datetime) --
The date when the delegated administrator's account became a part of the organization.
DelegationEnabledDate (datetime) --
The date when the account was made a delegated administrator.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionlist_delegated_services_for_account(**kwargs)¶List the Amazon Web Services services for which the specified account is a delegated administrator.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_delegated_services_for_account(
AccountId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The account ID number of a delegated administrator account in the organization.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'DelegatedServices': [
{
'ServicePrincipal': 'string',
'DelegationEnabledDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DelegatedServices (list) --
The services for which the account is a delegated administrator.
(dict) --
Contains information about the Amazon Web Services service for which the account is a delegated administrator.
ServicePrincipal (string) --
The name of an Amazon Web Services service that can request an operation for the specified service. This is typically in the form of a URL, such as: `` servicename .amazonaws.com`` .
DelegationEnabledDate (datetime) --
The date that the account became a delegated administrator for this service.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AccountNotRegisteredExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionlist_handshakes_for_account(**kwargs)¶Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED , DECLINED , CANCELED , or EXPIRED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called from any account in the organization.
See also: AWS API Documentation
Request Syntax
response = client.list_handshakes_for_account(
Filter={
'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'ParentHandshakeId': 'string'
},
NextToken='string',
MaxResults=123
)
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, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
Specifies the type of handshake action.
If you specify ActionType , you cannot also specify 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 lowercase letters or digits.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Handshakes': [
{
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Handshakes (list) --
A list of Handshake objects with details about each of the handshakes that is associated with the specified account.
(dict) --
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient ). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are
CANCELED,ACCEPTED,DECLINED, orEXPIREDshow up in lists for only 30 days after entering that state After that they are deleted.
Id (string) --
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 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Parties (list) --
Information about the two accounts that are participating in the handshake.
(dict) --
Identifies a participant in a handshake.
Id (string) --
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Type (string) --
The type of party.
State (string) --
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:
RequestedTimestamp (datetime) --
The date and time that the handshake request was made.
ExpirationTimestamp (datetime) --
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.
Action (string) --
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Resources (list) --
Additional information that is needed to process the handshake.
(dict) --
Contains additional data that is needed to process a handshake.
Value (string) --
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.
Type (string) --
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.Resources (list) --
When needed, contains an additional array of HandshakeResource objects.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:
response = client.list_handshakes_for_account(
)
print(response)
Expected Output:
{
'Handshakes': [
{
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 1, 28, 14, 35, 23, 5, 28, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 1, 13, 14, 35, 23, 4, 13, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@amazon.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Org Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'FULL',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'EMAIL',
'Value': 'juan@example.com',
},
],
'State': 'OPEN',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_handshakes_for_organization(**kwargs)¶Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED , DECLINED , CANCELED , or EXPIRED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_handshakes_for_organization(
Filter={
'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'ParentHandshakeId': 'string'
},
NextToken='string',
MaxResults=123
)
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, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
Specifies the type of handshake action.
If you specify ActionType , you cannot also specify 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 lowercase letters or digits.
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Handshakes': [
{
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Handshakes (list) --
A list of Handshake objects with details about each of the handshakes that are associated with an organization.
(dict) --
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient ). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are
CANCELED,ACCEPTED,DECLINED, orEXPIREDshow up in lists for only 30 days after entering that state After that they are deleted.
Id (string) --
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 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Parties (list) --
Information about the two accounts that are participating in the handshake.
(dict) --
Identifies a participant in a handshake.
Id (string) --
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Type (string) --
The type of party.
State (string) --
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:
RequestedTimestamp (datetime) --
The date and time that the handshake request was made.
ExpirationTimestamp (datetime) --
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.
Action (string) --
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Resources (list) --
Additional information that is needed to process the handshake.
(dict) --
Contains additional data that is needed to process a handshake.
Value (string) --
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.
Type (string) --
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.Resources (list) --
When needed, contains an additional array of HandshakeResource objects.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows you how to get a list of handshakes associated with the current organization:
response = client.list_handshakes_for_organization(
)
print(response)
Expected Output:
{
'Handshakes': [
{
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 1, 28, 14, 35, 23, 5, 28, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 1, 13, 14, 35, 23, 4, 13, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@amazon.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Org Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'FULL',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'EMAIL',
'Value': 'juan@example.com',
},
],
'State': 'OPEN',
},
{
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 1, 28, 14, 35, 23, 5, 28, 0),
'Id': 'h-examplehandshakeid222',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'anika@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 1, 13, 14, 35, 23, 4, 13, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@example.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Master Account',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'EMAIL',
'Value': 'anika@example.com',
},
{
'Type': 'NOTES',
'Value': 'This is an invitation to Anika's account to join Bill's organization.',
},
],
'State': 'ACCEPTED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_organizational_units_for_parent(**kwargs)¶Lists the organizational units (OUs) in a parent organizational unit or root.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_organizational_units_for_parent(
ParentId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
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:
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'OrganizationalUnits': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationalUnits (list) --
A list of the OUs in the specified root or parent OU.
(dict) --
Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
Id (string) --
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 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.
Arn (string) --
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ParentNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to get a list of OUs in a specified root:/n/n
response = client.list_organizational_units_for_parent(
ParentId='r-examplerootid111',
)
print(response)
Expected Output:
{
'OrganizationalUnits': [
{
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111',
'Id': 'ou-examplerootid111-exampleouid111',
'Name': 'Development',
},
{
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222',
'Id': 'ou-examplerootid111-exampleouid222',
'Name': 'Production',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_parents(**kwargs)¶Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
Note
In the current release, a child can have only a single parent.
See also: AWS API Documentation
Request Syntax
response = client.list_parents(
ChildId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
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:
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Parents': [
{
'Id': 'string',
'Type': 'ROOT'|'ORGANIZATIONAL_UNIT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Parents (list) --
A list of parents for the specified child account or OU.
(dict) --
Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.
Id (string) --
The unique identifier (ID) of the parent entity.
The regex pattern for a parent ID string requires one of the following:
Type (string) --
The type of the parent entity.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ChildNotFoundExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to list the root or OUs that contain account 444444444444:/n/n
response = client.list_parents(
ChildId='444444444444',
)
print(response)
Expected Output:
{
'Parents': [
{
'Id': 'ou-examplerootid111-exampleouid111',
'Type': 'ORGANIZATIONAL_UNIT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_policies(**kwargs)¶Retrieves the list of all policies in an organization of a specified type.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_policies(
Filter='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
NextToken='string',
MaxResults=123
)
[REQUIRED]
Specifies the type of policy that you want to include in the response. You must specify one of the following values:
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Policies': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Policies (list) --
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 .
(dict) --
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy .
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to get a list of service control policies (SCPs):/n/n
response = client.list_policies(
Filter='SERVICE_CONTROL_POLICY',
)
print(response)
Expected Output:
{
'Policies': [
{
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
'AwsManaged': False,
'Description': 'Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts.',
'Id': 'p-examplepolicyid111',
'Name': 'AllowAllS3Actions',
'Type': 'SERVICE_CONTROL_POLICY',
},
{
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222',
'AwsManaged': False,
'Description': 'Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.',
'Id': 'p-examplepolicyid222',
'Name': 'AllowAllEC2Actions',
'Type': 'SERVICE_CONTROL_POLICY',
},
{
'Arn': 'arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess',
'AwsManaged': True,
'Description': 'Allows access to every operation',
'Id': 'p-FullAWSAccess',
'Name': 'FullAWSAccess',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_policies_for_target(**kwargs)¶Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_policies_for_target(
TargetId='string',
Filter='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
NextToken='string',
MaxResults=123
)
[REQUIRED]
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:
[REQUIRED]
The type of policy that you want to include in the returned list. You must specify one of the following values:
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Policies': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Policies (list) --
The list of policies that match the criteria in the request.
(dict) --
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy .
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n
response = client.list_policies_for_target(
Filter='SERVICE_CONTROL_POLICY',
TargetId='444444444444',
)
print(response)
Expected Output:
{
'Policies': [
{
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222',
'AwsManaged': False,
'Description': 'Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.',
'Id': 'p-examplepolicyid222',
'Name': 'AllowAllEC2Actions',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_roots(**kwargs)¶Lists the roots that are defined in the current organization.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
Note
Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization .
See also: AWS API Documentation
Request Syntax
response = client.list_roots(
NextToken='string',
MaxResults=123
)
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Roots': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'PolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Roots (list) --
A list of roots that are defined in an organization.
(dict) --
Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every Amazon Web Services account in the organization.
Id (string) --
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
PolicyTypes (list) --
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.
Note
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.
(dict) --
Contains information about a policy type and its status in the associated root.
Type (string) --
The name of the policy type.
Status (string) --
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to get the list of the roots in the current organization:/n/n
response = client.list_roots(
)
print(response)
Expected Output:
{
'Roots': [
{
'Arn': 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
'Id': 'r-examplerootid111',
'Name': 'Root',
'PolicyTypes': [
{
'Status': 'ENABLED',
'Type': 'SERVICE_CONTROL_POLICY',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists tags that are attached to the specified resource.
You can attach tags to the following resources in Organizations.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceId='string',
NextToken='string'
)
[REQUIRED]
The ID of the resource with the tags to list.
You can specify any of the following taggable resources.
ou- and looks similar to: ``ou-1a2b-34uvwxyz ``r- and looks similar to: ``r-1a2b ``p- andlooks similar to: ``p-12abcdefg3 ``NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The tags that are assigned to the resource.
(dict) --
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionlist_targets_for_policy(**kwargs)¶Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
Note
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_targets_for_policy(
PolicyId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
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 (_).
NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.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.dict
Response Syntax
{
'Targets': [
{
'TargetId': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'|'ROOT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
(dict) --
Contains information about a root, OU, or account that a policy is attached to.
TargetId (string) --
The unique identifier (ID) of the policy target.
The regex pattern for a target ID string requires one of the following:
Arn (string) --
The Amazon Resource Name (ARN) of the policy target.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Type (string) --
The type of the policy target.
NextToken (string) --
If present, indicates that more output is 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 .
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionExamples
The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n
response = client.list_targets_for_policy(
PolicyId='p-FullAWSAccess',
)
print(response)
Expected Output:
{
'Targets': [
{
'Arn': 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
'Name': 'Root',
'TargetId': 'r-examplerootid111',
'Type': 'ROOT',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;',
'Name': 'Developer Test Account',
'TargetId': '333333333333',
'Type': 'ACCOUNT',
},
{
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
'Name': 'Accounting',
'TargetId': 'ou-examplerootid111-exampleouid111',
'Type': 'ORGANIZATIONAL_UNIT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
move_account(**kwargs)¶Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.move_account(
AccountId='string',
SourceParentId='string',
DestinationParentId='string'
)
[REQUIRED]
The unique identifier (ID) of the account that you want to move.
The regex pattern for an account ID string requires exactly 12 digits.
[REQUIRED]
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:
[REQUIRED]
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:
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.SourceParentNotFoundExceptionOrganizations.Client.exceptions.DestinationParentNotFoundExceptionOrganizations.Client.exceptions.DuplicateAccountExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ServiceExceptionExamples
The following example shows how to move a member account from the root to an OU:/n/n
response = client.move_account(
AccountId='333333333333',
DestinationParentId='ou-examplerootid111-exampleouid111',
SourceParentId='r-examplerootid111',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
register_delegated_administrator(**kwargs)¶Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service.
You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.register_delegated_administrator(
AccountId='string',
ServicePrincipal='string'
)
[REQUIRED]
The account ID number of the member account in the organization to register as a delegated administrator.
[REQUIRED]
The service principal of the Amazon Web Services service for which you want to make the member account a delegated administrator.
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountAlreadyRegisteredExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionremove_account_from_organization(**kwargs)¶Removes the specified account from the organization.
The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization.
This operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead.
Warning
See also: AWS API Documentation
Request Syntax
response = client.remove_account_from_organization(
AccountId='string'
)
[REQUIRED]
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.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AccountNotFoundExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.MasterCannotLeaveOrganizationExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows you how to remove an account from an organization:
response = client.remove_account_from_organization(
AccountId='333333333333',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
tag_resource(**kwargs)¶Adds one or more tags to the specified resource.
Currently, you can attach tags to the following resources in Organizations.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the resource to add a tag to.
You can specify any of the following taggable resources.
ou- and looks similar to: ``ou-1a2b-34uvwxyz ``r- and looks similar to: ``r-1a2b ``p- andlooks similar to: ``p-12abcdefg3 ``[REQUIRED]
A list of tags to add to the specified resource.
For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to null .
Note
If any one of the tags is invalid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
The key identifier, or name, of the tag.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionuntag_resource(**kwargs)¶Removes any tags with the specified keys from the specified resource.
You can attach tags to the following resources in Organizations.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ID of the resource to remove a tag from.
You can specify any of the following taggable resources.
ou- and looks similar to: ``ou-1a2b-34uvwxyz ``r- and looks similar to: ``r-1a2b ``p- andlooks similar to: ``p-12abcdefg3 ``[REQUIRED]
The list of keys for tags to remove from the specified resource.
None
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.TargetNotFoundExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionupdate_organizational_unit(**kwargs)¶Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.update_organizational_unit(
OrganizationalUnitId='string',
Name='string'
)
[REQUIRED]
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.
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.
dict
Response Syntax
{
'OrganizationalUnit': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
OrganizationalUnit (dict) --
A structure that contains the details about the specified OU, including its new name.
Id (string) --
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 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.
Arn (string) --
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.DuplicateOrganizationalUnitExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.OrganizationalUnitNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
The following example shows how to rename an OU. The output confirms the new name:/n/n
response = client.update_organizational_unit(
Name='AccountingOU',
OrganizationalUnitId='ou-examplerootid111-exampleouid111',
)
print(response)
Expected Output:
{
'OrganizationalUnit': {
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
'Id': 'ou-examplerootid111-exampleouid111',
'Name': 'AccountingOU',
},
'ResponseMetadata': {
'...': '...',
},
}
update_policy(**kwargs)¶Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.
This operation can be called only from the organization's management account.
See also: AWS API Documentation
Request Syntax
response = client.update_policy(
PolicyId='string',
Name='string',
Description='string',
Content='string'
)
[REQUIRED]
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 (_).
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.
dict
Response Syntax
{
'Policy': {
'PolicySummary': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
'Content': 'string'
}
}
Response Structure
(dict) --
Policy (dict) --
A structure that contains details about the updated policy, showing the requested changes.
PolicySummary (dict) --
A structure that contains additional details about the policy.
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
Content (string) --
The text content of the policy.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.AWSOrganizationsNotInUseExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.ConstraintViolationExceptionOrganizations.Client.exceptions.DuplicatePolicyExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.MalformedPolicyDocumentExceptionOrganizations.Client.exceptions.PolicyNotFoundExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionOrganizations.Client.exceptions.UnsupportedAPIEndpointExceptionOrganizations.Client.exceptions.PolicyChangesInProgressExceptionExamples
The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n
response = client.update_policy(
Description='This description replaces the original.',
Name='Renamed-Policy',
PolicyId='p-examplepolicyid111',
)
print(response)
Expected Output:
{
'Policy': {
'Content': '{ "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Action": "ec2:*", "Resource": "*" } }',
'PolicySummary': {
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
'AwsManaged': False,
'Description': 'This description replaces the original.',
'Id': 'p-examplepolicyid111',
'Name': 'Renamed-Policy',
'Type': 'SERVICE_CONTROL_POLICY',
},
},
'ResponseMetadata': {
'...': '...',
},
}
The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n
response = client.update_policy(
Content='{ \"Version\": \"2012-10-17\", \"Statement\": {\"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }',
PolicyId='p-examplepolicyid111',
)
print(response)
Expected Output:
{
'Policy': {
'Content': '{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }',
'PolicySummary': {
'Arn': 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
'AwsManaged': False,
'Description': 'This description replaces the original.',
'Id': 'p-examplepolicyid111',
'Name': 'Renamed-Policy',
'Type': 'SERVICE_CONTROL_POLICY',
},
},
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
Organizations.Paginator.ListAWSServiceAccessForOrganizationOrganizations.Paginator.ListAccountsOrganizations.Paginator.ListAccountsForParentOrganizations.Paginator.ListChildrenOrganizations.Paginator.ListCreateAccountStatusOrganizations.Paginator.ListDelegatedAdministratorsOrganizations.Paginator.ListDelegatedServicesForAccountOrganizations.Paginator.ListHandshakesForAccountOrganizations.Paginator.ListHandshakesForOrganizationOrganizations.Paginator.ListOrganizationalUnitsForParentOrganizations.Paginator.ListParentsOrganizations.Paginator.ListPoliciesOrganizations.Paginator.ListPoliciesForTargetOrganizations.Paginator.ListRootsOrganizations.Paginator.ListTagsForResourceOrganizations.Paginator.ListTargetsForPolicyOrganizations.Paginator.ListAWSServiceAccessForOrganization¶paginator = client.get_paginator('list_aws_service_access_for_organization')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_aws_service_access_for_organization().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'EnabledServicePrincipals': [
{
'ServicePrincipal': 'string',
'DateEnabled': datetime(2015, 1, 1)
},
],
}
Response Structure
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 Organizations.
A structure that contains details of a service principal that represents an Amazon Web Services service that is enabled to integrate with Organizations.
The name of the service principal. This is typically in the form of a URL, such as: `` servicename .amazonaws.com`` .
The date that the service principal was enabled for integration with Organizations.
Organizations.Paginator.ListAccounts¶paginator = client.get_paginator('list_accounts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_accounts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Accounts': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
A list of objects in the organization.
Contains information about an Amazon Web Services account that is a member of an organization.
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
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.
The status of the account in the organization.
The method by which the account joined the organization.
The date the account became a part of the organization.
Organizations.Paginator.ListAccountsForParent¶paginator = client.get_paginator('list_accounts_for_parent')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_accounts_for_parent().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParentId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Accounts': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Accounts (list) --
A list of the accounts in the specified root or OU.
(dict) --
Contains information about an Amazon Web Services account that is a member of an organization.
Id (string) --
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
Arn (string) --
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Email (string) --
The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
Name (string) --
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.
Status (string) --
The status of the account in the organization.
JoinedMethod (string) --
The method by which the account joined the organization.
JoinedTimestamp (datetime) --
The date the account became a part of the organization.
Organizations.Paginator.ListChildren¶paginator = client.get_paginator('list_children')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_children().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParentId='string',
ChildType='ACCOUNT'|'ORGANIZATIONAL_UNIT',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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:
[REQUIRED]
Filters the output to include only the specified child type.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Children': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'
},
],
}
Response Structure
(dict) --
Children (list) --
The list of children of the specified parent container.
(dict) --
Contains a list of child entities, either OUs or accounts.
Id (string) --
The unique identifier (ID) of this child entity.
The regex pattern for a child ID string requires one of the following:
Type (string) --
The type of this child entity.
Organizations.Paginator.ListCreateAccountStatus¶paginator = client.get_paginator('list_create_account_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_create_account_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
States=[
'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CreateAccountStatuses': [
{
'Id': 'string',
'AccountName': 'string',
'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'RequestedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'GovCloudAccountId': 'string',
'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INVALID_EMAIL'|'CONCURRENT_ACCOUNT_MODIFICATION'|'INTERNAL_FAILURE'|'GOVCLOUD_ACCOUNT_ALREADY_EXISTS'|'MISSING_BUSINESS_VALIDATION'|'FAILED_BUSINESS_VALIDATION'|'PENDING_BUSINESS_VALIDATION'|'INVALID_IDENTITY_FOR_BUSINESS_VALIDATION'|'UNKNOWN_BUSINESS_VALIDATION'|'MISSING_PAYMENT_INSTRUMENT'|'INVALID_PAYMENT_INSTRUMENT'
},
],
}
Response Structure
(dict) --
CreateAccountStatuses (list) --
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.
(dict) --
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.
Id (string) --
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 lowercase letters or digits.
AccountName (string) --
The account name given to the account when it was created.
State (string) --
The status of the asynchronous request to create an Amazon Web Services account.
RequestedTimestamp (datetime) --
The date and time that the request was made for the account creation.
CompletedTimestamp (datetime) --
The date and time that the account was created and the request completed.
AccountId (string) --
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.
GovCloudAccountId (string) --
If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.
FailureReason (string) --
If the request failed, a description of the reason for the failure.
Organizations.Paginator.ListDelegatedAdministrators¶paginator = client.get_paginator('list_delegated_administrators')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_delegated_administrators().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServicePrincipal='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.
If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DelegatedAdministrators': [
{
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1),
'DelegationEnabledDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
DelegatedAdministrators (list) --
The list of delegated administrators in your organization.
(dict) --
Contains information about the delegated administrator.
Id (string) --
The unique identifier (ID) of the delegated administrator's account.
Arn (string) --
The Amazon Resource Name (ARN) of the delegated administrator's account.
Email (string) --
The email address that is associated with the delegated administrator's Amazon Web Services account.
Name (string) --
The friendly name of the delegated administrator's account.
Status (string) --
The status of the delegated administrator's account in the organization.
JoinedMethod (string) --
The method by which the delegated administrator's account joined the organization.
JoinedTimestamp (datetime) --
The date when the delegated administrator's account became a part of the organization.
DelegationEnabledDate (datetime) --
The date when the account was made a delegated administrator.
Organizations.Paginator.ListDelegatedServicesForAccount¶paginator = client.get_paginator('list_delegated_services_for_account')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_delegated_services_for_account().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AccountId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The account ID number of a delegated administrator account in the organization.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DelegatedServices': [
{
'ServicePrincipal': 'string',
'DelegationEnabledDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
DelegatedServices (list) --
The services for which the account is a delegated administrator.
(dict) --
Contains information about the Amazon Web Services service for which the account is a delegated administrator.
ServicePrincipal (string) --
The name of an Amazon Web Services service that can request an operation for the specified service. This is typically in the form of a URL, such as: `` servicename .amazonaws.com`` .
DelegationEnabledDate (datetime) --
The date that the account became a delegated administrator for this service.
Organizations.Paginator.ListHandshakesForAccount¶paginator = client.get_paginator('list_handshakes_for_account')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_handshakes_for_account().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'ParentHandshakeId': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
Specifies the type of handshake action.
If you specify ActionType , you cannot also specify 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 lowercase letters or digits.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Handshakes': [
{
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
},
],
}
Response Structure
(dict) --
Handshakes (list) --
A list of Handshake objects with details about each of the handshakes that is associated with the specified account.
(dict) --
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient ). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are
CANCELED,ACCEPTED,DECLINED, orEXPIREDshow up in lists for only 30 days after entering that state After that they are deleted.
Id (string) --
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 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Parties (list) --
Information about the two accounts that are participating in the handshake.
(dict) --
Identifies a participant in a handshake.
Id (string) --
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Type (string) --
The type of party.
State (string) --
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:
RequestedTimestamp (datetime) --
The date and time that the handshake request was made.
ExpirationTimestamp (datetime) --
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.
Action (string) --
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Resources (list) --
Additional information that is needed to process the handshake.
(dict) --
Contains additional data that is needed to process a handshake.
Value (string) --
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.
Type (string) --
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.Resources (list) --
When needed, contains an additional array of HandshakeResource objects.
Organizations.Paginator.ListHandshakesForOrganization¶paginator = client.get_paginator('list_handshakes_for_organization')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_handshakes_for_organization().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'ParentHandshakeId': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
Specifies the type of handshake action.
If you specify ActionType , you cannot also specify 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 lowercase letters or digits.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Handshakes': [
{
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
},
],
}
Response Structure
(dict) --
Handshakes (list) --
A list of Handshake objects with details about each of the handshakes that are associated with an organization.
(dict) --
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient ). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are
CANCELED,ACCEPTED,DECLINED, orEXPIREDshow up in lists for only 30 days after entering that state After that they are deleted.
Id (string) --
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 lowercase letters or digits.
Arn (string) --
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Parties (list) --
Information about the two accounts that are participating in the handshake.
(dict) --
Identifies a participant in a handshake.
Id (string) --
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Type (string) --
The type of party.
State (string) --
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:
RequestedTimestamp (datetime) --
The date and time that the handshake request was made.
ExpirationTimestamp (datetime) --
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.
Action (string) --
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Resources (list) --
Additional information that is needed to process the handshake.
(dict) --
Contains additional data that is needed to process a handshake.
Value (string) --
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.
Type (string) --
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.Resources (list) --
When needed, contains an additional array of HandshakeResource objects.
Organizations.Paginator.ListOrganizationalUnitsForParent¶paginator = client.get_paginator('list_organizational_units_for_parent')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_organizational_units_for_parent().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParentId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationalUnits': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
OrganizationalUnits (list) --
A list of the OUs in the specified root or parent OU.
(dict) --
Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
Id (string) --
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 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.
Arn (string) --
The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Organizations.Paginator.ListParents¶paginator = client.get_paginator('list_parents')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_parents().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ChildId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Parents': [
{
'Id': 'string',
'Type': 'ROOT'|'ORGANIZATIONAL_UNIT'
},
],
}
Response Structure
(dict) --
Parents (list) --
A list of parents for the specified child account or OU.
(dict) --
Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.
Id (string) --
The unique identifier (ID) of the parent entity.
The regex pattern for a parent ID string requires one of the following:
Type (string) --
The type of the parent entity.
Organizations.Paginator.ListPolicies¶paginator = client.get_paginator('list_policies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Specifies the type of policy that you want to include in the response. You must specify one of the following values:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Policies': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
],
}
Response Structure
(dict) --
Policies (list) --
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 .
(dict) --
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy .
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
Organizations.Paginator.ListPoliciesForTarget¶paginator = client.get_paginator('list_policies_for_target')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_policies_for_target().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TargetId='string',
Filter='SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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:
[REQUIRED]
The type of policy that you want to include in the returned list. You must specify one of the following values:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Policies': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'AwsManaged': True|False
},
],
}
Response Structure
(dict) --
Policies (list) --
The list of policies that match the criteria in the request.
(dict) --
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy .
Id (string) --
The unique identifier (ID) of the policy.
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 (_).
Arn (string) --
The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Description (string) --
The description of the policy.
Type (string) --
The type of policy.
AwsManaged (boolean) --
A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
Organizations.Paginator.ListRoots¶paginator = client.get_paginator('list_roots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_roots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Roots': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'PolicyTypes': [
{
'Type': 'SERVICE_CONTROL_POLICY'|'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY',
'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
},
]
},
],
}
Response Structure
A list of roots that are defined in an organization.
Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every Amazon Web Services account in the organization.
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
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.
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.
Note
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.
Contains information about a policy type and its status in the associated root.
The name of the policy type.
The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
Organizations.Paginator.ListTagsForResource¶paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceId='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the resource with the tags to list.
You can specify any of the following taggable resources.
ou- and looks similar to: ``ou-1a2b-34uvwxyz ``r- and looks similar to: ``r-1a2b ``p- andlooks similar to: ``p-12abcdefg3 ``A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
The tags that are assigned to the resource.
(dict) --
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
Organizations.Paginator.ListTargetsForPolicy¶paginator = client.get_paginator('list_targets_for_policy')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Organizations.Client.list_targets_for_policy().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PolicyId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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 (_).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Targets': [
{
'TargetId': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'|'ROOT'
},
],
}
Response Structure
(dict) --
Targets (list) --
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
(dict) --
Contains information about a root, OU, or account that a policy is attached to.
TargetId (string) --
The unique identifier (ID) of the policy target.
The regex pattern for a target ID string requires one of the following:
Arn (string) --
The Amazon Resource Name (ARN) of the policy target.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
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.
Type (string) --
The type of the policy target.