cancel_handshake(**kwargs)¶Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED .
This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
See also: AWS API Documentation
Request Syntax
response = client.cancel_handshake(
HandshakeId='string'
)
[REQUIRED]
The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
{
'Handshake': {
'Id': 'string',
'Arn': 'string',
'Parties': [
{
'Id': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
},
],
'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
'RequestedTimestamp': datetime(2015, 1, 1),
'ExpirationTimestamp': datetime(2015, 1, 1),
'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'Resources': [
{
'Value': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATION_FEATURE_SET'|'EMAIL'|'MASTER_EMAIL'|'MASTER_NAME'|'NOTES'|'PARENT_HANDSHAKE',
'Resources': {'... recursive ...'}
},
]
}
}
Response Structure
A structure that contains details about the handshake that you canceled.
The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Information about the two accounts that are participating in the handshake.
Identifies a participant in a handshake.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
The type of party.
The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
The date and time that the handshake request was made.
The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.Additional information that is needed to process the handshake.
Contains additional data that is needed to process a handshake.
The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT - Specifies an Amazon Web Services account ID number.ORGANIZATION - Specifies an organization ID number.EMAIL - Specifies the email address that is associated with the account that receives the handshake.OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization.OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.When needed, contains an additional array of HandshakeResource objects.
Exceptions
Organizations.Client.exceptions.AccessDeniedExceptionOrganizations.Client.exceptions.ConcurrentModificationExceptionOrganizations.Client.exceptions.HandshakeNotFoundExceptionOrganizations.Client.exceptions.InvalidHandshakeTransitionExceptionOrganizations.Client.exceptions.HandshakeAlreadyInStateExceptionOrganizations.Client.exceptions.InvalidInputExceptionOrganizations.Client.exceptions.ServiceExceptionOrganizations.Client.exceptions.TooManyRequestsExceptionExamples
Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
response = client.cancel_handshake(
HandshakeId='h-examplehandshakeid111',
)
print(response)
Expected Output:
{
'Handshake': {
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 2, 28, 12, 15, 0, 1, 59, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'susan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 2, 14, 12, 15, 0, 1, 45, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@example.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'CONSOLIDATED_BILLING',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'ACCOUNT',
'Value': '222222222222',
},
{
'Type': 'NOTES',
'Value': 'This is a request for Susan's account to join Bob's organization.',
},
],
'State': 'CANCELED',
},
'ResponseMetadata': {
'...': '...',
},
}