organizations_describe_handshake: Retrieves information about a previously requested handshake

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original invite_account_to_organization 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.

Usage

1

Arguments

HandshakeId

[required] The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to invite_account_to_organization, or from a call to list_handshakes_for_account or list_handshakes_for_organization.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

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
list(
  Handshake = 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()
      )
    )
  )
)

Request syntax

1
2
3
svc$describe_handshake(
  HandshakeId = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# 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":
svc$describe_handshake(
  HandshakeId = "h-examplehandshakeid111"
)

## End(Not run)

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