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 |
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
Synopsis
- data GetFederationToken = GetFederationToken' {
- instanceId :: Text
- newGetFederationToken :: Text -> GetFederationToken
- getFederationToken_instanceId :: Lens' GetFederationToken Text
- data GetFederationTokenResponse = GetFederationTokenResponse' {
- credentials :: Maybe Credentials
- signInUrl :: Maybe Text
- userArn :: Maybe Text
- userId :: Maybe Text
- httpStatus :: Int
- newGetFederationTokenResponse :: Int -> GetFederationTokenResponse
- getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe Credentials)
- getFederationTokenResponse_signInUrl :: Lens' GetFederationTokenResponse (Maybe Text)
- getFederationTokenResponse_userArn :: Lens' GetFederationTokenResponse (Maybe Text)
- getFederationTokenResponse_userId :: Lens' GetFederationTokenResponse (Maybe Text)
- getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int
Creating a Request
data GetFederationToken Source #
See: newGetFederationToken
smart constructor.
GetFederationToken' | |
|
Instances
newGetFederationToken Source #
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 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.
GetFederationTokenResponse' | |
|
Instances
newGetFederationTokenResponse Source #
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) Source #
The credentials to use for federation.
getFederationTokenResponse_signInUrl :: Lens' GetFederationTokenResponse (Maybe Text) Source #
The URL to sign into the user's instance.
getFederationTokenResponse_userArn :: Lens' GetFederationTokenResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user.
getFederationTokenResponse_userId :: Lens' GetFederationTokenResponse (Maybe Text) Source #
The identifier for the user.
getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int Source #
The response's http status code.