ListHandshakesForAccountRequest Class

Container for the parameters to the ListHandshakesForAccount operation. Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is nullonly when there are no more results to display.

This operation can be called from any account in the organization.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Organizations.AmazonOrganizationsRequest
      Amazon.Organizations.Model.ListHandshakesForAccountRequest

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

Syntax

public class ListHandshakesForAccountRequest : AmazonOrganizationsRequest
         IAmazonWebServiceRequest

The ListHandshakesForAccountRequest type exposes the following members

Constructors

	Name	Description
	ListHandshakesForAccountRequest()

Properties

Name Type Description

Name	Type	Description
Filter	Amazon.Organizations.Model.HandshakeFilter	Gets and sets the property Filter. Filters the handshakes that you want included in the response. The default is all types. Use the `ActionType` element to limit the output to only a specified type, such as `INVITE`, `ENABLE_ALL_FEATURES`, or `APPROVE_ALL_FEATURES`. Alternatively, for the `ENABLE_ALL_FEATURES` handshake that generates a separate child handshake for each member account, you can specify `ParentHandshakeId` to see only the handshakes that were generated by that parent request.
MaxResults	System.Int32	Gets and sets the property MaxResults. The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the `NextToken` response element is present and has a value (is not null). Include that value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.
NextToken	System.String	Gets and sets the property NextToken. The parameter for receiving additional results if you receive a `NextToken` response in a previous request. A `NextToken` response indicates that more output is available. Set this parameter to the value of the previous call's `NextToken` response to indicate where the output should continue from.

Filter

Amazon.Organizations.Model.HandshakeFilter

Gets and sets the property Filter.

Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.

MaxResults

System.Int32

Gets and sets the property MaxResults.

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

NextToken

System.String

Gets and sets the property NextToken.

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Examples

The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:

To retrieve a list of the handshakes sent to an account


var client = new AmazonOrganizationsClient();
var response = client.ListHandshakesForAccount(new ListHandshakesForAccountRequest 
{
});

List<Handshake> handshakes = response.Handshakes;

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