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	None
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] Source #

ToPath GetRoleCredentials Source #

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

toPath :: GetRoleCredentials -> ByteString Source #

ToQuery GetRoleCredentials Source #

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

toQuery :: GetRoleCredentials -> QueryString Source #

AWSRequest GetRoleCredentials Source #

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Associated Types

type AWSResponse GetRoleCredentials
Instance details Defined in Amazonka.SSO.GetRoleCredentials type AWSResponse GetRoleCredentials = GetRoleCredentialsResponse

Methods

request :: (Service -> Service) -> GetRoleCredentials -> Request GetRoleCredentials Source #

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

NFData GetRoleCredentials Source #

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

rnf :: GetRoleCredentials -> () #

Generic GetRoleCredentials Source #

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Associated Types

type Rep GetRoleCredentials

Instance details

Defined in Amazonka.SSO.GetRoleCredentials

type Rep GetRoleCredentials = D1 ('MetaData "GetRoleCredentials" "Amazonka.SSO.GetRoleCredentials" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" '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)))))

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 #

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 Source #

hash :: GetRoleCredentials -> Int Source #

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-DOouWRdcxDlFDrquCwcbWX" '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	`roleName`
-> Text	`accountId`
-> Text	`accessToken`
-> 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:

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

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

accessToken, 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.