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

Description

Lists the IAM groups that the specified IAM user belongs to.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroupsForUser Source #

See: newListGroupsForUser smart constructor.

Constructors

ListGroupsForUser' 

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.

  • userName :: Text

    The name of the user to list groups 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 ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Read ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Show ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Generic ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Associated Types

type Rep ListGroupsForUser :: Type -> Type #

NFData ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Methods

rnf :: ListGroupsForUser -> () #

Hashable ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

AWSPager ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

AWSRequest ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Associated Types

type AWSResponse ListGroupsForUser #

ToHeaders ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

ToPath ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

ToQuery ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

type Rep ListGroupsForUser Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

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

Defined in Amazonka.IAM.ListGroupsForUser

newListGroupsForUser Source #

Create a value of ListGroupsForUser 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:ListGroupsForUser', listGroupsForUser_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:ListGroupsForUser', listGroupsForUser_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:userName:ListGroupsForUser', listGroupsForUser_userName - The name of the user to list groups 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

listGroupsForUser_marker :: Lens' ListGroupsForUser (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.

listGroupsForUser_maxItems :: Lens' ListGroupsForUser (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.

listGroupsForUser_userName :: Lens' ListGroupsForUser Text Source #

The name of the user to list groups 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 ListGroupsForUserResponse Source #

Contains the response to a successful ListGroupsForUser request.

See: newListGroupsForUserResponse smart constructor.

Constructors

ListGroupsForUserResponse' 

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

Defined in Amazonka.IAM.ListGroupsForUser

Read ListGroupsForUserResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Show ListGroupsForUserResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Generic ListGroupsForUserResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

Associated Types

type Rep ListGroupsForUserResponse :: Type -> Type #

NFData ListGroupsForUserResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

type Rep ListGroupsForUserResponse Source # 
Instance details

Defined in Amazonka.IAM.ListGroupsForUser

type Rep ListGroupsForUserResponse = D1 ('MetaData "ListGroupsForUserResponse" "Amazonka.IAM.ListGroupsForUser" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListGroupsForUserResponse'" '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]))))

newListGroupsForUserResponse Source #

Create a value of ListGroupsForUserResponse 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:ListGroupsForUser', listGroupsForUserResponse_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:ListGroupsForUserResponse', listGroupsForUserResponse_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:ListGroupsForUserResponse', listGroupsForUserResponse_httpStatus - The response's http status code.

$sel:groups:ListGroupsForUserResponse', listGroupsForUserResponse_groups - A list of groups.

Response Lenses

listGroupsForUserResponse_marker :: Lens' ListGroupsForUserResponse (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.

listGroupsForUserResponse_isTruncated :: Lens' ListGroupsForUserResponse (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.