Network.AWS.SecretsManager.ListSecrets

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 .

Creating a Request

listSecrets :: ListSecrets

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

See: listSecrets smart constructor.

Instances

Eq ListSecrets

Methods

(==) :: ListSecrets -> ListSecrets -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS ListSecrets

readList :: ReadS [ListSecrets]

readPrec :: ReadPrec ListSecrets

readListPrec :: ReadPrec [ListSecrets]

Show ListSecrets

Methods

showsPrec :: Int -> ListSecrets -> ShowS

show :: ListSecrets -> String

showList :: [ListSecrets] -> ShowS

Generic ListSecrets

Associated Types

type Rep ListSecrets :: * -> *

Methods

from :: ListSecrets -> Rep ListSecrets x

to :: Rep ListSecrets x -> ListSecrets

Hashable ListSecrets

Methods

hashWithSalt :: Int -> ListSecrets -> Int

hash :: ListSecrets -> Int

ToJSON ListSecrets

Methods

toJSON :: ListSecrets -> Value

toEncoding :: ListSecrets -> Encoding

toJSONList :: [ListSecrets] -> Value

toEncodingList :: [ListSecrets] -> Encoding

NFData ListSecrets

Methods

rnf :: ListSecrets -> ()

AWSRequest ListSecrets

Associated Types

type Rs ListSecrets :: *

Methods

request :: ListSecrets -> Request ListSecrets

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListSecrets -> ClientResponse -> m (Response ListSecrets)

ToHeaders ListSecrets

Methods

toHeaders :: ListSecrets -> [Header]

ToPath ListSecrets

Methods

toPath :: ListSecrets -> ByteString

ToQuery ListSecrets

Methods

toQuery :: ListSecrets -> QueryString

type Rep ListSecrets

type Rep ListSecrets = D1 * (MetaData "ListSecrets" "Network.AWS.SecretsManager.ListSecrets" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "ListSecrets'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))

type Rs ListSecrets

type Rs ListSecrets = ListSecretsResponse

Request Lenses

lsNextToken :: Lens' ListSecrets (Maybe Text)

(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)

(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

Arguments

:: Int

lsrsResponseStatus

-> ListSecretsResponse

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

See: listSecretsResponse smart constructor.

Instances

Eq ListSecretsResponse

Methods

(==) :: ListSecretsResponse -> ListSecretsResponse -> Bool

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

Data ListSecretsResponse

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

Methods

readsPrec :: Int -> ReadS ListSecretsResponse

readList :: ReadS [ListSecretsResponse]

readPrec :: ReadPrec ListSecretsResponse

readListPrec :: ReadPrec [ListSecretsResponse]

Show ListSecretsResponse

Methods

showsPrec :: Int -> ListSecretsResponse -> ShowS

show :: ListSecretsResponse -> String

showList :: [ListSecretsResponse] -> ShowS

Generic ListSecretsResponse

Associated Types

type Rep ListSecretsResponse :: * -> *

Methods

from :: ListSecretsResponse -> Rep ListSecretsResponse x

to :: Rep ListSecretsResponse x -> ListSecretsResponse

NFData ListSecretsResponse

Methods

rnf :: ListSecretsResponse -> ()

type Rep ListSecretsResponse

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

Response Lenses

lsrsNextToken :: Lens' ListSecretsResponse (Maybe Text)

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]

A list of the secrets in the account.

lsrsResponseStatus :: Lens' ListSecretsResponse Int

• - | The response status code.