Network.AWS.SecretsManager.ListSecretVersionIds

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Minimum permissions

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

• secretsmanager:ListSecretVersionIds

Related operations

• To list the secrets in an account, use ListSecrets .

Creating a Request

listSecretVersionIds

Arguments

:: Text

lsviSecretId

-> ListSecretVersionIds

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

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

• lsviNextToken - (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.
• lsviIncludeDeprecated - (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
• lsviMaxResults - (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.
• lsviSecretId - The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

data ListSecretVersionIds

See: listSecretVersionIds smart constructor.

Instances

Eq ListSecretVersionIds

Methods

(==) :: ListSecretVersionIds -> ListSecretVersionIds -> Bool

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

Data ListSecretVersionIds

Methods

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

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

toConstr :: ListSecretVersionIds -> Constr

dataTypeOf :: ListSecretVersionIds -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListSecretVersionIds

Methods

readsPrec :: Int -> ReadS ListSecretVersionIds

readList :: ReadS [ListSecretVersionIds]

readPrec :: ReadPrec ListSecretVersionIds

readListPrec :: ReadPrec [ListSecretVersionIds]

Show ListSecretVersionIds

Methods

showsPrec :: Int -> ListSecretVersionIds -> ShowS

show :: ListSecretVersionIds -> String

showList :: [ListSecretVersionIds] -> ShowS

Generic ListSecretVersionIds

Associated Types

type Rep ListSecretVersionIds :: * -> *

Methods

from :: ListSecretVersionIds -> Rep ListSecretVersionIds x

to :: Rep ListSecretVersionIds x -> ListSecretVersionIds

Hashable ListSecretVersionIds

Methods

hashWithSalt :: Int -> ListSecretVersionIds -> Int

hash :: ListSecretVersionIds -> Int

ToJSON ListSecretVersionIds

Methods

toJSON :: ListSecretVersionIds -> Value

toEncoding :: ListSecretVersionIds -> Encoding

toJSONList :: [ListSecretVersionIds] -> Value

toEncodingList :: [ListSecretVersionIds] -> Encoding

NFData ListSecretVersionIds

Methods

rnf :: ListSecretVersionIds -> ()

AWSRequest ListSecretVersionIds

Associated Types

type Rs ListSecretVersionIds :: *

Methods

request :: ListSecretVersionIds -> Request ListSecretVersionIds

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

ToHeaders ListSecretVersionIds

Methods

toHeaders :: ListSecretVersionIds -> [Header]

ToPath ListSecretVersionIds

Methods

toPath :: ListSecretVersionIds -> ByteString

ToQuery ListSecretVersionIds

Methods

toQuery :: ListSecretVersionIds -> QueryString

type Rep ListSecretVersionIds

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

type Rs ListSecretVersionIds

type Rs ListSecretVersionIds = ListSecretVersionIdsResponse

Request Lenses

lsviNextToken :: Lens' ListSecretVersionIds (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.

lsviIncludeDeprecated :: Lens' ListSecretVersionIds (Maybe Bool)

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

lsviMaxResults :: Lens' ListSecretVersionIds (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.

lsviSecretId :: Lens' ListSecretVersionIds Text

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Destructuring the Response

listSecretVersionIdsResponse

Arguments

:: Int

lsvirsResponseStatus

-> ListSecretVersionIdsResponse

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

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

• lsvirsARN - The Amazon Resource Name (ARN) for the secret.
• lsvirsVersions - The list of the currently available versions of the specified secret.
• lsvirsNextToken - 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 ).
• lsvirsName - The friendly name of the secret.
• lsvirsResponseStatus - -- | The response status code.

data ListSecretVersionIdsResponse

See: listSecretVersionIdsResponse smart constructor.

Instances

Eq ListSecretVersionIdsResponse

Methods

(==) :: ListSecretVersionIdsResponse -> ListSecretVersionIdsResponse -> Bool

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

Data ListSecretVersionIdsResponse

Methods

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

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

toConstr :: ListSecretVersionIdsResponse -> Constr

dataTypeOf :: ListSecretVersionIdsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListSecretVersionIdsResponse

Methods

readsPrec :: Int -> ReadS ListSecretVersionIdsResponse

readList :: ReadS [ListSecretVersionIdsResponse]

readPrec :: ReadPrec ListSecretVersionIdsResponse

readListPrec :: ReadPrec [ListSecretVersionIdsResponse]

Show ListSecretVersionIdsResponse

Methods

showsPrec :: Int -> ListSecretVersionIdsResponse -> ShowS

show :: ListSecretVersionIdsResponse -> String

showList :: [ListSecretVersionIdsResponse] -> ShowS

Generic ListSecretVersionIdsResponse

Associated Types

type Rep ListSecretVersionIdsResponse :: * -> *

Methods

from :: ListSecretVersionIdsResponse -> Rep ListSecretVersionIdsResponse x

to :: Rep ListSecretVersionIdsResponse x -> ListSecretVersionIdsResponse

NFData ListSecretVersionIdsResponse

Methods

rnf :: ListSecretVersionIdsResponse -> ()

type Rep ListSecretVersionIdsResponse

type Rep ListSecretVersionIdsResponse = D1 * (MetaData "ListSecretVersionIdsResponse" "Network.AWS.SecretsManager.ListSecretVersionIds" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "ListSecretVersionIdsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lsvirsARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsvirsVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [SecretVersionsListEntry])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsvirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsvirsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsvirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

lsvirsARN :: Lens' ListSecretVersionIdsResponse (Maybe Text)

The Amazon Resource Name (ARN) for the secret.

lsvirsVersions :: Lens' ListSecretVersionIdsResponse [SecretVersionsListEntry]

The list of the currently available versions of the specified secret.

lsvirsNextToken :: Lens' ListSecretVersionIdsResponse (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 ).

lsvirsName :: Lens' ListSecretVersionIdsResponse (Maybe Text)

The friendly name of the secret.

lsvirsResponseStatus :: Lens' ListSecretVersionIdsResponse Int

• - | The response status code.