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

Description

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPolicies Source #

See: newListPolicies smart constructor.

Constructors

ListPolicies' 

Fields

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

  • onlyAttached :: Maybe Bool

    A flag to filter the results to only the attached policies.

    When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

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

  • scope :: Maybe PolicyScopeType

    The scope to use for filtering the results.

    To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

    This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

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

  • policyUsageFilter :: Maybe PolicyUsageType

    The policy usage method to use for filtering the results.

    To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

    This parameter is optional. If it is not included, all policies are returned.

Instances

Instances details
Eq ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Read ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Show ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Generic ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Associated Types

type Rep ListPolicies :: Type -> Type #

NFData ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Methods

rnf :: ListPolicies -> () #

Hashable ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

AWSPager ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

AWSRequest ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Associated Types

type AWSResponse ListPolicies #

ToHeaders ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

ToPath ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

ToQuery ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

type Rep ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

type AWSResponse ListPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

newListPolicies :: ListPolicies Source #

Create a value of ListPolicies 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:pathPrefix:ListPolicies', listPolicies_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.

$sel:onlyAttached:ListPolicies', listPolicies_onlyAttached - A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

$sel:marker:ListPolicies', listPolicies_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:scope:ListPolicies', listPolicies_scope - The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

$sel:maxItems:ListPolicies', listPolicies_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:policyUsageFilter:ListPolicies', listPolicies_policyUsageFilter - The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

Request Lenses

listPolicies_pathPrefix :: Lens' ListPolicies (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.

listPolicies_onlyAttached :: Lens' ListPolicies (Maybe Bool) Source #

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

listPolicies_marker :: Lens' ListPolicies (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.

listPolicies_scope :: Lens' ListPolicies (Maybe PolicyScopeType) Source #

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

listPolicies_maxItems :: Lens' ListPolicies (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.

listPolicies_policyUsageFilter :: Lens' ListPolicies (Maybe PolicyUsageType) Source #

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

Destructuring the Response

data ListPoliciesResponse Source #

Contains the response to a successful ListPolicies request.

See: newListPoliciesResponse smart constructor.

Constructors

ListPoliciesResponse' 

Fields

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

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

  • policies :: Maybe [Policy]

    A list of policies.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Read ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Show ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Generic ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Associated Types

type Rep ListPoliciesResponse :: Type -> Type #

NFData ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

Methods

rnf :: ListPoliciesResponse -> () #

type Rep ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicies

type Rep ListPoliciesResponse = D1 ('MetaData "ListPoliciesResponse" "Amazonka.IAM.ListPolicies" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListPoliciesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Policy])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPoliciesResponse Source #

Create a value of ListPoliciesResponse 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:marker:ListPolicies', listPoliciesResponse_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:isTruncated:ListPoliciesResponse', listPoliciesResponse_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.

$sel:policies:ListPoliciesResponse', listPoliciesResponse_policies - A list of policies.

$sel:httpStatus:ListPoliciesResponse', listPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listPoliciesResponse_marker :: Lens' ListPoliciesResponse (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.

listPoliciesResponse_isTruncated :: Lens' ListPoliciesResponse (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.