amazonka-secretsmanager-1.6.1: Amazon Secrets Manager 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.SecretsManager.ListSecrets

Contents

Description

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds . The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecrets

Related operations

  • To list the versions attached to a secret, use ListSecretVersionIds .
Synopsis

Creating a Request

listSecrets :: ListSecrets Source #

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

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

  • lsNextToken - (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • lsMaxResults - (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

data ListSecrets Source #

See: listSecrets smart constructor.

Instances
Eq ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Data ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Methods

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

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

toConstr :: ListSecrets -> Constr #

dataTypeOf :: ListSecrets -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Show ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Generic ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Associated Types

type Rep ListSecrets :: Type -> Type #

Hashable ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

ToJSON ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

AWSRequest ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Associated Types

type Rs ListSecrets :: Type #

ToHeaders ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Methods

toHeaders :: ListSecrets -> [Header] #

ToPath ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

ToQuery ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

NFData ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Methods

rnf :: ListSecrets -> () #

type Rep ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

type Rep ListSecrets = D1 (MetaData "ListSecrets" "Network.AWS.SecretsManager.ListSecrets" "amazonka-secretsmanager-1.6.1-6zeL5AAjwvS5hEyIAnn7A2" False) (C1 (MetaCons "ListSecrets'" PrefixI True) (S1 (MetaSel (Just "_lsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))
type Rs ListSecrets Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Request Lenses

lsNextToken :: Lens' ListSecrets (Maybe Text) Source #

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

lsMaxResults :: Lens' ListSecrets (Maybe Natural) Source #

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Destructuring the Response

listSecretsResponse Source #

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

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

  • lsrsNextToken - If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).
  • lsrsSecretList - A list of the secrets in the account.
  • lsrsResponseStatus - -- | The response status code.

data ListSecretsResponse Source #

See: listSecretsResponse smart constructor.

Instances
Eq ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Data ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Methods

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

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

toConstr :: ListSecretsResponse -> Constr #

dataTypeOf :: ListSecretsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Show ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Generic ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Associated Types

type Rep ListSecretsResponse :: Type -> Type #

NFData ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

Methods

rnf :: ListSecretsResponse -> () #

type Rep ListSecretsResponse Source # 
Instance details

Defined in Network.AWS.SecretsManager.ListSecrets

type Rep ListSecretsResponse = D1 (MetaData "ListSecretsResponse" "Network.AWS.SecretsManager.ListSecrets" "amazonka-secretsmanager-1.6.1-6zeL5AAjwvS5hEyIAnn7A2" False) (C1 (MetaCons "ListSecretsResponse'" PrefixI True) (S1 (MetaSel (Just "_lsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lsrsSecretList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SecretListEntry])) :*: S1 (MetaSel (Just "_lsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lsrsNextToken :: Lens' ListSecretsResponse (Maybe Text) Source #

If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

lsrsSecretList :: Lens' ListSecretsResponse [SecretListEntry] Source #

A list of the secrets in the account.

lsrsResponseStatus :: Lens' ListSecretsResponse Int Source #

  • - | The response status code.