Organizations / Client / cancel_handshake

cancel_handshake¶

Organizations.Client.cancel_handshake(**kwargs)¶

Cancels a Handshake.

Only the account that sent a handshake can call this operation. The recipient of the handshake can’t cancel it, but can use DeclineHandshake to decline. After a handshake is canceled, the recipient can no longer respond to the handshake.

You can view canceled handshakes in API responses for 30 days before they are deleted.

Request Syntax

response = client.cancel_handshake(
    HandshakeId='string'
)

Parameters:

HandshakeId (string) –

[REQUIRED]

ID for the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

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) –
  
  A Handshake object. Contains for the handshake that you canceled.
  - 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

Examples

Bill previously sent an invitation to Susan’s account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill’s cancellation:

response = client.cancel_handshake(
    HandshakeId='h-examplehandshakeid111',
)

print(response)

Expected Output:

{
    'Handshake': {
        'Action': 'INVITE',
        'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp': datetime(2017, 2, 28, 12, 15, 0, 1, 59, 0),
        'Id': 'h-examplehandshakeid111',
        'Parties': [
            {
                'Id': 'o-exampleorgid',
                'Type': 'ORGANIZATION',
            },
            {
                'Id': 'susan@example.com',
                'Type': 'EMAIL',
            },
        ],
        'RequestedTimestamp': datetime(2017, 2, 14, 12, 15, 0, 1, 45, 0),
        'Resources': [
            {
                'Resources': [
                    {
                        'Type': 'MASTER_EMAIL',
                        'Value': 'bill@example.com',
                    },
                    {
                        'Type': 'MASTER_NAME',
                        'Value': 'Master Account',
                    },
                    {
                        'Type': 'ORGANIZATION_FEATURE_SET',
                        'Value': 'CONSOLIDATED_BILLING',
                    },
                ],
                'Type': 'ORGANIZATION',
                'Value': 'o-exampleorgid',
            },
            {
                'Type': 'ACCOUNT',
                'Value': '222222222222',
            },
            {
                'Type': 'NOTES',
                'Value': 'This is a request for Susan's account to join Bob's organization.',
            },
        ],
        'State': 'CANCELED',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}