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

Description

Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListInstanceProfiles Source #

See: newListInstanceProfiles smart constructor.

Constructors

ListInstanceProfiles' 

Fields

  • pathPrefix :: Maybe Text

    The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

    This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. 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 ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Read ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Show ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Generic ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Associated Types

type Rep ListInstanceProfiles :: Type -> Type #

NFData ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Methods

rnf :: ListInstanceProfiles -> () #

Hashable ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

AWSPager ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

AWSRequest ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Associated Types

type AWSResponse ListInstanceProfiles #

ToHeaders ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

ToPath ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

ToQuery ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

type Rep ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

type Rep ListInstanceProfiles = D1 ('MetaData "ListInstanceProfiles" "Amazonka.IAM.ListInstanceProfiles" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListInstanceProfiles'" '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 ListInstanceProfiles Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

newListInstanceProfiles :: ListInstanceProfiles Source #

Create a value of ListInstanceProfiles 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:ListInstanceProfiles', listInstanceProfiles_pathPrefix - The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. 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:ListInstanceProfiles', listInstanceProfiles_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:ListInstanceProfiles', listInstanceProfiles_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

listInstanceProfiles_pathPrefix :: Lens' ListInstanceProfiles (Maybe Text) Source #

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

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

listInstanceProfiles_marker :: Lens' ListInstanceProfiles (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.

listInstanceProfiles_maxItems :: Lens' ListInstanceProfiles (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 ListInstanceProfilesResponse Source #

Contains the response to a successful ListInstanceProfiles request.

See: newListInstanceProfilesResponse smart constructor.

Constructors

ListInstanceProfilesResponse' 

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

Defined in Amazonka.IAM.ListInstanceProfiles

Read ListInstanceProfilesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Show ListInstanceProfilesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Generic ListInstanceProfilesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

Associated Types

type Rep ListInstanceProfilesResponse :: Type -> Type #

NFData ListInstanceProfilesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

type Rep ListInstanceProfilesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListInstanceProfiles

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

newListInstanceProfilesResponse Source #

Create a value of ListInstanceProfilesResponse 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:ListInstanceProfiles', listInstanceProfilesResponse_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:ListInstanceProfilesResponse', listInstanceProfilesResponse_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:ListInstanceProfilesResponse', listInstanceProfilesResponse_httpStatus - The response's http status code.

$sel:instanceProfiles:ListInstanceProfilesResponse', listInstanceProfilesResponse_instanceProfiles - A list of instance profiles.

Response Lenses

listInstanceProfilesResponse_marker :: Lens' ListInstanceProfilesResponse (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.

listInstanceProfilesResponse_isTruncated :: Lens' ListInstanceProfilesResponse (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.