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.ListAttachedRolePolicies

Description

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For 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. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAttachedRolePolicies Source #

See: newListAttachedRolePolicies smart constructor.

Constructors

ListAttachedRolePolicies' 

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.

  • pathPrefix :: Maybe Text

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

    This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • roleName :: Text

    The name (friendly name, not ARN) of the role to list attached 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 ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

ToPath ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

ToQuery ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

AWSPager ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

AWSRequest ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Generic ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Associated Types

type Rep ListAttachedRolePolicies :: Type -> Type #

Read ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Show ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

NFData ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Eq ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Hashable ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

type AWSResponse ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

type Rep ListAttachedRolePolicies Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

type Rep ListAttachedRolePolicies = D1 ('MetaData "ListAttachedRolePolicies" "Amazonka.IAM.ListAttachedRolePolicies" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListAttachedRolePolicies'" '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 "pathPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListAttachedRolePolicies Source #

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

ListAttachedRolePolicies, listAttachedRolePolicies_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:ListAttachedRolePolicies', listAttachedRolePolicies_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.

$sel:pathPrefix:ListAttachedRolePolicies', listAttachedRolePolicies_pathPrefix - The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

ListAttachedRolePolicies, listAttachedRolePolicies_roleName - The name (friendly name, not ARN) of the role to list attached 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

listAttachedRolePolicies_marker :: Lens' ListAttachedRolePolicies (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.

listAttachedRolePolicies_maxItems :: Lens' ListAttachedRolePolicies (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.

listAttachedRolePolicies_pathPrefix :: Lens' ListAttachedRolePolicies (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listAttachedRolePolicies_roleName :: Lens' ListAttachedRolePolicies Text Source #

The name (friendly name, not ARN) of the role to list attached 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 ListAttachedRolePoliciesResponse Source #

Contains the response to a successful ListAttachedRolePolicies request.

See: newListAttachedRolePoliciesResponse smart constructor.

Constructors

ListAttachedRolePoliciesResponse' 

Fields

  • attachedPolicies :: Maybe [AttachedPolicy]

    A list of the attached policies.

  • 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.

Instances

Instances details
Generic ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Associated Types

type Rep ListAttachedRolePoliciesResponse :: Type -> Type #

Read ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Show ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

NFData ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

Eq ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

type Rep ListAttachedRolePoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListAttachedRolePolicies

type Rep ListAttachedRolePoliciesResponse = D1 ('MetaData "ListAttachedRolePoliciesResponse" "Amazonka.IAM.ListAttachedRolePolicies" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListAttachedRolePoliciesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attachedPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachedPolicy])) :*: 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))))

newListAttachedRolePoliciesResponse Source #

Create a value of ListAttachedRolePoliciesResponse 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:attachedPolicies:ListAttachedRolePoliciesResponse', listAttachedRolePoliciesResponse_attachedPolicies - A list of the attached policies.

ListAttachedRolePoliciesResponse, listAttachedRolePoliciesResponse_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.

ListAttachedRolePolicies, listAttachedRolePoliciesResponse_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:ListAttachedRolePoliciesResponse', listAttachedRolePoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listAttachedRolePoliciesResponse_isTruncated :: Lens' ListAttachedRolePoliciesResponse (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.

listAttachedRolePoliciesResponse_marker :: Lens' ListAttachedRolePoliciesResponse (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.