Organizations.Client.
list_handshakes_for_account
(**kwargs)¶Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED
, DECLINED
, CANCELED
, or EXPIRED
appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Note
Always check the NextToken
response parameter for a null
value when calling a List*
operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken
response parameter value is null
only when there are no more results to display.
This operation can be called from any account in the organization.
See also: AWS API Documentation
Request Syntax
response = client.list_handshakes_for_account(
Filter={
'ActionType': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'ParentHandshakeId': 'string'
},
NextToken='string',
MaxResults=123
)
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_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 ParentHandshakeId
to see only the handshakes that were generated by that parent request.
Specifies the type of handshake action.
If you specify ActionType
, you cannot also specify ParentHandshakeId
.
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 lowercase letters or digits.
NextToken
response in a previous request. A NextToken
response indicates that more output is available. Set this parameter to the value of the previous call's NextToken
response to indicate where the output should continue from.NextToken
response element is present and has a value (is not null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.dict
Response Syntax
{
'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'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
'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 management 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.
Note: Handshakes that are
CANCELED
,ACCEPTED
,DECLINED
, orEXPIRED
show up in lists for only 30 days after entering that state After that they are deleted.
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 lowercase 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 Amazon Web Services Service Authorization Reference .
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 lowercase 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:
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. 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.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 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.Resources (list) --
When needed, contains an additional array of HandshakeResource
objects.
NextToken (string) --
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
.
Exceptions
Organizations.Client.exceptions.AccessDeniedException
Organizations.Client.exceptions.ConcurrentModificationException
Organizations.Client.exceptions.InvalidInputException
Organizations.Client.exceptions.ServiceException
Organizations.Client.exceptions.TooManyRequestsException
Examples
The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:
response = client.list_handshakes_for_account(
)
print(response)
Expected Output:
{
'Handshakes': [
{
'Action': 'INVITE',
'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
'ExpirationTimestamp': datetime(2017, 1, 28, 14, 35, 23, 5, 28, 0),
'Id': 'h-examplehandshakeid111',
'Parties': [
{
'Id': 'o-exampleorgid',
'Type': 'ORGANIZATION',
},
{
'Id': 'juan@example.com',
'Type': 'EMAIL',
},
],
'RequestedTimestamp': datetime(2017, 1, 13, 14, 35, 23, 4, 13, 0),
'Resources': [
{
'Resources': [
{
'Type': 'MASTER_EMAIL',
'Value': 'bill@amazon.com',
},
{
'Type': 'MASTER_NAME',
'Value': 'Org Master Account',
},
{
'Type': 'ORGANIZATION_FEATURE_SET',
'Value': 'FULL',
},
],
'Type': 'ORGANIZATION',
'Value': 'o-exampleorgid',
},
{
'Type': 'EMAIL',
'Value': 'juan@example.com',
},
],
'State': 'OPEN',
},
],
'ResponseMetadata': {
'...': '...',
},
}