SecretListEntry¶
Structure Class¶
SecretListEntry
dataclass
¶
Bases: _SerdeShape
A structure that contains the details about a secret. It does not
include the encrypted SecretString and SecretBinary values. To get
those values, use
GetSecretValue
.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The Amazon Resource Name (ARN) of the secret.
created_date
class-attribute
instance-attribute
¶
created_date: datetime | None = ...
The date and time when a secret was created.
deleted_date
class-attribute
instance-attribute
¶
deleted_date: datetime | None = ...
The date and time the deletion of the secret occurred. Not present on
active secrets. The secret can be recovered until the number of days in
the recovery window has passed, as specified in the
RecoveryWindowInDays parameter of the
DeleteSecret
operation.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The user-provided description of the secret.
external_secret_rotation_metadata
class-attribute
instance-attribute
¶
external_secret_rotation_metadata: list[ExternalSecretRotationMetadataItem] | 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.
external_secret_rotation_role_arn
class-attribute
instance-attribute
¶
external_secret_rotation_role_arn: str | None = ...
The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.
kms_key_id
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The 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.
last_accessed_date
class-attribute
instance-attribute
¶
last_accessed_date: datetime | 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.
last_changed_date
class-attribute
instance-attribute
¶
last_changed_date: datetime | None = ...
The last date and time that this secret was modified in any way.
last_rotated_date
class-attribute
instance-attribute
¶
last_rotated_date: datetime | None = ...
The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
next_rotation_date
class-attribute
instance-attribute
¶
next_rotation_date: datetime | 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.
owning_service
class-attribute
instance-attribute
¶
owning_service: str | None = ...
Returns the name of the service that created the secret.
primary_region
class-attribute
instance-attribute
¶
primary_region: str | None = ...
The Region where Secrets Manager originated the secret.
rotation_enabled
class-attribute
instance-attribute
¶
rotation_enabled: bool | None = ...
Indicates whether automatic, scheduled rotation is enabled for this secret.
rotation_lambda_arn
class-attribute
instance-attribute
¶
rotation_lambda_arn: str | None = ...
The ARN of an Amazon Web Services Lambda function invoked by Secrets
Manager to rotate and expire the secret either automatically per the
schedule or manually by a call to
RotateSecret
.
rotation_rules
class-attribute
instance-attribute
¶
rotation_rules: RotationRulesType | None = ...
A structure that defines the rotation configuration for the secret.
secret_versions_to_stages
class-attribute
instance-attribute
¶
A list of all of the currently assigned SecretVersionStage staging
labels and the SecretVersionId attached to each one. Staging labels
are used to keep track of the different versions during the rotation
process.
Note
A version that does not have any SecretVersionStage is considered
deprecated and subject to deletion. Such versions are not included in
this list.
tags
class-attribute
instance-attribute
¶
The list of user-defined tags associated with the secret. To add tags to
a secret, use
TagResource
. To remove tags, use
UntagResource
.
type
class-attribute
instance-attribute
¶
type: str | None = ...
The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.