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

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

Network.AWS.IAM.ListAccessKeys

Contents

Description

Returns information about the access key IDs associated with the specified IAM user. If there are none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this operation works for access keys under the AWS account, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

This operation returns paginated results.

Synopsis

Creating a Request

listAccessKeys :: ListAccessKeys Source #

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

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

  • lakUserName - The name of the user. This parameter allows (per 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: _+=,.@-
  • lakMarker - 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.
  • lakMaxItems - (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 ListAccessKeys Source #

See: listAccessKeys smart constructor.

Instances
Eq ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Data ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Methods

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

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

toConstr :: ListAccessKeys -> Constr #

dataTypeOf :: ListAccessKeys -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListAccessKeys) #

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

gmapT :: (forall b. Data b => b -> b) -> ListAccessKeys -> ListAccessKeys #

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

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

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

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

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

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

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

Read ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Show ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Generic ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Associated Types

type Rep ListAccessKeys :: Type -> Type #

Hashable ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

AWSPager ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

AWSRequest ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Associated Types

type Rs ListAccessKeys :: Type #

ToHeaders ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

ToPath ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

ToQuery ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

NFData ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Methods

rnf :: ListAccessKeys -> () #

type Rep ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

type Rep ListAccessKeys = D1 (MetaData "ListAccessKeys" "Network.AWS.IAM.ListAccessKeys" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListAccessKeys'" PrefixI True) (S1 (MetaSel (Just "_lakUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lakMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lakMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs ListAccessKeys Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Request Lenses

lakUserName :: Lens' ListAccessKeys (Maybe Text) Source #

The name of the user. This parameter allows (per 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: _+=,.@-

lakMarker :: Lens' ListAccessKeys (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.

lakMaxItems :: Lens' ListAccessKeys (Maybe Natural) Source #

(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

listAccessKeysResponse Source #

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

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

  • lakrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • lakrsIsTruncated - 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.
  • lakrsResponseStatus - -- | The response status code.
  • lakrsAccessKeyMetadata - A list of objects containing metadata about the access keys.

data ListAccessKeysResponse Source #

Contains the response to a successful ListAccessKeys request.

See: listAccessKeysResponse smart constructor.

Instances
Eq ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Data ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Methods

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

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

toConstr :: ListAccessKeysResponse -> Constr #

dataTypeOf :: ListAccessKeysResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListAccessKeysResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> ListAccessKeysResponse -> ListAccessKeysResponse #

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

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

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

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

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

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

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

Read ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Show ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Generic ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Associated Types

type Rep ListAccessKeysResponse :: Type -> Type #

NFData ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

Methods

rnf :: ListAccessKeysResponse -> () #

type Rep ListAccessKeysResponse Source # 
Instance details

Defined in Network.AWS.IAM.ListAccessKeys

type Rep ListAccessKeysResponse = D1 (MetaData "ListAccessKeysResponse" "Network.AWS.IAM.ListAccessKeys" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListAccessKeysResponse'" PrefixI True) ((S1 (MetaSel (Just "_lakrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lakrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lakrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_lakrsAccessKeyMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [AccessKeyMetadata]))))

Response Lenses

lakrsMarker :: Lens' ListAccessKeysResponse (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.

lakrsIsTruncated :: Lens' ListAccessKeysResponse (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 of your results.

lakrsAccessKeyMetadata :: Lens' ListAccessKeysResponse [AccessKeyMetadata] Source #

A list of objects containing metadata about the access keys.