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.SSO.GetRoleCredentials

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the STS short-term credentials for a given role name that is assigned to the user.

Creating a Request

data GetRoleCredentials Source #

See: newGetRoleCredentials smart constructor.

Constructors

GetRoleCredentials'
Fields roleName :: Text The friendly name of the role that is assigned to the user. accountId :: Text The identifier for the AWS account that is assigned to the user. accessToken :: Sensitive Text The token issued by the `CreateToken` API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

Instances

Instances details

ToHeaders GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toHeaders :: GetRoleCredentials -> [Header] #
ToPath GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toPath :: GetRoleCredentials -> ByteString #
ToQuery GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toQuery :: GetRoleCredentials -> QueryString #
AWSRequest GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type AWSResponse GetRoleCredentials # Methods request :: (Service -> Service) -> GetRoleCredentials -> Request GetRoleCredentials # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRoleCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoleCredentials))) #
Generic GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type Rep GetRoleCredentials :: Type -> Type # Methods from :: GetRoleCredentials -> Rep GetRoleCredentials x # to :: Rep GetRoleCredentials x -> GetRoleCredentials #
Show GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods showsPrec :: Int -> GetRoleCredentials -> ShowS # show :: GetRoleCredentials -> String # showList :: [GetRoleCredentials] -> ShowS #
NFData GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods rnf :: GetRoleCredentials -> () #
Eq GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods (==) :: GetRoleCredentials -> GetRoleCredentials -> Bool # (/=) :: GetRoleCredentials -> GetRoleCredentials -> Bool #
Hashable GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods hashWithSalt :: Int -> GetRoleCredentials -> Int # hash :: GetRoleCredentials -> Int #
type AWSResponse GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type AWSResponse GetRoleCredentials = GetRoleCredentialsResponse
type Rep GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type Rep GetRoleCredentials = D1 ('MetaData "GetRoleCredentials" "Amazonka.SSO.GetRoleCredentials" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "GetRoleCredentials'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newGetRoleCredentials Source #

Arguments

:: Text	`GetRoleCredentials`
-> Text	`GetRoleCredentials`
-> Text	`$sel:accessToken:GetRoleCredentials'`
-> GetRoleCredentials

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

GetRoleCredentials, getRoleCredentials_roleName - The friendly name of the role that is assigned to the user.

GetRoleCredentials, getRoleCredentials_accountId - The identifier for the AWS account that is assigned to the user.

$sel:accessToken:GetRoleCredentials', getRoleCredentials_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

Request Lenses

getRoleCredentials_roleName :: Lens' GetRoleCredentials Text Source #

The friendly name of the role that is assigned to the user.

getRoleCredentials_accountId :: Lens' GetRoleCredentials Text Source #

The identifier for the AWS account that is assigned to the user.

getRoleCredentials_accessToken :: Lens' GetRoleCredentials Text Source #

The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

Destructuring the Response

data GetRoleCredentialsResponse Source #

See: newGetRoleCredentialsResponse smart constructor.

Constructors

GetRoleCredentialsResponse'
Fields httpStatus :: Int The response's http status code. roleCredentials :: RoleCredentials The credentials for the role that is assigned to the user.

Instances

Instances details

Generic GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type Rep GetRoleCredentialsResponse :: Type -> Type # Methods from :: GetRoleCredentialsResponse -> Rep GetRoleCredentialsResponse x # to :: Rep GetRoleCredentialsResponse x -> GetRoleCredentialsResponse #
Show GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods showsPrec :: Int -> GetRoleCredentialsResponse -> ShowS # show :: GetRoleCredentialsResponse -> String # showList :: [GetRoleCredentialsResponse] -> ShowS #
NFData GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods rnf :: GetRoleCredentialsResponse -> () #
Eq GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods (==) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool # (/=) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool #
type Rep GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type Rep GetRoleCredentialsResponse = D1 ('MetaData "GetRoleCredentialsResponse" "Amazonka.SSO.GetRoleCredentials" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "GetRoleCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "roleCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoleCredentials)))

newGetRoleCredentialsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRoleCredentialsResponse'`
-> RoleCredentials	`$sel:roleCredentials:GetRoleCredentialsResponse'`
-> GetRoleCredentialsResponse

Create a value of GetRoleCredentialsResponse 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:httpStatus:GetRoleCredentialsResponse', getRoleCredentialsResponse_httpStatus - The response's http status code.

$sel:roleCredentials:GetRoleCredentialsResponse', getRoleCredentialsResponse_roleCredentials - The credentials for the role that is assigned to the user.

Response Lenses

getRoleCredentialsResponse_httpStatus :: Lens' GetRoleCredentialsResponse Int Source #

The response's http status code.

getRoleCredentialsResponse_roleCredentials :: Lens' GetRoleCredentialsResponse RoleCredentials Source #

The credentials for the role that is assigned to the user.