# CancelHandshake Cancels a [Handshake](API_Handshake.md). Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use [DeclineHandshake](API_DeclineHandshake.md) to decline. After a handshake is canceled, the recipient can no longer respond to the handshake. You can view canceled handshakes in API responses for 30 days before they are deleted. ## Request Syntax ``` { "HandshakeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HandshakeId](#API_CancelHandshake_RequestSyntax) ** ID for the handshake that you want to cancel. You can get the ID from the [ListHandshakesForOrganization](API_ListHandshakesForOrganization.md) operation. The [regex pattern](http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. Type: String Length Constraints: Maximum length of 34. 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](#API_CancelHandshake_ResponseSyntax) ** A `Handshake` object. Contains for the handshake that you canceled. Type: [Handshake](API_Handshake.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) 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: Some of the reasons in the following list might not be applicable to this specific API or operation. + CALLER\$1REQUIRED\$1FIELD\$1MISSING: At least one of the required field is missing: Caller Account Id, Management Account Id or Organization Id. + DUPLICATE\$1TAG\$1KEY: Tag keys must be unique among the tags attached to the same entity. + END\$1DATE\$1NOT\$1END\$1OF\$1MONTH: You provided an invalid end date. The end date must be the end of the last day of the month (23.59.59.999). + END\$1DATE\$1TOO\$1EARLY: You provided an invalid end date. It is too early for the transfer to end. + IMMUTABLE\$1POLICY: You specified a policy that is managed by AWS and can't be modified. + INPUT\$1REQUIRED: You must include a value for all required parameters. + INVALID\$1EMAIL\$1ADDRESS\$1TARGET: You specified an invalid email address for the invited account owner. + INVALID\$1END\$1DATE: The selected withdrawal date doesn't meet the terms of your partner agreement. Visit AWS Partner Central to view your partner agreements or contact your AWS Partner for help. + INVALID\$1ENUM: You specified an invalid value. + INVALID\$1ENUM\$1POLICY\$1TYPE: You specified an invalid policy type string. + INVALID\$1FULL\$1NAME\$1TARGET: You specified a full name that contains invalid characters. + INVALID\$1LIST\$1MEMBER: You provided a list to a parameter that contains at least one invalid value. + INVALID\$1PAGINATION\$1TOKEN: Get the value for the `NextToken` parameter from the response to a previous call of the operation. + INVALID\$1PARTY\$1TYPE\$1TARGET: You specified the wrong type of entity (account, organization, or email) as a party. + INVALID\$1PATTERN: You provided a value that doesn't match the required pattern. + INVALID\$1PATTERN\$1TARGET\$1ID: You specified a policy target ID that doesn't match the required pattern. + INVALID\$1PRINCIPAL: You specified an invalid principal element in the policy. + INVALID\$1ROLE\$1NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix `AWSServiceRoleFor`. + INVALID\$1START\$1DATE: The start date doesn't meet the minimum requirements. + INVALID\$1SYNTAX\$1ORGANIZATION\$1ARN: You specified an invalid Amazon Resource Name (ARN) for the organization. + INVALID\$1SYNTAX\$1POLICY\$1ID: You specified an invalid policy ID. + INVALID\$1SYSTEM\$1TAGS\$1PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit. + MAX\$1FILTER\$1LIMIT\$1EXCEEDED: You can specify only one filter parameter for the operation. + MAX\$1LENGTH\$1EXCEEDED: You provided a string parameter that is longer than allowed. + MAX\$1VALUE\$1EXCEEDED: You provided a numeric parameter that has a larger value than allowed. + MIN\$1LENGTH\$1EXCEEDED: You provided a string parameter that is shorter than allowed. + MIN\$1VALUE\$1EXCEEDED: You provided a numeric parameter that has a smaller value than allowed. + MOVING\$1ACCOUNT\$1BETWEEN\$1DIFFERENT\$1ROOTS: You can move an account only between entities in the same root. + NON\$1DETACHABLE\$1POLICY: You can't detach this AWS Managed Policy. + START\$1DATE\$1NOT\$1BEGINNING\$1OF\$1DAY: You provided an invalid start date. The start date must be the beginning of the day (00:00:00.000). + START\$1DATE\$1NOT\$1BEGINNING\$1OF\$1MONTH: You provided an invalid start date. The start date must be the first day of the month. + START\$1DATE\$1TOO\$1EARLY: You provided an invalid start date. The start date is too early. + START\$1DATE\$1TOO\$1LATE: You provided an invalid start date. The start date is too late. + TARGET\$1NOT\$1SUPPORTED: You can't perform the specified operation on that target entity. + UNRECOGNIZED\$1SERVICE\$1PRINCIPAL: You specified a service principal that isn't recognized. + UNSUPPORTED\$1ACTION\$1IN\$1RESPONSIBILITY\$1TRANSFER: You provided a value that is not supported by this operation. HTTP Status Code: 400 ** ServiceException ** AWS Organizations can't complete your request because of an internal service error. Try again later. HTTP Status Code: 500 ** TooManyRequestsException ** You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later. For information about quotas that affect AWS Organizations, see [Quotas for AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) in the * AWS Organizations User Guide*. HTTP Status Code: 400 ## Examples Diego, the admin of an organization, previously sent an invitation to Anaya's account to join the organization. Diego later changes his mind and decides to cancel the invitation before Anaya accepts it. The following example shows Diego canceling the handshake (and the invitation it represents). The output includes a handshake object that shows that the state is now `CANCELED`. ### Example This example illustrates one usage of CancelHandshake. #### Sample Request ``` POST / HTTP/1.1 X-Amz-Target: AWSOrganizationsV20161128.CancelHandshake { "HandshakeId": "h-examplehandshakeid111" } ``` #### Sample Response ``` HTTP/1.1 200 OK Content-Type: application/json { "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": "anaya@example.com", "Type": "EMAIL" } ], "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "diego@example.com" }, { "Type": "MASTER_NAME", "Value": "Management account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "CONSOLIDATED_BILLING" } ] }, { "Type": "EMAIL", "Value": "anika@example.com" }, { "Type": "NOTES", "Value": "This is a request for Anaya's account to join Diego'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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/organizations-2016-11-28/CancelHandshake) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/organizations-2016-11-28/CancelHandshake) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/organizations-2016-11-28/CancelHandshake) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/organizations-2016-11-28/CancelHandshake) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/organizations-2016-11-28/CancelHandshake) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/organizations-2016-11-28/CancelHandshake) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/organizations-2016-11-28/CancelHandshake) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/organizations-2016-11-28/CancelHandshake) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/organizations-2016-11-28/CancelHandshake) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/organizations-2016-11-28/CancelHandshake)