paws.management (version 0.1.0)

organizations_describe_handshake: Retrieves information about a previously requested handshake

Description

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

Usage

organizations_describe_handshake(HandshakeId)

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 InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.

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

Request syntax

svc$describe_handshake(
  HandshakeId = "string"
)

Details

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible.

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

Examples

# 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":
# }
# NOT RUN {
svc$describe_handshake(
  HandshakeId = "h-examplehandshakeid111"
)
# }
# NOT RUN {
# }