Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkMail.AssumeImpersonationRole

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Creating a Request

data AssumeImpersonationRole Source #

See: newAssumeImpersonationRole smart constructor.

Constructors

AssumeImpersonationRole'
Fields organizationId :: Text The WorkMail organization under which the impersonation role will be assumed. impersonationRoleId :: Text The impersonation role ID to assume.

Instances

Instances details

ToJSON AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods toJSON :: AssumeImpersonationRole -> Value # toEncoding :: AssumeImpersonationRole -> Encoding # toJSONList :: [AssumeImpersonationRole] -> Value # toEncodingList :: [AssumeImpersonationRole] -> Encoding #
ToHeaders AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods toHeaders :: AssumeImpersonationRole -> [Header] #
ToPath AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods toPath :: AssumeImpersonationRole -> ByteString #
ToQuery AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods toQuery :: AssumeImpersonationRole -> QueryString #
AWSRequest AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Associated Types type AWSResponse AssumeImpersonationRole # Methods request :: (Service -> Service) -> AssumeImpersonationRole -> Request AssumeImpersonationRole # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssumeImpersonationRole -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssumeImpersonationRole))) #
Generic AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Associated Types type Rep AssumeImpersonationRole :: Type -> Type # Methods from :: AssumeImpersonationRole -> Rep AssumeImpersonationRole x # to :: Rep AssumeImpersonationRole x -> AssumeImpersonationRole #
Read AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods readsPrec :: Int -> ReadS AssumeImpersonationRole # readList :: ReadS [AssumeImpersonationRole] # readPrec :: ReadPrec AssumeImpersonationRole # readListPrec :: ReadPrec [AssumeImpersonationRole] #
Show AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods showsPrec :: Int -> AssumeImpersonationRole -> ShowS # show :: AssumeImpersonationRole -> String # showList :: [AssumeImpersonationRole] -> ShowS #
NFData AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods rnf :: AssumeImpersonationRole -> () #
Eq AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods (==) :: AssumeImpersonationRole -> AssumeImpersonationRole -> Bool # (/=) :: AssumeImpersonationRole -> AssumeImpersonationRole -> Bool #
Hashable AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods hashWithSalt :: Int -> AssumeImpersonationRole -> Int # hash :: AssumeImpersonationRole -> Int #
type AWSResponse AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole type AWSResponse AssumeImpersonationRole = AssumeImpersonationRoleResponse
type Rep AssumeImpersonationRole Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole type Rep AssumeImpersonationRole = D1 ('MetaData "AssumeImpersonationRole" "Amazonka.WorkMail.AssumeImpersonationRole" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "AssumeImpersonationRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "impersonationRoleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAssumeImpersonationRole Source #

Arguments

:: Text	`AssumeImpersonationRole`
-> Text	`AssumeImpersonationRole`
-> AssumeImpersonationRole

Create a value of AssumeImpersonationRole 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:

AssumeImpersonationRole, assumeImpersonationRole_organizationId - The WorkMail organization under which the impersonation role will be assumed.

AssumeImpersonationRole, assumeImpersonationRole_impersonationRoleId - The impersonation role ID to assume.

Request Lenses

assumeImpersonationRole_organizationId :: Lens' AssumeImpersonationRole Text Source #

The WorkMail organization under which the impersonation role will be assumed.

assumeImpersonationRole_impersonationRoleId :: Lens' AssumeImpersonationRole Text Source #

The impersonation role ID to assume.

Destructuring the Response

data AssumeImpersonationRoleResponse Source #

See: newAssumeImpersonationRoleResponse smart constructor.

Constructors

AssumeImpersonationRoleResponse'
Fields expiresIn :: Maybe Integer The authentication token's validity, in seconds. token :: Maybe Text The authentication token for the impersonation role. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Associated Types type Rep AssumeImpersonationRoleResponse :: Type -> Type # Methods from :: AssumeImpersonationRoleResponse -> Rep AssumeImpersonationRoleResponse x # to :: Rep AssumeImpersonationRoleResponse x -> AssumeImpersonationRoleResponse #
Read AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods readsPrec :: Int -> ReadS AssumeImpersonationRoleResponse # readList :: ReadS [AssumeImpersonationRoleResponse] # readPrec :: ReadPrec AssumeImpersonationRoleResponse # readListPrec :: ReadPrec [AssumeImpersonationRoleResponse] #
Show AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods showsPrec :: Int -> AssumeImpersonationRoleResponse -> ShowS # show :: AssumeImpersonationRoleResponse -> String # showList :: [AssumeImpersonationRoleResponse] -> ShowS #
NFData AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods rnf :: AssumeImpersonationRoleResponse -> () #
Eq AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole Methods (==) :: AssumeImpersonationRoleResponse -> AssumeImpersonationRoleResponse -> Bool # (/=) :: AssumeImpersonationRoleResponse -> AssumeImpersonationRoleResponse -> Bool #
type Rep AssumeImpersonationRoleResponse Source #
Instance details Defined in Amazonka.WorkMail.AssumeImpersonationRole type Rep AssumeImpersonationRoleResponse = D1 ('MetaData "AssumeImpersonationRoleResponse" "Amazonka.WorkMail.AssumeImpersonationRole" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "AssumeImpersonationRoleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssumeImpersonationRoleResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssumeImpersonationRoleResponse'`
-> AssumeImpersonationRoleResponse

Create a value of AssumeImpersonationRoleResponse 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:expiresIn:AssumeImpersonationRoleResponse', assumeImpersonationRoleResponse_expiresIn - The authentication token's validity, in seconds.

$sel:token:AssumeImpersonationRoleResponse', assumeImpersonationRoleResponse_token - The authentication token for the impersonation role.

$sel:httpStatus:AssumeImpersonationRoleResponse', assumeImpersonationRoleResponse_httpStatus - The response's http status code.

Response Lenses

assumeImpersonationRoleResponse_expiresIn :: Lens' AssumeImpersonationRoleResponse (Maybe Integer) Source #

The authentication token's validity, in seconds.

assumeImpersonationRoleResponse_token :: Lens' AssumeImpersonationRoleResponse (Maybe Text) Source #

The authentication token for the impersonation role.

assumeImpersonationRoleResponse_httpStatus :: Lens' AssumeImpersonationRoleResponse Int Source #

The response's http status code.