Menu
AWS Organizations API Reference
API Reference (API Version 2016-11-28)

CancelHandshake

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

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

Request Syntax

{
   "HandshakeId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HandshakeId

The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

Type: String

Pattern: ^h-[0-9a-z]{8,32}$

Required: Yes

Response Syntax

{
   "Handshake": { 
      "Action": "string",
      "Arn": "string",
      "ExpirationTimestamp": number,
      "Id": "string",
      "Parties": [ 
         { 
            "Id": "string",
            "Type": "string"
         }
      ],
      "RequestedTimestamp": number,
      "Resources": [ 
         { 
            "Resources": [ 
               "HandshakeResource"
            ],
            "Type": "string",
            "Value": "string"
         }
      ],
      "State": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Handshake

A structure that contains details about the handshake that you canceled.

Type: Handshake object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 400

ConcurrentModificationException

The target of the operation is currently being modified by a different request. Try again later.

HTTP Status Code: 400

HandshakeAlreadyInStateException

The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.

HTTP Status Code: 400

HandshakeNotFoundException

We can't find a handshake with the HandshakeId that you specified.

HTTP Status Code: 400

InvalidHandshakeTransitionException

You can't perform the operation on the handshake in its current state. For example, you can't cancel a handshake that was already accepted, or accept a handshake that was already declined.

HTTP Status Code: 400

InvalidInputException

The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

Note

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

  • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.

  • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

  • INVALID_ENUM: You specified a value that is not valid for that parameter.

  • INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.

  • INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.

  • MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

  • MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

  • MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

  • MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

  • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.

  • INVALID_PATTERN: You provided a value that doesn't match the required pattern.

  • INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.

  • INPUT_REQUIRED: You must include a value for all required parameters.

  • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

  • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

  • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

HTTP Status Code: 400

ServiceException

AWS Organizations can't complete your request because of an internal service error. Try again later.

HTTP Status Code: 400

TooManyRequestsException

You've sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

HTTP Status Code: 400

Example

Bill, the admin of an organization, previously sent an invitation to Susan's account to join the organization. Bill later changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill cancelling the handshake (and the invitation it represents). The output includes a handshake object that shows that the state is now CANCELED:

Sample Request

POST / HTTP/1.1
Host: organizations.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 120
X-Amz-Target: AWSOrganizationsV20161128.CancelHandshake
X-Amz-Date: 20161130T213700Z
User-Agent: aws-cli/1.10.18 Python/2.7.8 Linux/2.6.18-164.el5 botocore/1.4.9
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 
  Credential=AKIAIOSFODNN7EXAMPLE/20161130/us-east-1/organizations/aws4_request, 
  SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target,   
  Signature=EXAMPLESIGabcdef1234567890abcdef1234567890abcdef123456EXAMPLESIG

{ "HandshakeId": "h-examplehandshakeid111" }

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 665
Date: Mon, 30 Nov 2016 21:37:00 GMT

{
  "Handshake": {
    "Id": "h-examplehandshakeid111",
    "State":"CANCELED",
    "Action": "INVITE",
    "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
    "Parties": [ 
      {
        "Id": "o-exampleorgid",
        "Type": "ORGANIZATION"
      },
      {
        "Id": "susan@example.com",
        "Type": "EMAIL"
      }
    ],
    "Resources": [
      {
        "Type": "ORGANIZATION",
        "Value": "o-exampleorgid",
        "Resources": [
          {
            "Type": "MASTER_EMAIL",
            "Value": "bill@example.com"
          },
          {
            "Type": "MASTER_NAME",
            "Value": "Master Account"
          },
          {
            "Type": "ORGANIZATION_FEATURE_SET",
            "Value": "CONSOLIDATED_BILLING"
          }
        ]
      },
      {
        "Type": "EMAIL",
        "Value": "anika@example.com"
      },
      {
        "Type": "NOTES",
        "Value": "This is a request for Susan's account to join Bob's organization."
      }
    ],
    "RequestedTimestamp": 1.47008383521E9,
    "ExpirationTimestamp": 1.47137983521E9
  }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: