libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.GetRole

Description

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with roles.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Synopsis

Creating a Request

data GetRole Source #

See: newGetRole smart constructor.

Constructors

GetRole' 

Fields

  • roleName :: Text

    The name of the IAM role to get information about.

    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Instances

Instances details
Eq GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

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

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

Read GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Show GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Generic GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Associated Types

type Rep GetRole :: Type -> Type #

Methods

from :: GetRole -> Rep GetRole x #

to :: Rep GetRole x -> GetRole #

NFData GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

rnf :: GetRole -> () #

Hashable GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

hashWithSalt :: Int -> GetRole -> Int #

hash :: GetRole -> Int #

AWSRequest GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Associated Types

type AWSResponse GetRole #

ToHeaders GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

toHeaders :: GetRole -> [Header] #

ToPath GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

toPath :: GetRole -> ByteString #

ToQuery GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

type Rep GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

type Rep GetRole = D1 ('MetaData "GetRole" "Amazonka.IAM.GetRole" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetRole Source # 
Instance details

Defined in Amazonka.IAM.GetRole

newGetRole Source #

Create a value of GetRole 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:GetRole', getRole_roleName - The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Request Lenses

getRole_roleName :: Lens' GetRole Text Source #

The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Destructuring the Response

data GetRoleResponse Source #

Contains the response to a successful GetRole request.

See: newGetRoleResponse smart constructor.

Constructors

GetRoleResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • role' :: Role

    A structure containing details about the IAM role.

Instances

Instances details
Eq GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Read GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Show GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Generic GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Associated Types

type Rep GetRoleResponse :: Type -> Type #

NFData GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

Methods

rnf :: GetRoleResponse -> () #

type Rep GetRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.GetRole

type Rep GetRoleResponse = D1 ('MetaData "GetRoleResponse" "Amazonka.IAM.GetRole" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetRoleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Role)))

newGetRoleResponse Source #

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

$sel:role':GetRoleResponse', getRoleResponse_role - A structure containing details about the IAM role.

Response Lenses

getRoleResponse_httpStatus :: Lens' GetRoleResponse Int Source #

The response's http status code.

getRoleResponse_role :: Lens' GetRoleResponse Role Source #

A structure containing details about the IAM role.