2022/03/29 - AWS Organizations - 1 new4 updated api methods
Changes This release provides the new CloseAccount API that enables principals in the management account to close any member account within an organization.
Closes an Amazon Web Services account that is now a part of an Organizations, either created within the organization, or invited to join the organization.
See also: AWS API Documentation
Request Syntax
client.close_account(
AccountId='string'
)
string
[REQUIRED]
Retrieves the Amazon Web Services account Id for the current CloseAccount API request.
None
{'Account': {'Status': {'PENDING_CLOSURE'}}}
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
client.describe_account(
AccountId='string'
)
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.
dict
Response Syntax
{
'Account': {
'Id': 'string',
'Arn': 'string',
'Email': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
'JoinedMethod': 'INVITED'|'CREATED',
'JoinedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Account (dict) --
A structure that contains information about the requested account.
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.
{'Accounts': {'Status': {'PENDING_CLOSURE'}}}
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.
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
client.list_accounts(
NextToken='string',
MaxResults=123
)
string
The parameter for receiving additional results if you receive a 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.
integer
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
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.
{'Accounts': {'Status': {'PENDING_CLOSURE'}}}
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.
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
client.list_accounts_for_parent(
ParentId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
string
The parameter for receiving additional results if you receive a 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.
integer
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
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.
{'DelegatedAdministrators': {'Status': {'PENDING_CLOSURE'}}}
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
client.list_delegated_administrators(
ServicePrincipal='string',
NextToken='string',
MaxResults=123
)
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.
string
The parameter for receiving additional results if you receive a 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.
integer
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
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.