Organizations / Client / invite_organization_to_transfer_responsibility

invite_organization_to_transfer_responsibility¶

Organizations.Client.invite_organization_to_transfer_responsibility(**kwargs)¶

Sends an invitation to another organization’s management account to designate your account with the specified responsibilities for their organization. The invitation is implemented as a Handshake whose details are in the response.

You can only call this operation from the management account.

Request Syntax

response = client.invite_organization_to_transfer_responsibility(
    Type='BILLING',
    Target={
        'Id': 'string',
        'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
    },
    Notes='string',
    StartTimestamp=datetime(2015, 1, 1),
    SourceName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Type (string) –
[REQUIRED]

The type of responsibility you want to designate to your organization. Currently, only BILLING is supported.
Target (dict) –
[REQUIRED]

A HandshakeParty object. Contains details for the account you want to invite. Currently, only ACCOUNT and EMAIL are supported.
- Id (string) – [REQUIRED]
  
  ID for the participant: Acccount ID, organization ID, or email address.
  
  The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.
- Type (string) – [REQUIRED]
  
  The type of ID for the participant.
Notes (string) – Additional information that you want to include in the invitation.
StartTimestamp (datetime) –
[REQUIRED]

Timestamp when the recipient will begin managing the specified responsibilities.
SourceName (string) –
[REQUIRED]

Name you want to assign to the transfer.
Tags (list) –
A list of tags that you want to attach to the transfer. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

Warning
Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don’t match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the transfer. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

Note
If any one of the tags is not valid or if you exceed the allowed number of tags for a transfer, then the entire request fails and invitations are not sent.
- (dict) –
  
  A custom key-value pair associated with a resource within your organization.
  
  You can attach tags to any of the following organization resources.
  - Amazon Web Services account
  - Organizational unit (OU)
  - Organization root
  - Policy
  - Key (string) – [REQUIRED]
    
    The key identifier, or name, of the tag.
  - Value (string) – [REQUIRED]
    
    The string value that’s associated with the key of the tag. You can set the value of a tag to an empty string, but you can’t set the value of a tag to null.

Return type:

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'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE'|'TRANSFER_RESPONSIBILITY',
        'Resources': [
            {
                'Value': 'string',
                'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE'|'RESPONSIBILITY_TRANSFER'|'TRANSFER_START_TIMESTAMP'|'TRANSFER_TYPE'|'MANAGEMENT_ACCOUNT'|'MANAGEMENT_EMAIL'|'MANAGEMENT_NAME',
                'Resources': {'... recursive ...'}
            },
        ]
    }
}

Response Structure

(dict) –
- Handshake (dict) –
  
  Contains details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.
  
  Note: Handshakes that are CANCELED, ACCEPTED, DECLINED, or EXPIRED show up in lists for only 30 days after entering that state After that they are deleted.
  - Id (string) –
    
    ID for the handshake.
    
    The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.
  - Arn (string) –
    
    Amazon Resource Name (ARN) for the handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
  - Parties (list) –
    
    An array of HandshakeParty objects. Contains details for participant in a handshake.
    - (dict) –
      
      Contains details for a participant in a handshake.
      - Id (string) –
        
        ID for the participant: Acccount ID, organization ID, or email address.
        
        The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.
      - Type (string) –
        
        The type of ID for the participant.
  - State (string) –
    
    Current state for the handshake.
    - REQUESTED: Handshake awaiting a response from the recipient.
    - OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.
    - CANCELED: Handshake canceled by the sender.
    - ACCEPTED: Handshake accepted by the recipient.
    - DECLINED: Handshake declined by the recipient.
    - EXPIRED: Handshake has expired.
  - RequestedTimestamp (datetime) –
    
    Timestamp when the handshake request was made.
  - ExpirationTimestamp (datetime) –
    
    Timestamp when the handshake expires.
  - Action (string) –
    
    The type of handshake:
    - INVITE: Handshake sent to a standalone account requesting that it to join the sender’s organization.
    - ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.
    - APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.
    - TRANSFER_RESPONSIBILITY: Handshake sent to another organization’s management account requesting that it designate the sender with the specified responsibilities for recipient’s organization.
  - Resources (list) –
    
    An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.
    - (dict) –
      
      Contains additional details for a handshake.
      - Value (string) –
        
        Additional information for 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: ID for an Amazon Web Services account.
        
        ORGANIZATION: ID for an organization.
        
        EMAIL: Email address for the recipient.
        
        OWNER_EMAIL: Email address for the sender.
        
        OWNER_NAME: Name of the sender.
        
        NOTES: Additional text included by the sender for the recipient.
      - Resources (list) –
        
        An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Exceptions

Organizations.Client.exceptions.AccessDeniedException
Organizations.Client.exceptions.AWSOrganizationsNotInUseException
Organizations.Client.exceptions.ConcurrentModificationException
Organizations.Client.exceptions.ConstraintViolationException
Organizations.Client.exceptions.DuplicateHandshakeException
Organizations.Client.exceptions.HandshakeConstraintViolationException
Organizations.Client.exceptions.InvalidInputException
Organizations.Client.exceptions.ServiceException
Organizations.Client.exceptions.TooManyRequestsException
Organizations.Client.exceptions.UnsupportedAPIEndpointException