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.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeHandshakeAsync.
Namespace: Amazon.Organizations
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z
public abstract DescribeHandshakeResponse DescribeHandshake( DescribeHandshakeRequest request )
Container for the necessary parameters to execute the DescribeHandshake service method.
| Exception | Condition |
|---|---|
| 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. |
| HandshakeNotFoundException | We can't find a handshake with the HandshakeId that you specified. |
| 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. DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity. IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be modified. INPUT_REQUIRED: You must include a value for all required parameters. INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner. INVALID_ENUM: You specified an invalid value. INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string. 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. INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation. INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party. 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. INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor. INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization. INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. INVALID_SYSTEM_TAGS_PARAMETER: 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 Amazon Web Services use. System tags don’t count against your tags per resource limit. MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation. 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. MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root. TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity. UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized. |
| ServiceException | Organizations can't complete your request because of an internal service error. Try again later. |
| 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 Organizations, see Quotas for Organizations in the Organizations User Guide. |
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":
var client = new AmazonOrganizationsClient();
var response = client.DescribeHandshake(new DescribeHandshakeRequest
{
HandshakeId = "h-examplehandshakeid111"
});
Handshake handshake = response.Handshake;
.NET Framework:
Supported in: 4.5, 4.0, 3.5