AWS API Changes

2017/02/27 - AWS Organizations - 39 new api methods

Changes Update organizations client to latest version

DetachPolicy (new)

Link ¶

Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.

Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. 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), then you are using the authorization strategy of blacklisting.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.detach_policy(
    PolicyId='string',
    TargetId='string'
)

type PolicyId:

string

param PolicyId:

[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 lower-case letters or digits.

type TargetId:

string

param TargetId:

[REQUIRED]

The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Account: a string that consists of exactly 12 digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

returns:

None

ListTargetsForPolicy (new)

Link ¶

Lists all the roots, OUs, and accounts to which the specified policy is attached.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_targets_for_policy(
    PolicyId='string',
    NextToken='string',
    MaxResults=123
)

type PolicyId:

string

param PolicyId:

[REQUIRED]

The unique identifier (ID) of the policy for which you want to know its attachments.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

type NextToken:

string

param NextToken:

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

type MaxResults:

integer

param MaxResults:

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

rtype:

dict

returns:

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:
      - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
      - Account: a string that consists of exactly 12 digits.
      - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

ListAccounts (new)

Link ¶

Lists all the accounts in the organization. To request only the accounts in a root or OU, use the ListAccountsForParent operation instead.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_accounts(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'Accounts': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'SUSPENDED',
            '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 AWS 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 AWS Organizations User Guide.
    - 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, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

DescribeAccount (new)

Link ¶

Retrieves Organizations-related information about the specified account.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.describe_account(
    AccountId='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

The regex pattern for an account ID string requires exactly 12 digits.

rtype:

dict

returns:

Response Syntax

{
    'Account': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Status': 'ACTIVE'|'SUSPENDED',
        '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 AWS Organizations User Guide.
  - 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.

DescribeOrganizationalUnit (new)

Link ¶

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.describe_organizational_unit(
    OrganizationalUnitId='string'
)

type OrganizationalUnitId:

string

param OrganizationalUnitId:

[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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

rtype:

dict

returns:

Response Syntax

{
    'OrganizationalUnit': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string'
    }
}

Response Structure

(dict) --
- OrganizationalUnit (dict) --
  
  A structure that contains details about the specified 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
  - 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.

AttachPolicy (new)

Link ¶

Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:

Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:
- If you attach an SCP to a root, it affects all accounts in the organization.
- If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.
- If you attach the policy directly to an account, then it affects only that account.

SCPs essentially are permission "filters". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.

AWS Organizations attaches a default SCP named "FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.

For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.attach_policy(
    PolicyId='string',
    TargetId='string'
)

type PolicyId:

string

param PolicyId:

[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 lower-case letters or digits.

type TargetId:

string

param TargetId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Account: a string that consists of exactly 12 digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

returns:

None

DeleteOrganizationalUnit (new)

Link ¶

Deletes an organizational unit 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 master account.

See also: AWS API Documentation

Request Syntax

client.delete_organizational_unit(
    OrganizationalUnitId='string'
)

type OrganizationalUnitId:

string

param OrganizationalUnitId:

[REQUIRED]

The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.

returns:

None

ListHandshakesForOrganization (new)

Link ¶

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.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_handshakes_for_organization(
    Filter={
        'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES',
        'ParentHandshakeId': 'string'
    },
    NextToken='string',
    MaxResults=123
)

type Filter:

dict

param Filter:

A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, 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.

ActionType (string) --

Specifies the type of handshake action.

If you specify ActionType, you cannot also specify ParentHandshakeId.
ParentHandshakeId (string) --

Specifies the parent handshake. Only used for handshake types that are a child of another type.

If you specify ParentHandshakeId, you cannot also specify ActionType.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

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',
            '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 master 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.
    - 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 lower-case 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 AWS Organizations User Guide.
    - 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 lower-case 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:
      - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
      - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
      - CANCELED: This handshake is no longer active because it was canceled by the originating account.
      - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
      - DECLINED: This handshake is no longer active because it was declined by the recipient account.
      - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    - 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.
    - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
        
        Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

RemoveAccountFromOrganization (new)

Link ¶

Removes the specified account from the organization.

The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

See also: AWS API Documentation

Request Syntax

client.remove_account_from_organization(
    AccountId='string'
)

type AccountId:

string

param AccountId:

[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.

returns:

None

ListRoots (new)

Link ¶

Lists the roots that are defined in the current organization.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_roots(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'Roots': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'PolicyTypes': [
                {
                    'Type': 'SERVICE_CONTROL_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. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.
    - 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 lower-case 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 AWS Organizations User Guide.
    - 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.
      - (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, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

LeaveOrganization (new)

Link ¶

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 master account, use RemoveAccountFromOrganization instead.

This operation can be called only from a member account in the organization.

See also: AWS API Documentation

Request Syntax

client.leave_organization()

returns:: None

ListPolicies (new)

Link ¶

Retrieves the list of all policies in an organization of a specified type.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_policies(
    Filter='SERVICE_CONTROL_POLICY',
    NextToken='string',
    MaxResults=123
)

type Filter:

string

param Filter:

[REQUIRED]

Specifies the type of policy that you want to include in the response.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'Policies': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'SERVICE_CONTROL_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 does not 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 lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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 AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

DescribeCreateAccountStatus (new)

Link ¶

Retrieves the current status of an asynchronous request to create an account.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.describe_create_account_status(
    CreateAccountRequestId='string'
)

type CreateAccountRequestId:

string

param CreateAccountRequestId:

[REQUIRED]

Specifies the operationId that uniquely identifies the request. You can get the ID from the response to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

rtype:

dict

returns:

Response Syntax

{
    'CreateAccountStatus': {
        'Id': 'string',
        'AccountName': 'string',
        'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'RequestedTimestamp': datetime(2015, 1, 1),
        'CompletedTimestamp': datetime(2015, 1, 1),
        'AccountId': 'string',
        'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INTERNAL_FAILURE'
    }
}

Response Structure

(dict) --
- CreateAccountStatus (dict) --
  
  A structure that contains the current status of an account creation request.
  - 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 an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.
  - AccountName (string) --
    
    The account name given to the account when it was created.
  - State (string) --
    
    The status of the request.
  - 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.
  - FailureReason (string) --
    
    If the request failed, a description of the reason for the failure.

ListCreateAccountStatus (new)

Link ¶

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_create_account_status(
    States=[
        'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    ],
    NextToken='string',
    MaxResults=123
)

type States:

list

param States:

A list of one or more states that you want included in the response. If this parameter is not present, then all requests are included in the response.

(string) --

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'CreateAccountStatuses': [
        {
            'Id': 'string',
            'AccountName': 'string',
            'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
            'RequestedTimestamp': datetime(2015, 1, 1),
            'CompletedTimestamp': datetime(2015, 1, 1),
            'AccountId': 'string',
            'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INTERNAL_FAILURE'
        },
    ],
    '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 request to create an AWS 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 an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.
    - AccountName (string) --
      
      The account name given to the account when it was created.
    - State (string) --
      
      The status of the request.
    - 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.
    - FailureReason (string) --
      
      If the request failed, a description of the reason for the failure.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

UpdatePolicy (new)

Link ¶

Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.update_policy(
    PolicyId='string',
    Name='string',
    Description='string',
    Content='string'
)

type PolicyId:

string

param PolicyId:

[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 lower-case letters or digits.

type Name:

string

param Name:

If provided, the new name for the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

type Description:

string

param Description:

If provided, the new description for the policy.

type Content:

string

param Content:

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide.

rtype:

dict

returns:

Response Syntax

{
    'Policy': {
        'PolicySummary': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'SERVICE_CONTROL_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 lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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 AWS 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.

DescribePolicy (new)

Link ¶

Retrieves information about a policy.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.describe_policy(
    PolicyId='string'
)

type PolicyId:

string

param PolicyId:

[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 lower-case letters or digits.

rtype:

dict

returns:

Response Syntax

{
    'Policy': {
        'PolicySummary': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'SERVICE_CONTROL_POLICY',
            'AwsManaged': True|False
        },
        'Content': 'string'
    }
}

Response Structure

(dict) --
- Policy (dict) --
  
  A structure that contains details about the specified 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 lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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 AWS 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.

CreateAccount (new)

Link ¶

Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. If you want to check the status of the request later, you need the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants administrator permissions to the new account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.create_account(
    Email='string',
    AccountName='string',
    RoleName='string',
    IamUserAccessToBilling='ALLOW'|'DENY'
)

type Email:

string

param Email:

[REQUIRED]

The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account.

type AccountName:

string

param AccountName:

[REQUIRED]

The friendly name of the member account.

type RoleName:

string

param RoleName:

(Optional)

The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.

If you do not specify this parameter, the role name defaults to OrganizationAccountAccessRole.

For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

type IamUserAccessToBilling:

string

param IamUserAccessToBilling:

If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, then only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

rtype:

dict

returns:

Response Syntax

{
    'CreateAccountStatus': {
        'Id': 'string',
        'AccountName': 'string',
        'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'RequestedTimestamp': datetime(2015, 1, 1),
        'CompletedTimestamp': datetime(2015, 1, 1),
        'AccountId': 'string',
        'FailureReason': 'ACCOUNT_LIMIT_EXCEEDED'|'EMAIL_ALREADY_EXISTS'|'INVALID_ADDRESS'|'INTERNAL_FAILURE'
    }
}

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.
  - 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 an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.
  - AccountName (string) --
    
    The account name given to the account when it was created.
  - State (string) --
    
    The status of the request.
  - 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.
  - FailureReason (string) --
    
    If the request failed, a description of the reason for the failure.

CreateOrganization (new)

Link ¶

Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.

This operation must be called using credentials from the account that is to become the new organization's master 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", then no policy types are enabled by default and you cannot use organization policies.

See also: AWS API Documentation

Request Syntax

client.create_organization(
    FeatureSet='ALL'|'CONSOLIDATED_BILLING'
)

type FeatureSet:

string

param FeatureSet:

Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master account. For more information, see Consolidated Billing in the AWS Organizations User Guide.
ALL: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.

rtype:

dict

returns:

Response Syntax

{
    'Organization': {
        'Id': 'string',
        'Arn': 'string',
        'FeatureSet': 'ALL'|'CONSOLIDATED_BILLING',
        'MasterAccountArn': 'string',
        'MasterAccountId': 'string',
        'MasterAccountEmail': 'string',
        'AvailablePolicyTypes': [
            {
                'Type': 'SERVICE_CONTROL_POLICY',
                'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
            },
        ]
    }
}

Response Structure

(dict) --
- Organization (dict) --
  
  A structure that contains details about the newly created organization.
  - Id (string) --
    
    The unique identifier (ID) of an organization.
    
    The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of an organization.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - FeatureSet (string) --
    
    Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
  - MasterAccountArn (string) --
    
    The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - MasterAccountId (string) --
    
    The unique identifier (ID) of the master account of an organization.
    
    The regex pattern for an account ID string requires exactly 12 digits.
  - MasterAccountEmail (string) --
    
    The email address that is associated with the AWS account that is designated as the master account for the organization.
  - AvailablePolicyTypes (list) --
    
    A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.
    - (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.

ListParents (new)

Link ¶

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.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_parents(
    ChildId='string',
    NextToken='string',
    MaxResults=123
)

type ChildId:

string

param ChildId:

[REQUIRED]

The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root.

The regex pattern for a child ID string requires one of the following:

Account: a string that consists of exactly 12 digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

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:
      - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
      - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    - Type (string) --
      
      The type of the parent entity.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

DeletePolicy (new)

Link ¶

Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.delete_policy(
    PolicyId='string'
)

type PolicyId:

string

param PolicyId:

[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 lower-case letters or digits.

returns:

None

MoveAccount (new)

Link ¶

Moves an account from its current source parent root or OU to the specified destination parent root or OU.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.move_account(
    AccountId='string',
    SourceParentId='string',
    DestinationParentId='string'
)

type AccountId:

string

param AccountId:

[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.

type SourceParentId:

string

param SourceParentId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type DestinationParentId:

string

param DestinationParentId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

returns:

None

EnablePolicyType (new)

Link ¶

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 OU, or account in that root. You can undo this by using the DisablePolicyType operation.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.enable_policy_type(
    RootId='string',
    PolicyType='SERVICE_CONTROL_POLICY'
)

type RootId:

string

param RootId:

[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 lower-case letters or digits.

type PolicyType:

string

param PolicyType:

[REQUIRED]

The policy type that you want to enable.

rtype:

dict

returns:

Response Syntax

{
    'Root': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'PolicyTypes': [
            {
                'Type': 'SERVICE_CONTROL_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 lower-case 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 AWS Organizations User Guide.
  - 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.
    - (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.

ListHandshakesForAccount (new)

Link ¶

Lists the current handshakes that are associated with the account of the requesting user.

This operation can be called from any account in the organization.

See also: AWS API Documentation

Request Syntax

client.list_handshakes_for_account(
    Filter={
        'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES',
        'ParentHandshakeId': 'string'
    },
    NextToken='string',
    MaxResults=123
)

type Filter:

dict

param Filter:

Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-FULL-CONTROL, or APPROVE-FULL-CONTROL. Alternatively, for the ENABLE-FULL-CONTROL 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.

ActionType (string) --

Specifies the type of handshake action.

If you specify ActionType, you cannot also specify ParentHandshakeId.
ParentHandshakeId (string) --

Specifies the parent handshake. Only used for handshake types that are a child of another type.

If you specify ParentHandshakeId, you cannot also specify ActionType.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

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',
            '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 master 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.
    - 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 lower-case 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 AWS Organizations User Guide.
    - 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 lower-case 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:
      - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
      - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
      - CANCELED: This handshake is no longer active because it was canceled by the originating account.
      - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
      - DECLINED: This handshake is no longer active because it was declined by the recipient account.
      - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    - 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.
    - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
        
        Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

UpdateOrganizationalUnit (new)

Link ¶

Renames the specified organizational unit (OU). The ID and ARN do not 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 master account.

See also: AWS API Documentation

Request Syntax

client.update_organizational_unit(
    OrganizationalUnitId='string',
    Name='string'
)

type OrganizationalUnitId:

string

param OrganizationalUnitId:

[REQUIRED]

The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.

type Name:

string

param Name:

The new name that you want to assign to the OU.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

rtype:

dict

returns:

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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
  - 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.

ListAccountsForParent (new)

Link ¶

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 are not 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.

See also: AWS API Documentation

Request Syntax

client.list_accounts_for_parent(
    ParentId='string',
    NextToken='string',
    MaxResults=123
)

type ParentId:

string

param ParentId:

[REQUIRED]

The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'Accounts': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'SUSPENDED',
            '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 AWS 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 AWS Organizations User Guide.
    - 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, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

CreateOrganizationalUnit (new)

Link ¶

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 AWS Organizations User Guide.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.create_organizational_unit(
    ParentId='string',
    Name='string'
)

type ParentId:

string

param ParentId:

[REQUIRED]

The unique identifier (ID) of the parent root or OU in which you want to create the new OU.

The regex pattern for a parent ID string requires one of the following:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type Name:

string

param Name:

[REQUIRED]

The friendly name to assign to the new OU.

rtype:

dict

returns:

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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
  - 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.

DescribeHandshake (new)

Link ¶

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

This operation can be called from any account in the organization.

See also: AWS API Documentation

Request Syntax

client.describe_handshake(
    HandshakeId='string'
)

type HandshakeId:

string

param HandshakeId:

[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 lower-case letters or digits.

rtype:

dict

returns:

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',
        '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 information about the specified handshake.
  - 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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

DeclineHandshake (new)

Link ¶

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 re-initiate the process with a new handshake request.

See also: AWS API Documentation

Request Syntax

client.decline_handshake(
    HandshakeId='string'
)

type HandshakeId:

string

param HandshakeId:

[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 lower-case letters or digits.

rtype:

dict

returns:

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',
        '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 declined handshake. The state is updated to show the value DECLINED.
  - 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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

DisablePolicyType (new)

Link ¶

Disables an organizational control policy type in a root. A poicy 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 OU or account in that root. You can undo this by using the EnablePolicyType operation.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.disable_policy_type(
    RootId='string',
    PolicyType='SERVICE_CONTROL_POLICY'
)

type RootId:

string

param RootId:

[REQUIRED]

The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListPolicies operation.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.

type PolicyType:

string

param PolicyType:

[REQUIRED]

The policy type that you want to disable in this root.

rtype:

dict

returns:

Response Syntax

{
    'Root': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'PolicyTypes': [
            {
                'Type': 'SERVICE_CONTROL_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 lower-case 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 AWS Organizations User Guide.
  - 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.
    - (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.

CancelHandshake (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.cancel_handshake(
    HandshakeId='string'
)

type HandshakeId:

string

param HandshakeId:

[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 lower-case letters or digits.

rtype:

dict

returns:

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',
        '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 you canceled.
  - 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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

DescribeOrganization (new)

Link ¶

Retrieves information about the organization that the user's account belongs to.

This operation can be called from any account in the organization.

See also: AWS API Documentation

Request Syntax

client.describe_organization()

rtype:

dict

returns:

Response Syntax

{
    'Organization': {
        'Id': 'string',
        'Arn': 'string',
        'FeatureSet': 'ALL'|'CONSOLIDATED_BILLING',
        'MasterAccountArn': 'string',
        'MasterAccountId': 'string',
        'MasterAccountEmail': 'string',
        'AvailablePolicyTypes': [
            {
                'Type': 'SERVICE_CONTROL_POLICY',
                'Status': 'ENABLED'|'PENDING_ENABLE'|'PENDING_DISABLE'
            },
        ]
    }
}

Response Structure

(dict) --
- Organization (dict) --
  
  A structure that contains information about the organization.
  - Id (string) --
    
    The unique identifier (ID) of an organization.
    
    The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of an organization.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - FeatureSet (string) --
    
    Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
  - MasterAccountArn (string) --
    
    The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - MasterAccountId (string) --
    
    The unique identifier (ID) of the master account of an organization.
    
    The regex pattern for an account ID string requires exactly 12 digits.
  - MasterAccountEmail (string) --
    
    The email address that is associated with the AWS account that is designated as the master account for the organization.
  - AvailablePolicyTypes (list) --
    
    A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.
    - (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.

ListChildren (new)

Link ¶

Lists all of the 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.

See also: AWS API Documentation

Request Syntax

client.list_children(
    ParentId='string',
    ChildType='ACCOUNT'|'ORGANIZATIONAL_UNIT',
    NextToken='string',
    MaxResults=123
)

type ParentId:

string

param ParentId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type ChildType:

string

param ChildType:

[REQUIRED]

Filters the output to include only the specified child type.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

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:
      - Account: a string that consists of exactly 12 digits.
      - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    - Type (string) --
      
      The type of this child entity.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

ListOrganizationalUnitsForParent (new)

Link ¶

Lists the organizational units (OUs) in a parent organizational unit or root.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_organizational_units_for_parent(
    ParentId='string',
    NextToken='string',
    MaxResults=123
)

type ParentId:

string

param ParentId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

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 AWS 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
    - 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, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

ListPoliciesForTarget (new)

Link ¶

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.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.list_policies_for_target(
    TargetId='string',
    Filter='SERVICE_CONTROL_POLICY',
    NextToken='string',
    MaxResults=123
)

type TargetId:

string

param TargetId:

[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:

Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
Account: a string that consists of exactly 12 digits.
Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

type Filter:

string

param Filter:

[REQUIRED]

The type of policy that you want to include in the returned list.

type NextToken:

string

param NextToken:

type MaxResults:

integer

param MaxResults:

rtype:

dict

returns:

Response Syntax

{
    'Policies': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'SERVICE_CONTROL_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 lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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 AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
- NextToken (string) --
  
  If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

AcceptHandshake (new)

Link ¶

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:

Invitation to join or Approve all features request handshakes: only a principal from the member account.
Enable all features final confirmation handshake: only a principal from the master account. For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

See also: AWS API Documentation

Request Syntax

client.accept_handshake(
    HandshakeId='string'
)

type HandshakeId:

string

param HandshakeId:

[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 lower-case letters or digits.

rtype:

dict

returns:

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',
        '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 accepted handshake.
  - 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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

EnableAllFeatures (new)

Link ¶

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 AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

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 master 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 master 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 master account.

See also: AWS API Documentation

Request Syntax

client.enable_all_features()

rtype:

dict

returns:

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',
        '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 created to support this request to enable all features in the organization.
  - 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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

DeleteOrganization (new)

Link ¶

Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies.

See also: AWS API Documentation

Request Syntax

client.delete_organization()

returns:: None

InviteAccountToOrganization (new)

Link ¶

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.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.invite_account_to_organization(
    Target={
        'Id': 'string',
        'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
    },
    Notes='string'
)

type Target:

dict

param Target:

[REQUIRED]

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "< **account id number** >" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

--target id=123456789012,type=ACCOUNT

If you specify "Type": "ACCOUNT", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

--target id=bill@example.com,type=EMAIL

Id (string) --

The unique identifier (ID) for the party.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
Type (string) --

The type of party.

type Notes:

string

param Notes:

Additional information that you want to include in the generated email to the recipient account owner.

rtype:

dict

returns:

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',
        '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 lower-case 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 AWS Organizations User Guide.
  - 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 lower-case 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:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
  - 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.
  - 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 AWS account ID number.
        
        ORGANIZATION - Specifies an organization ID number.
        
        EMAIL - Specifies the email address that is associated with the account that receives the handshake.
        
        OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
        
        OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
        
        NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
      - Resources (list) --
        
        When needed, contains an additional array of HandshakeResource objects.

CreatePolicy (new)

Link ¶

Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.

For more information about policies and their use, see Managing Organization Policies.

This operation can be called only from the organization's master account.

See also: AWS API Documentation

Request Syntax

client.create_policy(
    Content='string',
    Description='string',
    Name='string',
    Type='SERVICE_CONTROL_POLICY'
)

type Content:

string

param Content:

[REQUIRED]

The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

type Description:

string

param Description:

[REQUIRED]

An optional description to assign to the policy.

type Name:

string

param Name:

[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.

type Type:

string

param Type:

[REQUIRED]

The type of policy to create.

rtype:

dict

returns:

Response Syntax

{
    'Policy': {
        'PolicySummary': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'SERVICE_CONTROL_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 lower-case letters or digits.
    - 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 AWS Organizations User Guide.
    - 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 AWS 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.