Skip to content

SecretListEntry

Source code in docs_src/capo_secrets_manager/types/secret_list_entry.py
class SecretListEntry(TypedDict, closed=True):
    arn: NotRequired["capo_secrets_manager.types.secret_arn_type.SecretARNType"]
    """<p>The Amazon Resource Name (ARN) of the secret.</p>"""
    name: NotRequired["capo_secrets_manager.types.secret_name_type.SecretNameType"]
    """<p>The friendly name of the secret. </p>"""
    type: NotRequired["capo_secrets_manager.types.medea_type_type.MedeaTypeType"]
    """<p>The exact string that identifies the third-party partner that holds the external secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secret partners</a>.</p>"""
    description: NotRequired[
        "capo_secrets_manager.types.description_type.DescriptionType"
    ]
    """<p>The user-provided description of the secret.</p>"""
    kms_key_id: NotRequired["capo_secrets_manager.types.kms_key_id_type.KmsKeyIdType"]
    """<p>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 <code>aws/secretsmanager</code>, this field is omitted.</p>"""
    rotation_enabled: NotRequired[
        "capo_secrets_manager.types.rotation_enabled_type.RotationEnabledType"
    ]
    """<p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>"""
    rotation_lambda_arn: NotRequired[
        "capo_secrets_manager.types.rotation_lambda_arn_type.RotationLambdaARNType"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html"> <code>RotateSecret</code> </a>.</p>"""
    rotation_rules: NotRequired[
        "capo_secrets_manager.types.rotation_rules_type.RotationRulesType"
    ]
    """<p>A structure that defines the rotation configuration for the secret.</p>"""
    external_secret_rotation_metadata: NotRequired[
        "capo_secrets_manager.types.external_secret_rotation_metadata_type.ExternalSecretRotationMetadataType"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secrets partners</a>.</p>"""
    external_secret_rotation_role_arn: NotRequired[
        "capo_secrets_manager.types.role_arn_type.RoleARNType"
    ]
    """<p>The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secrets partners</a>.</p>"""
    last_rotated_date: NotRequired[
        "capo_secrets_manager.types.last_rotated_date_type.LastRotatedDateType"
    ]
    """<p>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.</p>"""
    last_changed_date: NotRequired[
        "capo_secrets_manager.types.last_changed_date_type.LastChangedDateType"
    ]
    """<p>The last date and time that this secret was modified in any way.</p>"""
    last_accessed_date: NotRequired[
        "capo_secrets_manager.types.last_accessed_date_type.LastAccessedDateType"
    ]
    """<p>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.</p>"""
    deleted_date: NotRequired[
        "capo_secrets_manager.types.deleted_date_type.DeletedDateType"
    ]
    """<p>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 <code>RecoveryWindowInDays</code> parameter of the <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html"> <code>DeleteSecret</code> </a> operation.</p>"""
    next_rotation_date: NotRequired[
        "capo_secrets_manager.types.next_rotation_date_type.NextRotationDateType"
    ]
    """<p>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.</p>"""
    tags: NotRequired["capo_secrets_manager.types.tag_list_type.TagListType"]
    """<p>The list of user-defined tags associated with the secret. To add tags to a secret, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html"> <code>TagResource</code> </a>. To remove tags, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html"> <code>UntagResource</code> </a>.</p>"""
    secret_versions_to_stages: NotRequired[
        "capo_secrets_manager.types.secret_versions_to_stages_map_type.SecretVersionsToStagesMapType"
    ]
    """<p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep track of the different versions during the rotation process.</p> <note> <p>A version that does not have any <code>SecretVersionStage</code> is considered deprecated and subject to deletion. Such versions are not included in this list.</p> </note>"""
    owning_service: NotRequired[
        "capo_secrets_manager.types.owning_service_type.OwningServiceType"
    ]
    """<p>Returns the name of the service that created the secret.</p>"""
    created_date: NotRequired["capo_secrets_manager.types.timestamp_type.TimestampType"]
    """<p>The date and time when a secret was created.</p>"""
    primary_region: NotRequired["capo_secrets_manager.types.region_type.RegionType"]
    """<p>The Region where Secrets Manager originated the secret.</p>"""

arn instance-attribute

arn: NotRequired[SecretARNType]

The Amazon Resource Name (ARN) of the secret.

created_date instance-attribute

created_date: NotRequired[TimestampType]

The date and time when a secret was created.

deleted_date instance-attribute

deleted_date: NotRequired[DeletedDateType]

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 instance-attribute

description: NotRequired[DescriptionType]

The user-provided description of the secret.

external_secret_rotation_metadata instance-attribute

external_secret_rotation_metadata: NotRequired[ExternalSecretRotationMetadataType]

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 instance-attribute

external_secret_rotation_role_arn: NotRequired[RoleARNType]

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 instance-attribute

kms_key_id: NotRequired[KmsKeyIdType]

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 instance-attribute

last_accessed_date: NotRequired[LastAccessedDateType]

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 instance-attribute

last_changed_date: NotRequired[LastChangedDateType]

The last date and time that this secret was modified in any way.

last_rotated_date instance-attribute

last_rotated_date: NotRequired[LastRotatedDateType]

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.

name instance-attribute

name: NotRequired[SecretNameType]

The friendly name of the secret.

next_rotation_date instance-attribute

next_rotation_date: NotRequired[NextRotationDateType]

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 instance-attribute

owning_service: NotRequired[OwningServiceType]

Returns the name of the service that created the secret.

primary_region instance-attribute

primary_region: NotRequired[RegionType]

The Region where Secrets Manager originated the secret.

rotation_enabled instance-attribute

rotation_enabled: NotRequired[RotationEnabledType]

Indicates whether automatic, scheduled rotation is enabled for this secret.

rotation_lambda_arn instance-attribute

rotation_lambda_arn: NotRequired[RotationLambdaARNType]

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 instance-attribute

rotation_rules: NotRequired[RotationRulesType]

A structure that defines the rotation configuration for the secret.

secret_versions_to_stages instance-attribute

secret_versions_to_stages: NotRequired[SecretVersionsToStagesMapType]

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.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

tags instance-attribute

tags: NotRequired[TagListType]

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

type instance-attribute

type: NotRequired[MedeaTypeType]

The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.