List Handshakes For Account
organizations_list_handshakes_for_account | R Documentation |
Lists the current handshakes that are associated with the account of the requesting user¶
Description¶
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 null
only when there are no
more results to display.
This operation can be called from any account in the organization.
Usage¶
Arguments¶
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 asINVITE
,ENABLE_ALL_FEATURES
, orAPPROVE_ALL_FEATURES
. Alternatively, for theENABLE_ALL_FEATURES
handshake that generates a separate child handshake for each member account, you can specifyParentHandshakeId
to see only the handshakes that were generated by that parent request.NextToken
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from.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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the 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",
Resources = list(
list(
Value = "string",
Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATION_FEATURE_SET"|"EMAIL"|"MASTER_EMAIL"|"MASTER_NAME"|"NOTES"|"PARENT_HANDSHAKE",
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",
ParentHandshakeId = "string"
),
NextToken = "string",
MaxResults = 123
)