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

Description

Lists the IAM groups that have the specified path prefix.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups' 

Fields

  • pathPrefix :: Maybe Text

    The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

    This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. 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.

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

Instances

Instances details
Eq ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Read ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Show ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Generic ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type #

NFData ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Methods

rnf :: ListGroups -> () #

Hashable ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

AWSPager ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

AWSRequest ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Associated Types

type AWSResponse ListGroups #

ToHeaders ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Methods

toHeaders :: ListGroups -> [Header] #

ToPath ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

ToQuery ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

type Rep ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.IAM.ListGroups" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pathPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListGroups Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

newListGroups :: ListGroups Source #

Create a value of ListGroups 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:ListGroups', listGroups_pathPrefix - The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. 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:marker:ListGroups', listGroups_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:ListGroups', listGroups_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.

Request Lenses

listGroups_pathPrefix :: Lens' ListGroups (Maybe Text) Source #

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. 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.

listGroups_marker :: Lens' ListGroups (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.

listGroups_maxItems :: Lens' ListGroups (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.

Destructuring the Response

data ListGroupsResponse Source #

Contains the response to a successful ListGroups request.

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse' 

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.

  • groups :: [Group]

    A list of groups.

Instances

Instances details
Eq ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Read ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Show ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Generic ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type #

NFData ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.IAM.ListGroups" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListGroupsResponse'" '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 "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Group]))))

newListGroupsResponse Source #

Create a value of ListGroupsResponse 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:ListGroups', listGroupsResponse_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:ListGroupsResponse', listGroupsResponse_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:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

$sel:groups:ListGroupsResponse', listGroupsResponse_groups - A list of groups.

Response Lenses

listGroupsResponse_marker :: Lens' ListGroupsResponse (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.

listGroupsResponse_isTruncated :: Lens' ListGroupsResponse (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.