Constructor Detail

UpdateSecretVersionStageRequest

Method Detail

setSecretId

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN
too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the
end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one
secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets
Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those
characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause
unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a
hyphen followed by six characters.

Parameters:

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial
ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager
adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it
uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six
characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that
as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete
ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t
create secret names that end with a hyphen followed by six characters.

getSecretId

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN
too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the
end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one
secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets
Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those
characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause
unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a
hyphen followed by six characters.

Returns:

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial
ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager
adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it
uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by
six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use
that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a
complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you
don’t create secret names that end with a hyphen followed by six characters.

withSecretId

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN
too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the
end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one
secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets
Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those
characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause
unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a
hyphen followed by six characters.

Parameters:

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

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial
ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager
adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it
uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six
characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that
as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete
ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t
create secret names that end with a hyphen followed by six characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRemoveFromVersionId

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.

Parameters:

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.

getRemoveFromVersionId

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.

Returns:

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.

withRemoveFromVersionId

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.