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.Connect.GetFederationToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Creating a Request

data GetFederationToken Source #

See: newGetFederationToken smart constructor.

Constructors

GetFederationToken'
Fields instanceId :: Text The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

Eq GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods (==) :: GetFederationToken -> GetFederationToken -> Bool # (/=) :: GetFederationToken -> GetFederationToken -> Bool #
Read GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods readsPrec :: Int -> ReadS GetFederationToken # readList :: ReadS [GetFederationToken] # readPrec :: ReadPrec GetFederationToken # readListPrec :: ReadPrec [GetFederationToken] #
Show GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods showsPrec :: Int -> GetFederationToken -> ShowS # show :: GetFederationToken -> String # showList :: [GetFederationToken] -> ShowS #
Generic GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Associated Types type Rep GetFederationToken :: Type -> Type # Methods from :: GetFederationToken -> Rep GetFederationToken x # to :: Rep GetFederationToken x -> GetFederationToken #
NFData GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods rnf :: GetFederationToken -> () #
Hashable GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods hashWithSalt :: Int -> GetFederationToken -> Int # hash :: GetFederationToken -> Int #
AWSRequest GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Associated Types type AWSResponse GetFederationToken # Methods request :: GetFederationToken -> Request GetFederationToken # response :: MonadResource m => Logger -> Service -> Proxy GetFederationToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFederationToken))) #
ToHeaders GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods toHeaders :: GetFederationToken -> [Header] #
ToPath GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods toPath :: GetFederationToken -> ByteString #
ToQuery GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods toQuery :: GetFederationToken -> QueryString #
type Rep GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken type Rep GetFederationToken = D1 ('MetaData "GetFederationToken" "Amazonka.Connect.GetFederationToken" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetFederationToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetFederationToken Source #
Instance details Defined in Amazonka.Connect.GetFederationToken type AWSResponse GetFederationToken = GetFederationTokenResponse

newGetFederationToken Source #

Arguments

:: Text	`$sel:instanceId:GetFederationToken'`
-> GetFederationToken

Create a value of GetFederationToken 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:instanceId:GetFederationToken', getFederationToken_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

getFederationToken_instanceId :: Lens' GetFederationToken Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data GetFederationTokenResponse Source #

See: newGetFederationTokenResponse smart constructor.

Constructors

GetFederationTokenResponse'
Fields credentials :: Maybe Credentials The credentials to use for federation. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetFederationTokenResponse Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods (==) :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool # (/=) :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool #
Show GetFederationTokenResponse Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods showsPrec :: Int -> GetFederationTokenResponse -> ShowS # show :: GetFederationTokenResponse -> String # showList :: [GetFederationTokenResponse] -> ShowS #
Generic GetFederationTokenResponse Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Associated Types type Rep GetFederationTokenResponse :: Type -> Type # Methods from :: GetFederationTokenResponse -> Rep GetFederationTokenResponse x # to :: Rep GetFederationTokenResponse x -> GetFederationTokenResponse #
NFData GetFederationTokenResponse Source #
Instance details Defined in Amazonka.Connect.GetFederationToken Methods rnf :: GetFederationTokenResponse -> () #
type Rep GetFederationTokenResponse Source #
Instance details Defined in Amazonka.Connect.GetFederationToken type Rep GetFederationTokenResponse = D1 ('MetaData "GetFederationTokenResponse" "Amazonka.Connect.GetFederationToken" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetFederationTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Credentials)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetFederationTokenResponse Source #

Arguments

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

Create a value of GetFederationTokenResponse 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:credentials:GetFederationTokenResponse', getFederationTokenResponse_credentials - The credentials to use for federation.

$sel:httpStatus:GetFederationTokenResponse', getFederationTokenResponse_httpStatus - The response's http status code.

Response Lenses

getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe Credentials) Source #

The credentials to use for federation.

getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int Source #

The response's http status code.