organizations_list_handshakes_for_organization: Lists the handshakes that are associated with the...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Lists the handshakes that are associated with the organization that the requesting user is part of. The list_handshakes_for_organization operation returns a list of handshake structures. Each structure contains details and status about a handshake.

Handshakes that are ACCEPTED, DECLINED, or CANCELED 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 only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

Usage

1
2

Arguments

Filter

A filter of 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 the ParentHandshakeId 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. 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 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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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

1
2
3
4
5
6
7
8
svc$list_handshakes_for_organization(
  Filter = list(
    ActionType = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
    ParentHandshakeId = "string"
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

1
2
3
4
5
6
## Not run: 
# The following example shows you how to get a list of handshakes
# associated with the current organization:
svc$list_handshakes_for_organization()

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.