[ aws . organizations ]

list-handshakes-for-organization

Description

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.

Note

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.

See also: AWS API Documentation

list-handshakes-for-organization is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Handshakes

Synopsis

  list-handshakes-for-organization
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--filter (structure)

A HandshakeFilter object. Contains the filer used to select the handshakes for an operation.

ActionType -> (string)

The type of handshake.

If you specify ActionType , you cannot also specify ParentHandshakeId .

Possible values:

• INVITE
• ENABLE_ALL_FEATURES
• APPROVE_ALL_FEATURES
• ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
• TRANSFER_RESPONSIBILITY

ParentHandshakeId -> (string)

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.

Constraints:

• max: 34
• pattern: ^h-[0-9a-z]{8,32}$

Shorthand Syntax:

ActionType=string,ParentHandshakeId=string

JSON Syntax:

{
  "ActionType": "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY",
  "ParentHandshakeId": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve a list of the handshakes associated with an organization

The following example shows how to get a list of handshakes that are associated with the current organization:

aws organizations list-handshakes-for-organization

The output shows two handshakes. The first one is an invitation to Juan’s account and shows a state of OPEN. The second is an invitation to Anika’s account and shows a state of ACCEPTED:

{
        "Handshakes": [
                {
                        "Action": "INVITE",
                        "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                        "ExpirationTimestamp": 1482952459.257,
                        "Id": "h-examplehandshakeid111",
                        "Parties": [
                                {
                                        "Id": "o-exampleorgid",
                                        "Type": "ORGANIZATION"
                                },
                                {
                                        "Id": "juan@example.com",
                                        "Type": "EMAIL"
                                }
                        ],
                        "RequestedTimestamp": 1481656459.257,
                        "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"
                                },
                                {
                                        "Type":"NOTES",
                                        "Value":"This is an invitation to Juan's account to join Bill's organization."
                                }
                        ],
                        "State": "OPEN"
                },
                {
                        "Action": "INVITE",
                        "State":"ACCEPTED",
                        "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                        "ExpirationTimestamp": 1.471797437427E9,
                        "Id": "h-examplehandshakeid222",
                        "Parties": [
                                {
                                        "Id": "o-exampleorgid",
                                        "Type": "ORGANIZATION"
                                },
                                {
                                        "Id": "anika@example.com",
                                        "Type": "EMAIL"
                                }
                        ],
                        "RequestedTimestamp": 1.469205437427E9,
                        "Resources": [
                                {
                                        "Resources": [
                                                {
                                                        "Type":"MASTER_EMAIL",
                                                        "Value":"bill@example.com"
                                                },
                                                {
                                                        "Type":"MASTER_NAME",
                                                        "Value":"Master Account"
                                                }
                                        ],
                                        "Type":"ORGANIZATION",
                                        "Value":"o-exampleorgid"
                                },
                                {
                                        "Type":"EMAIL",
                                        "Value":"anika@example.com"
                                },
                                {
                                        "Type":"NOTES",
                                        "Value":"This is an invitation to Anika's account to join Bill's organization."
                                }
                        ]
                }
        ]
}

Output

Handshakes -> (list)

An array of Handshake objects. Contains details for a handshake.

(structure)

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.

Constraints:

• max: 34
• pattern: ^h-[0-9a-z]{8,32}$

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 .

Constraints:

• pattern: ^arn:aws:organizations::\d{12}:handshake\/o-[a-z0-9]{10,32}\/[a-z_]{1,32}\/h-[0-9a-z]{8,32}

Parties -> (list)

An array of HandshakeParty objects. Contains details for participant in a handshake.

(structure)

Contains details for a participant in a handshake.

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.

Constraints:

• min: 1
• max: 64
• pattern: [\s\S]*

Type -> (string) [required]

The type of ID for the participant.

Possible values:

• ACCOUNT
• ORGANIZATION
• EMAIL

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.

Possible values:

• REQUESTED
• OPEN
• CANCELED
• ACCEPTED
• DECLINED
• EXPIRED

RequestedTimestamp -> (timestamp)

Timestamp when the handshake request was made.

ExpirationTimestamp -> (timestamp)

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.

Possible values:

• INVITE
• ENABLE_ALL_FEATURES
• APPROVE_ALL_FEATURES
• ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
• TRANSFER_RESPONSIBILITY

Resources -> (list)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

(structure)

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.

Possible values:

• 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 -> (list)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

(structure)

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.

Possible values:

• 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

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 .

Constraints:

• max: 100000
• pattern: [\s\S]*