paws.management (version 0.1.5)

organizations_decline_handshake: Declines a handshake request

Description

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

Usage

organizations_decline_handshake(HandshakeId)

Arguments

HandshakeId

[required] The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

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

Request syntax

svc$decline_handshake(
  HandshakeId = "string"
)

Details

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

Examples

# NOT RUN {
# The following example shows Susan declining an invitation to join Bill's
# organization. The DeclineHandshake operation returns a handshake object,
# showing that the state is now DECLINED:
# }
# NOT RUN {
svc$decline_handshake(
  HandshakeId = "h-examplehandshakeid111"
)
# }
# NOT RUN {
# }