Amazonka.Organizations.DescribeHandshake

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.

Creating a Request

data DescribeHandshake

See: newDescribeHandshake smart constructor.

Constructors

DescribeHandshake'

Fields

• handshakeId :: Text

  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.

Instances

ToJSON DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

toJSON :: DescribeHandshake -> Value

toEncoding :: DescribeHandshake -> Encoding

toJSONList :: [DescribeHandshake] -> Value

toEncodingList :: [DescribeHandshake] -> Encoding

ToHeaders DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

toHeaders :: DescribeHandshake -> [Header]

ToPath DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

toPath :: DescribeHandshake -> ByteString

ToQuery DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

toQuery :: DescribeHandshake -> QueryString

AWSRequest DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Associated Types

type AWSResponse DescribeHandshake

Methods

request :: (Service -> Service) -> DescribeHandshake -> Request DescribeHandshake

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeHandshake -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHandshake)))

Generic DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Associated Types

type Rep DescribeHandshake :: Type -> Type

Methods

from :: DescribeHandshake -> Rep DescribeHandshake x

to :: Rep DescribeHandshake x -> DescribeHandshake

Read DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

readsPrec :: Int -> ReadS DescribeHandshake

readList :: ReadS [DescribeHandshake]

readPrec :: ReadPrec DescribeHandshake

readListPrec :: ReadPrec [DescribeHandshake]

Show DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

showsPrec :: Int -> DescribeHandshake -> ShowS

show :: DescribeHandshake -> String

showList :: [DescribeHandshake] -> ShowS

NFData DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

rnf :: DescribeHandshake -> ()

Eq DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

(==) :: DescribeHandshake -> DescribeHandshake -> Bool

(/=) :: DescribeHandshake -> DescribeHandshake -> Bool

Hashable DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

Methods

hashWithSalt :: Int -> DescribeHandshake -> Int

hash :: DescribeHandshake -> Int

type AWSResponse DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

type AWSResponse DescribeHandshake = DescribeHandshakeResponse

type Rep DescribeHandshake

Defined in Amazonka.Organizations.DescribeHandshake

type Rep DescribeHandshake = D1 ('MetaData "DescribeHandshake" "Amazonka.Organizations.DescribeHandshake" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DescribeHandshake'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshakeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeHandshake

Arguments

:: Text

$sel:handshakeId:DescribeHandshake'

-> 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

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

See: newDescribeHandshakeResponse smart constructor.

Constructors

DescribeHandshakeResponse'

Fields

• handshake :: Maybe Handshake

  A structure that contains information about the specified handshake.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeHandshakeResponse

Defined in Amazonka.Organizations.DescribeHandshake

Associated Types

type Rep DescribeHandshakeResponse :: Type -> Type

Methods

from :: DescribeHandshakeResponse -> Rep DescribeHandshakeResponse x

to :: Rep DescribeHandshakeResponse x -> DescribeHandshakeResponse

Show DescribeHandshakeResponse

Defined in Amazonka.Organizations.DescribeHandshake

Methods

showsPrec :: Int -> DescribeHandshakeResponse -> ShowS

show :: DescribeHandshakeResponse -> String

showList :: [DescribeHandshakeResponse] -> ShowS

NFData DescribeHandshakeResponse

Defined in Amazonka.Organizations.DescribeHandshake

Methods

rnf :: DescribeHandshakeResponse -> ()

Eq DescribeHandshakeResponse

Defined in Amazonka.Organizations.DescribeHandshake

Methods

(==) :: DescribeHandshakeResponse -> DescribeHandshakeResponse -> Bool

(/=) :: DescribeHandshakeResponse -> DescribeHandshakeResponse -> Bool

type Rep DescribeHandshakeResponse

Defined in Amazonka.Organizations.DescribeHandshake

type Rep DescribeHandshakeResponse = D1 ('MetaData "DescribeHandshakeResponse" "Amazonka.Organizations.DescribeHandshake" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DescribeHandshakeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Handshake)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeHandshakeResponse

Arguments

:: Int

$sel:httpStatus:DescribeHandshakeResponse'

-> DescribeHandshakeResponse

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)

A structure that contains information about the specified handshake.

describeHandshakeResponse_httpStatus :: Lens' DescribeHandshakeResponse Int

The response's http status code.