Skip to content

DescribeArchiveResponse

Source code in docs_src/capo_eventbridge/types/describe_archive_response.py
class DescribeArchiveResponse(TypedDict, closed=True):
    archive_arn: NotRequired["capo_eventbridge.types.archive_arn.ArchiveArn"]
    """<p>The ARN of the archive.</p>"""
    archive_name: NotRequired["capo_eventbridge.types.archive_name.ArchiveName"]
    """<p>The name of the archive.</p>"""
    event_source_arn: NotRequired["capo_eventbridge.types.event_bus_arn.EventBusArn"]
    """<p>The ARN of the event source associated with the archive.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.archive_description.ArchiveDescription"
    ]
    """<p>The description of the archive.</p>"""
    event_pattern: NotRequired["capo_eventbridge.types.event_pattern.EventPattern"]
    """<p>The event pattern used to filter events sent to the archive.</p>"""
    state: NotRequired["capo_eventbridge.types.archive_state.ArchiveState"]
    """<p>The state of the archive.</p>"""
    state_reason: NotRequired[
        "capo_eventbridge.types.archive_state_reason.ArchiveStateReason"
    ]
    """<p>The reason that the archive is in the state.</p>"""
    kms_key_identifier: NotRequired[
        "capo_eventbridge.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    retention_days: NotRequired["capo_eventbridge.types.retention_days.RetentionDays"]
    """<p>The number of days to retain events for in the archive.</p>"""
    size_bytes: "capo_eventbridge.types.long.Long"
    """<p>The size of the archive in bytes.</p>"""
    event_count: "capo_eventbridge.types.long.Long"
    """<p>The number of events in the archive.</p>"""
    creation_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>The time at which the archive was created.</p>"""

archive_arn instance-attribute

archive_arn: NotRequired[ArchiveArn]

The ARN of the archive.

archive_name instance-attribute

archive_name: NotRequired[ArchiveName]

The name of the archive.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time at which the archive was created.

description instance-attribute

description: NotRequired[ArchiveDescription]

The description of the archive.

event_count instance-attribute

event_count: Long

The number of events in the archive.

event_pattern instance-attribute

event_pattern: NotRequired[EventPattern]

The event pattern used to filter events sent to the archive.

event_source_arn instance-attribute

event_source_arn: NotRequired[EventBusArn]

The ARN of the event source associated with the archive.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

retention_days instance-attribute

retention_days: NotRequired[RetentionDays]

The number of days to retain events for in the archive.

size_bytes instance-attribute

size_bytes: Long

The size of the archive in bytes.

state instance-attribute

state: NotRequired[ArchiveState]

The state of the archive.

state_reason instance-attribute

state_reason: NotRequired[ArchiveStateReason]

The reason that the archive is in the state.