Describe Secret
secretsmanager_describe_secret | R Documentation |
Retrieves the details of a secret¶
Description¶
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
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:DescribeSecret
. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Usage¶
Arguments¶
SecretId
[required] The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Value¶
A list with the following syntax:
list(
ARN = "string",
Name = "string",
Description = "string",
KmsKeyId = "string",
RotationEnabled = TRUE|FALSE,
RotationLambdaARN = "string",
RotationRules = list(
AutomaticallyAfterDays = 123,
Duration = "string",
ScheduleExpression = "string"
),
LastRotatedDate = as.POSIXct(
"2015-01-01"
),
LastChangedDate = as.POSIXct(
"2015-01-01"
),
LastAccessedDate = as.POSIXct(
"2015-01-01"
),
DeletedDate = as.POSIXct(
"2015-01-01"
),
NextRotationDate = as.POSIXct(
"2015-01-01"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
VersionIdsToStages = list(
list(
"string"
)
),
OwningService = "string",
CreatedDate = as.POSIXct(
"2015-01-01"
),
PrimaryRegion = "string",
ReplicationStatus = list(
list(
Region = "string",
KmsKeyId = "string",
Status = "InSync"|"Failed"|"InProgress",
StatusMessage = "string",
LastAccessedDate = as.POSIXct(
"2015-01-01"
)
)
)
)