amazonka-iam-1.4.5: Amazon Identity and Access Management SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListRoles

Contents

Description

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.

Synopsis

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. The <http:wikipedia.orgwikiregex regex pattern> for this parameter is 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 - 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 . This parameter is optional. If you do not include it, 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 # 
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 # 
Show ListRoles # 
Generic ListRoles # 

Associated Types

type Rep ListRoles :: * -> * #

Hashable ListRoles # 
NFData ListRoles # 

Methods

rnf :: ListRoles -> () #

AWSPager ListRoles # 
AWSRequest ListRoles # 
ToQuery ListRoles # 
ToPath ListRoles # 
ToHeaders ListRoles # 

Methods

toHeaders :: ListRoles -> [Header] #

type Rep ListRoles # 
type Rep ListRoles = D1 (MetaData "ListRoles" "Network.AWS.IAM.ListRoles" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" 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 # 

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. The <http:wikipedia.orgwikiregex regex pattern> for this parameter is 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) #

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 . This parameter is optional. If you do not include it, 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 #

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 # 
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 # 
Show ListRolesResponse # 
Generic ListRolesResponse # 
NFData ListRolesResponse # 

Methods

rnf :: ListRolesResponse -> () #

type Rep ListRolesResponse # 
type Rep ListRolesResponse = D1 (MetaData "ListRolesResponse" "Network.AWS.IAM.ListRoles" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" 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 DecidedUnpack) (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.