pub struct GetSecretValueRequest {
pub secret_id: String,
pub version_id: Option<String>,
pub version_stage: Option<String>,
}
Fields
secret_id: String
Specifies the secret containing the version that you want to retrieve. 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 ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
version_id: Option<String>
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
version_stage: Option<String>
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Trait Implementations
sourceimpl Clone for GetSecretValueRequest
impl Clone for GetSecretValueRequest
sourcefn clone(&self) -> GetSecretValueRequest
fn clone(&self) -> GetSecretValueRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetSecretValueRequest
impl Debug for GetSecretValueRequest
sourceimpl Default for GetSecretValueRequest
impl Default for GetSecretValueRequest
sourcefn default() -> GetSecretValueRequest
fn default() -> GetSecretValueRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<GetSecretValueRequest> for GetSecretValueRequest
impl PartialEq<GetSecretValueRequest> for GetSecretValueRequest
sourcefn eq(&self, other: &GetSecretValueRequest) -> bool
fn eq(&self, other: &GetSecretValueRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetSecretValueRequest) -> bool
fn ne(&self, other: &GetSecretValueRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for GetSecretValueRequest
impl Serialize for GetSecretValueRequest
impl StructuralPartialEq for GetSecretValueRequest
Auto Trait Implementations
impl RefUnwindSafe for GetSecretValueRequest
impl Send for GetSecretValueRequest
impl Sync for GetSecretValueRequest
impl Unpin for GetSecretValueRequest
impl UnwindSafe for GetSecretValueRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more