amazonka-iam-2.0: Amazon Identity and Access Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IAM.ListRolePolicies

Description

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRolePolicies Source #

See: newListRolePolicies smart constructor.

Constructors

ListRolePolicies' 

Fields

  • marker :: Maybe Text

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

  • maxItems :: Maybe Natural

    Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

    If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

  • roleName :: Text

    The name of the role to list policies for.

    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
ToHeaders ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

ToPath ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

ToQuery ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

AWSPager ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

AWSRequest ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Associated Types

type AWSResponse ListRolePolicies #

Generic ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Associated Types

type Rep ListRolePolicies :: Type -> Type #

Read ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Show ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

NFData ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Methods

rnf :: ListRolePolicies -> () #

Eq ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Hashable ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

type AWSResponse ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

type Rep ListRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

type Rep ListRolePolicies = D1 ('MetaData "ListRolePolicies" "Amazonka.IAM.ListRolePolicies" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListRolePolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRolePolicies Source #

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

ListRolePolicies, listRolePolicies_marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

$sel:maxItems:ListRolePolicies', listRolePolicies_maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

ListRolePolicies, listRolePolicies_roleName - The name of the role to list policies for.

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

listRolePolicies_marker :: Lens' ListRolePolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listRolePolicies_maxItems :: Lens' ListRolePolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listRolePolicies_roleName :: Lens' ListRolePolicies Text Source #

The name of the role to list policies for.

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

Contains the response to a successful ListRolePolicies request.

See: newListRolePoliciesResponse smart constructor.

Constructors

ListRolePoliciesResponse' 

Fields

  • isTruncated :: Maybe Bool

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • marker :: Maybe Text

    When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • httpStatus :: Int

    The response's http status code.

  • policyNames :: [Text]

    A list of policy names.

Instances

Instances details
Generic ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Associated Types

type Rep ListRolePoliciesResponse :: Type -> Type #

Read ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Show ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

NFData ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

Eq ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

type Rep ListRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRolePolicies

type Rep ListRolePoliciesResponse = D1 ('MetaData "ListRolePoliciesResponse" "Amazonka.IAM.ListRolePolicies" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListRolePoliciesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "policyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListRolePoliciesResponse Source #

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

ListRolePoliciesResponse, listRolePoliciesResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

ListRolePolicies, listRolePoliciesResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:httpStatus:ListRolePoliciesResponse', listRolePoliciesResponse_httpStatus - The response's http status code.

$sel:policyNames:ListRolePoliciesResponse', listRolePoliciesResponse_policyNames - A list of policy names.

Response Lenses

listRolePoliciesResponse_isTruncated :: Lens' ListRolePoliciesResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listRolePoliciesResponse_marker :: Lens' ListRolePoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.