Container for the parameters to the DescribeHandshake operation. Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.
You can access handshakes that are ACCEPTED, DECLINED, or CANCELED
for only 30 days after they change to that state. They're then deleted and no longer
accessible.
This operation can be called from any account in the organization.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Organizations.AmazonOrganizationsRequest
Amazon.Organizations.Model.DescribeHandshakeRequest
Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z
Syntax
public class DescribeHandshakeRequest : AmazonOrganizationsRequest IAmazonWebServiceRequest
The DescribeHandshakeRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeHandshakeRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
HandshakeId | System.String |
Gets and sets the property HandshakeId. The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. |
Examples
The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization":
To get information about a handshake
var client = new AmazonOrganizationsClient();
var response = client.DescribeHandshake(new DescribeHandshakeRequest
{
HandshakeId = "h-examplehandshakeid111"
});
Handshake handshake = response.Handshake;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5