Container for the parameters to the CancelHandshake operation.
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's deleted.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Organizations.AmazonOrganizationsRequest
Amazon.Organizations.Model.CancelHandshakeRequest
Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z
Syntax
public class CancelHandshakeRequest : AmazonOrganizationsRequest IAmazonWebServiceRequest
The CancelHandshakeRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CancelHandshakeRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
HandshakeId | System.String |
Gets and sets the property 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 lowercase letters or digits. |
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 client = new AmazonOrganizationsClient();
var response = client.CancelHandshake(new CancelHandshakeRequest
{
HandshakeId = "h-examplehandshakeid111"
});
Handshake handshake = response.Handshake;
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5