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

Description

Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About instance profiles.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListInstanceProfilesForRole Source #

See: newListInstanceProfilesForRole smart constructor.

Constructors

ListInstanceProfilesForRole' 

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.

  • roleName :: Text

    The name of the role to list instance profiles 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 ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Read ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Show ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Generic ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Associated Types

type Rep ListInstanceProfilesForRole :: Type -> Type #

NFData ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Hashable ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

AWSPager ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

AWSRequest ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

ToHeaders ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

ToPath ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

ToQuery ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

type Rep ListInstanceProfilesForRole Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

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

Defined in Amazonka.IAM.ListInstanceProfilesForRole

newListInstanceProfilesForRole Source #

Create a value of ListInstanceProfilesForRole 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:ListInstanceProfilesForRole', listInstanceProfilesForRole_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:ListInstanceProfilesForRole', listInstanceProfilesForRole_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:roleName:ListInstanceProfilesForRole', listInstanceProfilesForRole_roleName - The name of the role to list instance profiles 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

listInstanceProfilesForRole_marker :: Lens' ListInstanceProfilesForRole (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.

listInstanceProfilesForRole_maxItems :: Lens' ListInstanceProfilesForRole (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.

listInstanceProfilesForRole_roleName :: Lens' ListInstanceProfilesForRole Text Source #

The name of the role to list instance profiles 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 ListInstanceProfilesForRoleResponse Source #

Contains the response to a successful ListInstanceProfilesForRole request.

See: newListInstanceProfilesForRoleResponse smart constructor.

Constructors

ListInstanceProfilesForRoleResponse' 

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.

  • instanceProfiles :: [InstanceProfile]

    A list of instance profiles.

Instances

Instances details
Eq ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Read ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Show ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

Generic ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

NFData ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

type Rep ListInstanceProfilesForRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfilesForRole

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

newListInstanceProfilesForRoleResponse Source #

Create a value of ListInstanceProfilesForRoleResponse 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:ListInstanceProfilesForRole', listInstanceProfilesForRoleResponse_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:ListInstanceProfilesForRoleResponse', listInstanceProfilesForRoleResponse_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:ListInstanceProfilesForRoleResponse', listInstanceProfilesForRoleResponse_httpStatus - The response's http status code.

$sel:instanceProfiles:ListInstanceProfilesForRoleResponse', listInstanceProfilesForRoleResponse_instanceProfiles - A list of instance profiles.

Response Lenses

listInstanceProfilesForRoleResponse_marker :: Lens' ListInstanceProfilesForRoleResponse (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.

listInstanceProfilesForRoleResponse_isTruncated :: Lens' ListInstanceProfilesForRoleResponse (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.