Amazonka.IAM.ListGroups

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.

Creating a Request

data ListGroups

See: newListGroups smart constructor.

Constructors

ListGroups'

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

Instances

ToHeaders ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

toHeaders :: ListGroups -> [Header]

ToPath ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

toPath :: ListGroups -> ByteString

ToQuery ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

toQuery :: ListGroups -> QueryString

AWSPager ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

page :: ListGroups -> AWSResponse ListGroups -> Maybe ListGroups

AWSRequest ListGroups

Defined in Amazonka.IAM.ListGroups

Associated Types

type AWSResponse ListGroups

Methods

request :: (Service -> Service) -> ListGroups -> Request ListGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups)))

Generic ListGroups

Defined in Amazonka.IAM.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Read ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroups

readList :: ReadS [ListGroups]

readPrec :: ReadPrec ListGroups

readListPrec :: ReadPrec [ListGroups]

Show ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

NFData ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

rnf :: ListGroups -> ()

Eq ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool

(/=) :: ListGroups -> ListGroups -> Bool

Hashable ListGroups

Defined in Amazonka.IAM.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

type AWSResponse ListGroups

Defined in Amazonka.IAM.ListGroups

type AWSResponse ListGroups = ListGroupsResponse

type Rep ListGroups

Defined in Amazonka.IAM.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.IAM.ListGroups" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListGroups'" '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)))))

newListGroups :: ListGroups

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:

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.

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

Request Lenses

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

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

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

Destructuring the Response

data ListGroupsResponse

Contains the response to a successful ListGroups request.

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse'

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.

• groups :: [Group]

  A list of groups.

Instances

Generic ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

Read ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroupsResponse

readList :: ReadS [ListGroupsResponse]

readPrec :: ReadPrec ListGroupsResponse

readListPrec :: ReadPrec [ListGroupsResponse]

Show ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

NFData ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

Methods

rnf :: ListGroupsResponse -> ()

Eq ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool

(/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool

type Rep ListGroupsResponse

Defined in Amazonka.IAM.ListGroups

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

newListGroupsResponse

Arguments

:: Int

$sel:httpStatus:ListGroupsResponse'

-> ListGroupsResponse

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:

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.

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:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

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

Response Lenses

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

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

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int

The response's http status code.

listGroupsResponse_groups :: Lens' ListGroupsResponse [Group]

A list of groups.