| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Organizations.CancelHandshake
Description
Cancels a handshake. Canceling a handshake sets the handshake state to
CANCELED.
This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
Synopsis
- data CancelHandshake = CancelHandshake' {
- handshakeId :: Text
- newCancelHandshake :: Text -> CancelHandshake
- cancelHandshake_handshakeId :: Lens' CancelHandshake Text
- data CancelHandshakeResponse = CancelHandshakeResponse' {
- handshake :: Maybe Handshake
- httpStatus :: Int
- newCancelHandshakeResponse :: Int -> CancelHandshakeResponse
- cancelHandshakeResponse_handshake :: Lens' CancelHandshakeResponse (Maybe Handshake)
- cancelHandshakeResponse_httpStatus :: Lens' CancelHandshakeResponse Int
Creating a Request
data CancelHandshake Source #
See: newCancelHandshake smart constructor.
Constructors
| CancelHandshake' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CancelHandshake |
Create a value of CancelHandshake with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakeId:CancelHandshake', cancelHandshake_handshakeId - The unique identifier (ID) of the handshake that you want to cancel. You
can get the ID from the ListHandshakesForOrganization operation.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Request Lenses
cancelHandshake_handshakeId :: Lens' CancelHandshake Text Source #
The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
Destructuring the Response
data CancelHandshakeResponse Source #
See: newCancelHandshakeResponse smart constructor.
Constructors
| CancelHandshakeResponse' | |
Fields
| |
Instances
newCancelHandshakeResponse Source #
Create a value of CancelHandshakeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:CancelHandshakeResponse', cancelHandshakeResponse_handshake - A structure that contains details about the handshake that you canceled.
$sel:httpStatus:CancelHandshakeResponse', cancelHandshakeResponse_httpStatus - The response's http status code.
Response Lenses
cancelHandshakeResponse_handshake :: Lens' CancelHandshakeResponse (Maybe Handshake) Source #
A structure that contains details about the handshake that you canceled.
cancelHandshakeResponse_httpStatus :: Lens' CancelHandshakeResponse Int Source #
The response's http status code.