| 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.DescribeHandshake
Description
Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization 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.
Synopsis
- data DescribeHandshake = DescribeHandshake' {
- handshakeId :: Text
- newDescribeHandshake :: Text -> DescribeHandshake
- describeHandshake_handshakeId :: Lens' DescribeHandshake Text
- data DescribeHandshakeResponse = DescribeHandshakeResponse' {
- handshake :: Maybe Handshake
- httpStatus :: Int
- newDescribeHandshakeResponse :: Int -> DescribeHandshakeResponse
- describeHandshakeResponse_handshake :: Lens' DescribeHandshakeResponse (Maybe Handshake)
- describeHandshakeResponse_httpStatus :: Lens' DescribeHandshakeResponse Int
Creating a Request
data DescribeHandshake Source #
See: newDescribeHandshake smart constructor.
Constructors
| DescribeHandshake' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribeHandshake |
Create a value of DescribeHandshake 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:DescribeHandshake', describeHandshake_handshakeId - 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 lowercase letters or digits.
Request Lenses
describeHandshake_handshakeId :: Lens' DescribeHandshake Text Source #
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 lowercase letters or digits.
Destructuring the Response
data DescribeHandshakeResponse Source #
See: newDescribeHandshakeResponse smart constructor.
Constructors
| DescribeHandshakeResponse' | |
Fields
| |
Instances
newDescribeHandshakeResponse Source #
Create a value of DescribeHandshakeResponse 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:DescribeHandshakeResponse', describeHandshakeResponse_handshake - A structure that contains information about the specified handshake.
$sel:httpStatus:DescribeHandshakeResponse', describeHandshakeResponse_httpStatus - The response's http status code.
Response Lenses
describeHandshakeResponse_handshake :: Lens' DescribeHandshakeResponse (Maybe Handshake) Source #
A structure that contains information about the specified handshake.
describeHandshakeResponse_httpStatus :: Lens' DescribeHandshakeResponse Int Source #
The response's http status code.