Skip to content

List Handshakes For Account

organizations_list_handshakes_for_account R Documentation

Lists the recent handshakes that you have received

Description

Lists the recent handshakes that you have received.

You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted.

You can call this operation from any account in a organization.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

Usage

organizations_list_handshakes_for_account(Filter, NextToken, MaxResults)

Arguments

Filter

A HandshakeFilter object. Contains the filer used to select the handshakes for an operation.
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.
MaxResults

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

Value

A list with the following syntax:

list(
  Handshakes = list(
    list(
      Id = "string",
      Arn = "string",
      Parties = list(
        list(
          Id = "string",
          Type = "ACCOUNT"|"ORGANIZATION"|"EMAIL"
        )
      ),
      State = "REQUESTED"|"OPEN"|"CANCELED"|"ACCEPTED"|"DECLINED"|"EXPIRED",
      RequestedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ExpirationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Action = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY",
      Resources = list(
        list(
          Value = "string",
          Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATION_FEATURE_SET"|"EMAIL"|"MASTER_EMAIL"|"MASTER_NAME"|"NOTES"|"PARENT_HANDSHAKE"|"RESPONSIBILITY_TRANSFER"|"TRANSFER_START_TIMESTAMP"|"TRANSFER_TYPE"|"MANAGEMENT_ACCOUNT"|"MANAGEMENT_EMAIL"|"MANAGEMENT_NAME",
          Resources = list()
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_handshakes_for_account(
  Filter = list(
    ActionType = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY",
    ParentHandshakeId = "string"
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# 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:
svc$list_handshakes_for_account()

## End(Not run)