Amazonka.IAM.ListRoles

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles.

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 a role, see GetRole.

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

This operation returns paginated results.

Creating a Request

data ListRoles

See: newListRoles smart constructor.

Constructors

ListRoles'

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 /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

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

Defined in Amazonka.IAM.ListRoles

Methods

toHeaders :: ListRoles -> [Header]

ToPath ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

toPath :: ListRoles -> ByteString

ToQuery ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

toQuery :: ListRoles -> QueryString

AWSPager ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

page :: ListRoles -> AWSResponse ListRoles -> Maybe ListRoles

AWSRequest ListRoles

Defined in Amazonka.IAM.ListRoles

Associated Types

type AWSResponse ListRoles

Methods

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

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

Generic ListRoles

Defined in Amazonka.IAM.ListRoles

Associated Types

type Rep ListRoles :: Type -> Type

Methods

from :: ListRoles -> Rep ListRoles x

to :: Rep ListRoles x -> ListRoles

Read ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

readsPrec :: Int -> ReadS ListRoles

readList :: ReadS [ListRoles]

readPrec :: ReadPrec ListRoles

readListPrec :: ReadPrec [ListRoles]

Show ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

showsPrec :: Int -> ListRoles -> ShowS

show :: ListRoles -> String

showList :: [ListRoles] -> ShowS

NFData ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

rnf :: ListRoles -> ()

Eq ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

(==) :: ListRoles -> ListRoles -> Bool

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

Hashable ListRoles

Defined in Amazonka.IAM.ListRoles

Methods

hashWithSalt :: Int -> ListRoles -> Int

hash :: ListRoles -> Int

type AWSResponse ListRoles

Defined in Amazonka.IAM.ListRoles

type AWSResponse ListRoles = ListRolesResponse

type Rep ListRoles

Defined in Amazonka.IAM.ListRoles

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

newListRoles :: ListRoles

Create a value of ListRoles 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:

ListRoles, listRoles_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:ListRoles', listRoles_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:ListRoles', listRoles_pathPrefix - The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

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

listRoles_marker :: Lens' ListRoles (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.

listRoles_maxItems :: Lens' ListRoles (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.

listRoles_pathPrefix :: Lens' ListRoles (Maybe Text)

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

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

Contains the response to a successful ListRoles request.

See: newListRolesResponse smart constructor.

Constructors

ListRolesResponse'

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.

• roles :: [Role]

  A list of roles.

Instances

Generic ListRolesResponse

Defined in Amazonka.IAM.ListRoles

Associated Types

type Rep ListRolesResponse :: Type -> Type

Methods

from :: ListRolesResponse -> Rep ListRolesResponse x

to :: Rep ListRolesResponse x -> ListRolesResponse

Read ListRolesResponse

Defined in Amazonka.IAM.ListRoles

Methods

readsPrec :: Int -> ReadS ListRolesResponse

readList :: ReadS [ListRolesResponse]

readPrec :: ReadPrec ListRolesResponse

readListPrec :: ReadPrec [ListRolesResponse]

Show ListRolesResponse

Defined in Amazonka.IAM.ListRoles

Methods

showsPrec :: Int -> ListRolesResponse -> ShowS

show :: ListRolesResponse -> String

showList :: [ListRolesResponse] -> ShowS

NFData ListRolesResponse

Defined in Amazonka.IAM.ListRoles

Methods

rnf :: ListRolesResponse -> ()

Eq ListRolesResponse

Defined in Amazonka.IAM.ListRoles

Methods

(==) :: ListRolesResponse -> ListRolesResponse -> Bool

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

type Rep ListRolesResponse

Defined in Amazonka.IAM.ListRoles

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

newListRolesResponse

Arguments

:: Int

$sel:httpStatus:ListRolesResponse'

-> ListRolesResponse

Create a value of ListRolesResponse 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:

ListRolesResponse, listRolesResponse_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.

ListRoles, listRolesResponse_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:ListRolesResponse', listRolesResponse_httpStatus - The response's http status code.

ListRolesResponse, listRolesResponse_roles - A list of roles.

Response Lenses

listRolesResponse_isTruncated :: Lens' ListRolesResponse (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.

listRolesResponse_marker :: Lens' ListRolesResponse (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.

listRolesResponse_httpStatus :: Lens' ListRolesResponse Int

The response's http status code.

listRolesResponse_roles :: Lens' ListRolesResponse [Role]

A list of roles.