Amazonka.Connect.GetFederationToken

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

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

ToHeaders GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

toHeaders :: GetFederationToken -> [Header]

ToPath GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

toPath :: GetFederationToken -> ByteString

ToQuery GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

toQuery :: GetFederationToken -> QueryString

AWSRequest GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Associated Types

type AWSResponse GetFederationToken

Methods

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

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

Generic GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Associated Types

type Rep GetFederationToken :: Type -> Type

Methods

from :: GetFederationToken -> Rep GetFederationToken x

to :: Rep GetFederationToken x -> GetFederationToken

Read GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

readsPrec :: Int -> ReadS GetFederationToken

readList :: ReadS [GetFederationToken]

readPrec :: ReadPrec GetFederationToken

readListPrec :: ReadPrec [GetFederationToken]

Show GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

showsPrec :: Int -> GetFederationToken -> ShowS

show :: GetFederationToken -> String

showList :: [GetFederationToken] -> ShowS

NFData GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

rnf :: GetFederationToken -> ()

Eq GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

(==) :: GetFederationToken -> GetFederationToken -> Bool

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

Hashable GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

Methods

hashWithSalt :: Int -> GetFederationToken -> Int

hash :: GetFederationToken -> Int

type AWSResponse GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

type AWSResponse GetFederationToken = GetFederationTokenResponse

type Rep GetFederationToken

Defined in Amazonka.Connect.GetFederationToken

type Rep GetFederationToken = D1 ('MetaData "GetFederationToken" "Amazonka.Connect.GetFederationToken" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "GetFederationToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetFederationToken

Arguments

:: Text

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:

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

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

Destructuring the Response

data GetFederationTokenResponse

See: newGetFederationTokenResponse smart constructor.

Constructors

GetFederationTokenResponse'

Fields

• credentials :: Maybe Credentials

  The credentials to use for federation.

• signInUrl :: Maybe Text

  The URL to sign into the user's instance.

• userArn :: Maybe Text

  The Amazon Resource Name (ARN) of the user.

• userId :: Maybe Text

  The identifier for the user.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetFederationTokenResponse

Defined in Amazonka.Connect.GetFederationToken

Associated Types

type Rep GetFederationTokenResponse :: Type -> Type

Methods

from :: GetFederationTokenResponse -> Rep GetFederationTokenResponse x

to :: Rep GetFederationTokenResponse x -> GetFederationTokenResponse

Show GetFederationTokenResponse

Defined in Amazonka.Connect.GetFederationToken

Methods

showsPrec :: Int -> GetFederationTokenResponse -> ShowS

show :: GetFederationTokenResponse -> String

showList :: [GetFederationTokenResponse] -> ShowS

NFData GetFederationTokenResponse

Defined in Amazonka.Connect.GetFederationToken

Methods

rnf :: GetFederationTokenResponse -> ()

Eq GetFederationTokenResponse

Defined in Amazonka.Connect.GetFederationToken

Methods

(==) :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool

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

type Rep GetFederationTokenResponse

Defined in Amazonka.Connect.GetFederationToken

type Rep GetFederationTokenResponse = D1 ('MetaData "GetFederationTokenResponse" "Amazonka.Connect.GetFederationToken" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "GetFederationTokenResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Credentials)) :*: S1 ('MetaSel ('Just "signInUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetFederationTokenResponse

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:signInUrl:GetFederationTokenResponse', getFederationTokenResponse_signInUrl - The URL to sign into the user's instance.

$sel:userArn:GetFederationTokenResponse', getFederationTokenResponse_userArn - The Amazon Resource Name (ARN) of the user.

GetFederationTokenResponse, getFederationTokenResponse_userId - The identifier for the user.

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

Response Lenses

getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe Credentials)

The credentials to use for federation.

getFederationTokenResponse_signInUrl :: Lens' GetFederationTokenResponse (Maybe Text)

The URL to sign into the user's instance.

getFederationTokenResponse_userArn :: Lens' GetFederationTokenResponse (Maybe Text)

The Amazon Resource Name (ARN) of the user.

getFederationTokenResponse_userId :: Lens' GetFederationTokenResponse (Maybe Text)

The identifier for the user.

getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int

The response's http status code.