libZSservicesZSamazonka-ssoZSamazonka-sso
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSO.GetRoleCredentials

Description

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

Synopsis

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 AWS SSO OIDC API Reference Guide.

Instances

Instances details
Eq GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

(==) :: GetRoleCredentials -> GetRoleCredentials -> Bool #

(/=) :: GetRoleCredentials -> GetRoleCredentials -> Bool #

Show GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

showsPrec :: Int -> GetRoleCredentials -> ShowS #

show :: GetRoleCredentials -> String #

showList :: [GetRoleCredentials] -> ShowS #

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 #

NFData GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

rnf :: GetRoleCredentials -> () #

Hashable GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

hashWithSalt :: Int -> GetRoleCredentials -> Int #

hash :: GetRoleCredentials -> Int #

AWSRequest GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Associated Types

type AWSResponse GetRoleCredentials #

Methods

request :: GetRoleCredentials -> Request GetRoleCredentials #

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

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 #

type Rep GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

type Rep GetRoleCredentials = D1 ('MetaData "GetRoleCredentials" "Amazonka.SSO.GetRoleCredentials" "libZSservicesZSamazonka-ssoZSamazonka-sso" '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)))))
type AWSResponse GetRoleCredentials Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

type AWSResponse GetRoleCredentials = GetRoleCredentialsResponse

newGetRoleCredentials Source #

Arguments

:: Text

$sel:roleName:GetRoleCredentials'

-> Text

$sel:accountId: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:

$sel:roleName:GetRoleCredentials', getRoleCredentials_roleName - The friendly name of the role that is assigned to the user.

$sel:accountId: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 AWS SSO 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 AWS SSO OIDC API Reference Guide.

Destructuring the Response

data GetRoleCredentialsResponse Source #

See: newGetRoleCredentialsResponse smart constructor.

Constructors

GetRoleCredentialsResponse' 

Fields

Instances

Instances details
Eq GetRoleCredentialsResponse Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

(==) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool #

(/=) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool #

Show GetRoleCredentialsResponse Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

showsPrec :: Int -> GetRoleCredentialsResponse -> ShowS #

show :: GetRoleCredentialsResponse -> String #

showList :: [GetRoleCredentialsResponse] -> ShowS #

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 #

NFData GetRoleCredentialsResponse Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

Methods

rnf :: GetRoleCredentialsResponse -> () #

type Rep GetRoleCredentialsResponse Source # 
Instance details

Defined in Amazonka.SSO.GetRoleCredentials

type Rep GetRoleCredentialsResponse = D1 ('MetaData "GetRoleCredentialsResponse" "Amazonka.SSO.GetRoleCredentials" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "GetRoleCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoleCredentials)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetRoleCredentialsResponse Source #

Arguments

:: Int

$sel:httpStatus: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:roleCredentials:GetRoleCredentialsResponse', getRoleCredentialsResponse_roleCredentials - The credentials for the role that is assigned to the user.

$sel:httpStatus:GetRoleCredentialsResponse', getRoleCredentialsResponse_httpStatus - The response's http status code.

Response Lenses

getRoleCredentialsResponse_roleCredentials :: Lens' GetRoleCredentialsResponse (Maybe RoleCredentials) Source #

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

getRoleCredentialsResponse_httpStatus :: Lens' GetRoleCredentialsResponse Int Source #

The response's http status code.