Network.AWS.IAM.ListRoles

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

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

This operation returns paginated results.

Creating a Request

listRoles :: ListRoles

Creates a value of ListRoles with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrPathPrefix - The path prefix for filtering the results. For example, the prefix application_abccomponent_xyz/ gets all roles whose path starts with application_abccomponent_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all roles. This paramater allows (per its <http:wikipedia.orgwikiregex 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, containing any ASCII character from the ! (u0021) thru the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.
• lrMarker - 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.
• lrMaxItems - (Optional) 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, it 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.

data ListRoles

See: listRoles smart constructor.

Instances

Eq ListRoles

Methods

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

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

Data ListRoles

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListRoles -> c ListRoles

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListRoles

toConstr :: ListRoles -> Constr

dataTypeOf :: ListRoles -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListRoles)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListRoles)

gmapT :: (forall b. Data b => b -> b) -> ListRoles -> ListRoles

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListRoles -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListRoles -> r

gmapQ :: (forall d. Data d => d -> u) -> ListRoles -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListRoles -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListRoles -> m ListRoles

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRoles -> m ListRoles

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRoles -> m ListRoles

Read ListRoles

Methods

readsPrec :: Int -> ReadS ListRoles

readList :: ReadS [ListRoles]

readPrec :: ReadPrec ListRoles

readListPrec :: ReadPrec [ListRoles]

Show ListRoles

Methods

showsPrec :: Int -> ListRoles -> ShowS

show :: ListRoles -> String

showList :: [ListRoles] -> ShowS

Generic ListRoles

Associated Types

type Rep ListRoles :: * -> *

Methods

from :: ListRoles -> Rep ListRoles x

to :: Rep ListRoles x -> ListRoles

Hashable ListRoles

Methods

hashWithSalt :: Int -> ListRoles -> Int

hash :: ListRoles -> Int

NFData ListRoles

Methods

rnf :: ListRoles -> ()

AWSPager ListRoles

Methods

page :: ListRoles -> Rs ListRoles -> Maybe ListRoles

AWSRequest ListRoles

Associated Types

type Rs ListRoles :: *

Methods

request :: ListRoles -> Request ListRoles

response :: MonadResource m => Logger -> Service -> Proxy * ListRoles -> ClientResponse -> m (Response ListRoles)

ToQuery ListRoles

Methods

toQuery :: ListRoles -> QueryString

ToPath ListRoles

Methods

toPath :: ListRoles -> ByteString

ToHeaders ListRoles

Methods

toHeaders :: ListRoles -> [Header]

type Rep ListRoles

type Rep ListRoles = D1 (MetaData "ListRoles" "Network.AWS.IAM.ListRoles" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "ListRoles'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lrPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lrMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lrMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs ListRoles

type Rs ListRoles = ListRolesResponse

Request Lenses

lrPathPrefix :: Lens' ListRoles (Maybe Text)

The path prefix for filtering the results. For example, the prefix application_abccomponent_xyz/ gets all roles whose path starts with application_abccomponent_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all roles. This paramater allows (per its <http:wikipedia.orgwikiregex 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, containing any ASCII character from the ! (u0021) thru the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.

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

lrMaxItems :: Lens' ListRoles (Maybe Natural)

(Optional) 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, it 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

listRolesResponse

Arguments

:: Int

lrrsResponseStatus

-> ListRolesResponse

Creates a value of ListRolesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• lrrsIsTruncated - 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 of your results.
• lrrsResponseStatus - -- | The response status code.
• lrrsRoles - A list of roles.

data ListRolesResponse

Contains the response to a successful ListRoles request.

See: listRolesResponse smart constructor.

Instances

Eq ListRolesResponse

Methods

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

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

Data ListRolesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListRolesResponse -> c ListRolesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListRolesResponse

toConstr :: ListRolesResponse -> Constr

dataTypeOf :: ListRolesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListRolesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListRolesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListRolesResponse -> ListRolesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListRolesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListRolesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListRolesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListRolesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListRolesResponse -> m ListRolesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRolesResponse -> m ListRolesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRolesResponse -> m ListRolesResponse

Read ListRolesResponse

Methods

readsPrec :: Int -> ReadS ListRolesResponse

readList :: ReadS [ListRolesResponse]

readPrec :: ReadPrec ListRolesResponse

readListPrec :: ReadPrec [ListRolesResponse]

Show ListRolesResponse

Methods

showsPrec :: Int -> ListRolesResponse -> ShowS

show :: ListRolesResponse -> String

showList :: [ListRolesResponse] -> ShowS

Generic ListRolesResponse

Associated Types

type Rep ListRolesResponse :: * -> *

Methods

from :: ListRolesResponse -> Rep ListRolesResponse x

to :: Rep ListRolesResponse x -> ListRolesResponse

NFData ListRolesResponse

Methods

rnf :: ListRolesResponse -> ()

type Rep ListRolesResponse

type Rep ListRolesResponse = D1 (MetaData "ListRolesResponse" "Network.AWS.IAM.ListRoles" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "ListRolesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lrrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lrrsRoles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Role])))))

Response Lenses

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

lrrsIsTruncated :: 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 of your results.

lrrsResponseStatus :: Lens' ListRolesResponse Int

• - | The response status code.

lrrsRoles :: Lens' ListRolesResponse [Role]

A list of roles.