v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1455233317.4 KB

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

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

Headers

X-Amz-Target'AWSOrganizationsV20161128.DeclineHandshake' required

Request body

HandshakeIdstring required
<p>The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the <a>ListHandshakesForAccount</a> operation.</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-12-15T19:27:58Z",
    "Id": "h-examplehandshakeid111",
    "Parties": [
      {
        "Id": "222222222222",
        "Type": "ACCOUNT"
      },
      {
        "Id": "o-exampleorgid",
        "Type": "ORGANIZATION"
      }
    ],
    "RequestedTimestamp": "2016-11-30T19:27:58Z",
    "Resources": [
      {
        "Resources": [
          {
            "Type": "MASTER_EMAIL",
            "Value": "bill@example.com"
          },
          {
            "Type": "MASTER_NAME",
            "Value": "Master Account"
          }
        ],
        "Type": "ORGANIZATION",
        "Value": "o-exampleorgid"
      },
      {
        "Type": "ACCOUNT",
        "Value": "222222222222"
      },
      {
        "Type": "NOTES",
        "Value": "This is an invitation to Susan's account to join the Bill's organization."
      }
    ],
    "State": "DECLINED"
  }
}