Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SecretsManager.ListSecretVersionIds

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.

To list the secrets in the account, use ListSecrets.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSecretVersionIds Source #

See: newListSecretVersionIds smart constructor.

Constructors

ListSecretVersionIds'

Fields

includeDeprecated :: Maybe Bool
Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.
maxResults :: Maybe Natural
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.
nextToken :: Maybe Text
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.
secretId :: Text
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Instances

Instances details

ToJSON ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods toJSON :: ListSecretVersionIds -> Value # toEncoding :: ListSecretVersionIds -> Encoding # toJSONList :: [ListSecretVersionIds] -> Value # toEncodingList :: [ListSecretVersionIds] -> Encoding #
ToHeaders ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods toHeaders :: ListSecretVersionIds -> [Header] #
ToPath ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods toPath :: ListSecretVersionIds -> ByteString #
ToQuery ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods toQuery :: ListSecretVersionIds -> QueryString #
AWSPager ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods page :: ListSecretVersionIds -> AWSResponse ListSecretVersionIds -> Maybe ListSecretVersionIds #
AWSRequest ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Associated Types type AWSResponse ListSecretVersionIds # Methods request :: (Service -> Service) -> ListSecretVersionIds -> Request ListSecretVersionIds # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSecretVersionIds -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSecretVersionIds))) #
Generic ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Associated Types type Rep ListSecretVersionIds :: Type -> Type # Methods from :: ListSecretVersionIds -> Rep ListSecretVersionIds x # to :: Rep ListSecretVersionIds x -> ListSecretVersionIds #
Read ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods readsPrec :: Int -> ReadS ListSecretVersionIds # readList :: ReadS [ListSecretVersionIds] # readPrec :: ReadPrec ListSecretVersionIds # readListPrec :: ReadPrec [ListSecretVersionIds] #
Show ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods showsPrec :: Int -> ListSecretVersionIds -> ShowS # show :: ListSecretVersionIds -> String # showList :: [ListSecretVersionIds] -> ShowS #
NFData ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods rnf :: ListSecretVersionIds -> () #
Eq ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods (==) :: ListSecretVersionIds -> ListSecretVersionIds -> Bool # (/=) :: ListSecretVersionIds -> ListSecretVersionIds -> Bool #
Hashable ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods hashWithSalt :: Int -> ListSecretVersionIds -> Int # hash :: ListSecretVersionIds -> Int #
type AWSResponse ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds type AWSResponse ListSecretVersionIds = ListSecretVersionIdsResponse
type Rep ListSecretVersionIds Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds type Rep ListSecretVersionIds = D1 ('MetaData "ListSecretVersionIds" "Amazonka.SecretsManager.ListSecretVersionIds" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "ListSecretVersionIds'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSecretVersionIds Source #

Arguments

:: Text	`$sel:secretId:ListSecretVersionIds'`
-> ListSecretVersionIds

Create a value of ListSecretVersionIds with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeDeprecated:ListSecretVersionIds', listSecretVersionIds_includeDeprecated - Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.

$sel:maxResults:ListSecretVersionIds', listSecretVersionIds_maxResults - The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.

ListSecretVersionIds, listSecretVersionIds_nextToken - A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.

$sel:secretId:ListSecretVersionIds', listSecretVersionIds_secretId - The ARN or name of the secret whose versions you want to list.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Request Lenses

listSecretVersionIds_includeDeprecated :: Lens' ListSecretVersionIds (Maybe Bool) Source #

Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.

listSecretVersionIds_maxResults :: Lens' ListSecretVersionIds (Maybe Natural) Source #

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.

listSecretVersionIds_nextToken :: Lens' ListSecretVersionIds (Maybe Text) Source #

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.

listSecretVersionIds_secretId :: Lens' ListSecretVersionIds Text Source #

The ARN or name of the secret whose versions you want to list.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Destructuring the Response

data ListSecretVersionIdsResponse Source #

See: newListSecretVersionIdsResponse smart constructor.

Constructors

ListSecretVersionIdsResponse'

Fields

arn :: Maybe Text
The ARN of the secret.
name :: Maybe Text
The name of the secret.
nextToken :: Maybe Text
Secrets Manager includes this value if there's more output available than what is 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 long list. To get the next results, call ListSecretVersionIds again with this value.
versions :: Maybe [SecretVersionsListEntry]
A list of the versions of the secret.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Associated Types type Rep ListSecretVersionIdsResponse :: Type -> Type # Methods from :: ListSecretVersionIdsResponse -> Rep ListSecretVersionIdsResponse x # to :: Rep ListSecretVersionIdsResponse x -> ListSecretVersionIdsResponse #
Read ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods readsPrec :: Int -> ReadS ListSecretVersionIdsResponse # readList :: ReadS [ListSecretVersionIdsResponse] # readPrec :: ReadPrec ListSecretVersionIdsResponse # readListPrec :: ReadPrec [ListSecretVersionIdsResponse] #
Show ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods showsPrec :: Int -> ListSecretVersionIdsResponse -> ShowS # show :: ListSecretVersionIdsResponse -> String # showList :: [ListSecretVersionIdsResponse] -> ShowS #
NFData ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods rnf :: ListSecretVersionIdsResponse -> () #
Eq ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds Methods (==) :: ListSecretVersionIdsResponse -> ListSecretVersionIdsResponse -> Bool # (/=) :: ListSecretVersionIdsResponse -> ListSecretVersionIdsResponse -> Bool #
type Rep ListSecretVersionIdsResponse Source #
Instance details Defined in Amazonka.SecretsManager.ListSecretVersionIds type Rep ListSecretVersionIdsResponse = D1 ('MetaData "ListSecretVersionIdsResponse" "Amazonka.SecretsManager.ListSecretVersionIds" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "ListSecretVersionIdsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecretVersionsListEntry])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListSecretVersionIdsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSecretVersionIdsResponse'`
-> ListSecretVersionIdsResponse

Create a value of ListSecretVersionIdsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListSecretVersionIdsResponse, listSecretVersionIdsResponse_arn - The ARN of the secret.

ListSecretVersionIdsResponse, listSecretVersionIdsResponse_name - The name of the secret.

ListSecretVersionIds, listSecretVersionIdsResponse_nextToken - Secrets Manager includes this value if there's more output available than what is 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 long list. To get the next results, call ListSecretVersionIds again with this value.

$sel:versions:ListSecretVersionIdsResponse', listSecretVersionIdsResponse_versions - A list of the versions of the secret.

$sel:httpStatus:ListSecretVersionIdsResponse', listSecretVersionIdsResponse_httpStatus - The response's http status code.

Response Lenses

listSecretVersionIdsResponse_arn :: Lens' ListSecretVersionIdsResponse (Maybe Text) Source #

The ARN of the secret.

listSecretVersionIdsResponse_name :: Lens' ListSecretVersionIdsResponse (Maybe Text) Source #

The name of the secret.

listSecretVersionIdsResponse_nextToken :: Lens' ListSecretVersionIdsResponse (Maybe Text) Source #

Secrets Manager includes this value if there's more output available than what is 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 long list. To get the next results, call ListSecretVersionIds again with this value.

listSecretVersionIdsResponse_versions :: Lens' ListSecretVersionIdsResponse (Maybe [SecretVersionsListEntry]) Source #

A list of the versions of the secret.

listSecretVersionIdsResponse_httpStatus :: Lens' ListSecretVersionIdsResponse Int Source #

The response's http status code.