Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1455233317.4 KB

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible.

This operation can be called from any account in the organization.

post/#X-Amz-Target=AWSOrganizationsV20161128.DescribeHandshake

Headers

X-Amz-Target'AWSOrganizationsV20161128.DescribeHandshake' required

Request body

HandshakeIdstring required
<p>The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to <a>InviteAccountToOrganization</a>, or from a call to <a>ListHandshakesForAccount</a> or <a>ListHandshakesForOrganization</a>.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.</p>

Response

Success

Example response

{
  "Handshake": {
    "Action": "INVITE",
    "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
    "ExpirationTimestamp": "2016-11-30T17:24:58.046Z",
    "Id": "h-examplehandshakeid111",
    "Parties": [
      {
        "Id": "o-exampleorgid",
        "Type": "ORGANIZATION"
      },
      {
        "Id": "333333333333",
        "Type": "ACCOUNT"
      }
    ],
    "RequestedTimestamp": "2016-11-30T17:24:58.046Z",
    "Resources": [
      {
        "Resources": [
          {
            "Type": "MASTER_EMAIL",
            "Value": "bill@example.com"
          },
          {
            "Type": "MASTER_NAME",
            "Value": "Master Account"
          }
        ],
        "Type": "ORGANIZATION",
        "Value": "o-exampleorgid"
      },
      {
        "Type": "ACCOUNT",
        "Value": "333333333333"
      }
    ],
    "State": "OPEN"
  }
}