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

Description

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

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. 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 group, the operation returns an empty list.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroupPolicies Source #

See: newListGroupPolicies smart constructor.

Constructors

ListGroupPolicies' 

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.

  • groupName :: Text

    The name of the group 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
Eq ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Read ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Show ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Generic ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Associated Types

type Rep ListGroupPolicies :: Type -> Type #

NFData ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Methods

rnf :: ListGroupPolicies -> () #

Hashable ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

AWSPager ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

AWSRequest ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Associated Types

type AWSResponse ListGroupPolicies #

ToHeaders ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

ToPath ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

ToQuery ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

type Rep ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

type Rep ListGroupPolicies = D1 ('MetaData "ListGroupPolicies" "Amazonka.IAM.ListGroupPolicies" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListGroupPolicies'" '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 "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListGroupPolicies Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

newListGroupPolicies Source #

Create a value of ListGroupPolicies 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:ListGroupPolicies', listGroupPolicies_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:ListGroupPolicies', listGroupPolicies_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:groupName:ListGroupPolicies', listGroupPolicies_groupName - The name of the group 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

listGroupPolicies_marker :: Lens' ListGroupPolicies (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.

listGroupPolicies_maxItems :: Lens' ListGroupPolicies (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.

listGroupPolicies_groupName :: Lens' ListGroupPolicies Text Source #

The name of the group 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 ListGroupPoliciesResponse Source #

Contains the response to a successful ListGroupPolicies request.

See: newListGroupPoliciesResponse smart constructor.

Constructors

ListGroupPoliciesResponse' 

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.

  • httpStatus :: Int

    The response's http status code.

  • policyNames :: [Text]

    A list of policy names.

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

Defined in Amazonka.IAM.ListGroupPolicies

Read ListGroupPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Show ListGroupPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Generic ListGroupPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

Associated Types

type Rep ListGroupPoliciesResponse :: Type -> Type #

NFData ListGroupPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

type Rep ListGroupPoliciesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupPolicies

type Rep ListGroupPoliciesResponse = D1 ('MetaData "ListGroupPoliciesResponse" "Amazonka.IAM.ListGroupPolicies" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListGroupPoliciesResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "policyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListGroupPoliciesResponse Source #

Create a value of ListGroupPoliciesResponse 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:ListGroupPolicies', listGroupPoliciesResponse_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:ListGroupPoliciesResponse', listGroupPoliciesResponse_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:httpStatus:ListGroupPoliciesResponse', listGroupPoliciesResponse_httpStatus - The response's http status code.

$sel:policyNames:ListGroupPoliciesResponse', listGroupPoliciesResponse_policyNames - A list of policy names.

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: _+=,.@-

Response Lenses

listGroupPoliciesResponse_marker :: Lens' ListGroupPoliciesResponse (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.

listGroupPoliciesResponse_isTruncated :: Lens' ListGroupPoliciesResponse (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.

listGroupPoliciesResponse_policyNames :: Lens' ListGroupPoliciesResponse [Text] Source #

A list of policy names.

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: _+=,.@-