describe_secret¶
Operation¶
async
¶
describe_secret(input: DescribeSecretInput, plugins: list[Plugin] | None = None) -> DescribeSecretOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeSecretInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
DescribeSecretOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DescribeSecretInput structure.
Attributes¶
class-attribute
instance-attribute
¶
secret_id: str | None = None
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.
Output¶
dataclass
¶
Dataclass for DescribeSecretOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
created_date: datetime | None = None
The date the secret was created.
class-attribute
instance-attribute
¶
deleted_date: datetime | None = None
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
class-attribute
instance-attribute
¶
description: str | None = None
The description of the secret.
class-attribute
instance-attribute
¶
external_secret_rotation_metadata: list[ExternalSecretRotationMetadataItem] | None = None
The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.
class-attribute
instance-attribute
¶
external_secret_rotation_role_arn: str | None = None
The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.
class-attribute
instance-attribute
¶
kms_key_id: str | None = None
The key ID or alias ARN of the KMS key that Secrets Manager uses to
encrypt the secret value. If the secret is encrypted with the Amazon Web
Services managed key aws/secretsmanager, this field is omitted.
Secrets created using the console use an KMS key ID.
class-attribute
instance-attribute
¶
last_accessed_date: datetime | None = None
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
class-attribute
instance-attribute
¶
last_changed_date: datetime | None = None
The last date and time that this secret was modified in any way.
class-attribute
instance-attribute
¶
last_rotated_date: datetime | None = None
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
class-attribute
instance-attribute
¶
next_rotation_date: datetime | None = None
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
class-attribute
instance-attribute
¶
owning_service: str | None = None
The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
class-attribute
instance-attribute
¶
primary_region: str | None = None
The Region the secret is in. If a secret is replicated to other Regions,
the replicas are listed in ReplicationStatus.
class-attribute
instance-attribute
¶
replication_status: list[ReplicationStatusType] | None = None
A list of the replicas of this secret and their status:
-
Failed, which indicates that the replica was not created. -
InProgress, which indicates that Secrets Manager is in the process of creating the replica. -
InSync, which indicates that the replica was created.
class-attribute
instance-attribute
¶
rotation_enabled: bool | None = None
Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
class-attribute
instance-attribute
¶
rotation_lambda_arn: str | None = None
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
class-attribute
instance-attribute
¶
rotation_rules: RotationRulesType | None = None
The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
class-attribute
instance-attribute
¶
The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
class-attribute
instance-attribute
¶
type: str | None = None
The exact string that identifies the partner that holds the external secret. For more information, see Using Secrets Manager managed external secrets.
class-attribute
instance-attribute
¶
A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
-
AWSCURRENT, which indicates the current version of the secret. -
AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID
before creating the new secret version. To check if a secret version
exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.