AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to CancelHandshakeAsync.

Namespace: Amazon.Organizations
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public abstract CancelHandshakeResponse CancelHandshake(
         CancelHandshakeRequest request
)
Parameters
request
Type: Amazon.Organizations.Model.CancelHandshakeRequest

Container for the necessary parameters to execute the CancelHandshake service method.

Return Value
The response from the CancelHandshake service method, as returned by Organizations.

Exceptions

ExceptionCondition
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.
ConcurrentModificationException The target of the operation is currently being modified by a different request. Try again later.
HandshakeAlreadyInStateException The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.
HandshakeNotFoundException We can't find a handshake with the HandshakeId that you specified.
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.
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: 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.
ServiceException AWS Organizations can't complete your request because of an internal service error. Try again later.
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.

Examples

Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:

To cancel a handshake sent to a member account


var response = client.CancelHandshake(new CancelHandshakeRequest 
{
    HandshakeId = "h-examplehandshakeid111"
});

Handshake handshake = response.Handshake;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also