Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecretsManager.UpdateSecretVersionStage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

Minimum permissions

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

secretsmanager:UpdateSecretVersionStage

Related operations

To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Synopsis

Creating a Request

data UpdateSecretVersionStage Source #

See: newUpdateSecretVersionStage smart constructor.

Constructors

UpdateSecretVersionStage'

Fields

removeFromVersionId :: Maybe Text
Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
moveToVersionId :: Maybe Text
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.
secretId :: Text
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
versionStage :: Text
The staging label to add to this version.

Instances

Instances details

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

newUpdateSecretVersionStage Source #

Arguments

:: Text	`$sel:secretId:UpdateSecretVersionStage'`
-> Text	`$sel:versionStage:UpdateSecretVersionStage'`
-> UpdateSecretVersionStage

Create a value of UpdateSecretVersionStage 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:removeFromVersionId:UpdateSecretVersionStage', updateSecretVersionStage_removeFromVersionId - Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

$sel:moveToVersionId:UpdateSecretVersionStage', updateSecretVersionStage_moveToVersionId - (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

$sel:secretId:UpdateSecretVersionStage', updateSecretVersionStage_secretId - Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

$sel:versionStage:UpdateSecretVersionStage', updateSecretVersionStage_versionStage - The staging label to add to this version.

Request Lenses

updateSecretVersionStage_removeFromVersionId :: Lens' UpdateSecretVersionStage (Maybe Text) Source #

Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

updateSecretVersionStage_moveToVersionId :: Lens' UpdateSecretVersionStage (Maybe Text) Source #

(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

updateSecretVersionStage_secretId :: Lens' UpdateSecretVersionStage Text Source #

Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

updateSecretVersionStage_versionStage :: Lens' UpdateSecretVersionStage Text Source #

The staging label to add to this version.

Destructuring the Response

data UpdateSecretVersionStageResponse Source #

See: newUpdateSecretVersionStageResponse smart constructor.

Constructors

UpdateSecretVersionStageResponse'
Fields arn :: Maybe Text The ARN of the secret with the modified staging label. name :: Maybe Text The friendly name of the secret with the modified staging label. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage Methods (==) :: UpdateSecretVersionStageResponse -> UpdateSecretVersionStageResponse -> Bool # (/=) :: UpdateSecretVersionStageResponse -> UpdateSecretVersionStageResponse -> Bool #
Read UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage Methods readsPrec :: Int -> ReadS UpdateSecretVersionStageResponse # readList :: ReadS [UpdateSecretVersionStageResponse] # readPrec :: ReadPrec UpdateSecretVersionStageResponse # readListPrec :: ReadPrec [UpdateSecretVersionStageResponse] #
Show UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage Methods showsPrec :: Int -> UpdateSecretVersionStageResponse -> ShowS # show :: UpdateSecretVersionStageResponse -> String # showList :: [UpdateSecretVersionStageResponse] -> ShowS #
Generic UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage Associated Types type Rep UpdateSecretVersionStageResponse :: Type -> Type # Methods from :: UpdateSecretVersionStageResponse -> Rep UpdateSecretVersionStageResponse x # to :: Rep UpdateSecretVersionStageResponse x -> UpdateSecretVersionStageResponse #
NFData UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage Methods rnf :: UpdateSecretVersionStageResponse -> () #
type Rep UpdateSecretVersionStageResponse Source #
Instance details Defined in Amazonka.SecretsManager.UpdateSecretVersionStage type Rep UpdateSecretVersionStageResponse = D1 ('MetaData "UpdateSecretVersionStageResponse" "Amazonka.SecretsManager.UpdateSecretVersionStage" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UpdateSecretVersionStageResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateSecretVersionStageResponse Source #

Arguments

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

Create a value of UpdateSecretVersionStageResponse 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:arn:UpdateSecretVersionStageResponse', updateSecretVersionStageResponse_arn - The ARN of the secret with the modified staging label.

$sel:name:UpdateSecretVersionStageResponse', updateSecretVersionStageResponse_name - The friendly name of the secret with the modified staging label.

$sel:httpStatus:UpdateSecretVersionStageResponse', updateSecretVersionStageResponse_httpStatus - The response's http status code.

Response Lenses

updateSecretVersionStageResponse_arn :: Lens' UpdateSecretVersionStageResponse (Maybe Text) Source #

The ARN of the secret with the modified staging label.

updateSecretVersionStageResponse_name :: Lens' UpdateSecretVersionStageResponse (Maybe Text) Source #

The friendly name of the secret with the modified staging label.

updateSecretVersionStageResponse_httpStatus :: Lens' UpdateSecretVersionStageResponse Int Source #

The response's http status code.