update_secret_version_stage¶
Operation¶
update_secret_version_stage
¶
update_secret_version_stage(request: UpdateSecretVersionStageInput | UpdateSecretVersionStageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSecretVersionStageInputDict]) -> UpdateSecretVersionStageOutput
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are
added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including
it in this call.
Note
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.
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:UpdateSecretVersionStage. For
more information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateSecretVersionStageInput | UpdateSecretVersionStageInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateSecretVersionStageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateSecretVersionStageOutput
|
An instance of |
update_secret_version_stage
async
¶
update_secret_version_stage(request: UpdateSecretVersionStageInput | UpdateSecretVersionStageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSecretVersionStageInputDict]) -> UpdateSecretVersionStageOutput
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are
added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including
it in this call.
Note
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.
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:UpdateSecretVersionStage. For
more information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateSecretVersionStageInput | UpdateSecretVersionStageInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateSecretVersionStageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateSecretVersionStageOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateSecretVersionStageInputDict
¶
Bases: TypedDict
Dictionary form of UpdateSecretVersionStageInput.
Attributes¶
move_to_version_id
instance-attribute
¶
move_to_version_id: str | None
The ID of the version to add the staging label to. 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.
remove_from_version_id
instance-attribute
¶
remove_from_version_id: str | None
The 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.
secret_id
instance-attribute
¶
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
UpdateSecretVersionStageInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateSecretVersionStageInput structure.
Attributes¶
move_to_version_id
class-attribute
instance-attribute
¶
move_to_version_id: str | None = ...
The ID of the version to add the staging label to. 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.
remove_from_version_id
class-attribute
instance-attribute
¶
remove_from_version_id: str | None = ...
The 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.
secret_id
class-attribute
instance-attribute
¶
secret_id: str | None = ...
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Output¶
UpdateSecretVersionStageOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateSecretVersionStageOutput structure.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The ARN of the secret that was updated.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the secret that was updated.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.