handshakes_for_organizations

Creates, updates, deletes, gets or lists a handshakes_for_organizations resource.

Overview

Name	handshakes_for_organizations
Type	Resource
Id	aws.organizations.handshakes_for_organizations

Fields

The following fields are returned by SELECT queries:

list_handshakes_for_organization

Name	Datatype	Description
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. (INVITE, ENABLE_ALL_FEATURES, APPROVE_ALL_FEATURES, ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE, TRANSFER_RESPONSIBILITY)
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. (pattern: <code>^arn:aws:organizations::\d{12}:handshake/o-[a-z0-9]{10,32}/[a-z_]{1,32}/h-[0-9a-z]{8,32}</code>)
expiration_timestamp	string (date-time)	Timestamp when the handshake expires.
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. (pattern: <code>^h-[0-9a-z]{8,32}$</code>)
parties	array	An array of HandshakeParty objects. Contains details for participant in a handshake.
requested_timestamp	string (date-time)	Timestamp when the handshake request was made.
resources	array	An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.
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. (REQUESTED, OPEN, CANCELED, ACCEPTED, DECLINED, EXPIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_handshakes_for_organization	select	region		Lists the recent handshakes that you have sent. You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted. You can only call this operation from the management account or a member account that is a delegated administrator. When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_handshakes_for_organization

Lists the recent handshakes that you have sent. You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted. You can only call this operation from the management account or a member account that is a delegated administrator. When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

SELECT
action,
arn,
expiration_timestamp,
id,
parties,
requested_timestamp,
resources,
state
FROM aws.organizations.handshakes_for_organizations
WHERE region = '{{ region }}' -- required
;