EventBridge / Client / describe_archive

describe_archive

EventBridge.Client.describe_archive(**kwargs)

Retrieves details about an archive.

See also: AWS API Documentation

Request Syntax

response = client.describe_archive(
    ArchiveName='string'
)
Parameters:

ArchiveName (string) –

[REQUIRED]

The name of the archive to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'ArchiveArn': 'string',
    'ArchiveName': 'string',
    'EventSourceArn': 'string',
    'Description': 'string',
    'EventPattern': 'string',
    'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'StateReason': 'string',
    'KmsKeyIdentifier': 'string',
    'RetentionDays': 123,
    'SizeBytes': 123,
    'EventCount': 123,
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ArchiveArn (string) –

      The ARN of the archive.

    • ArchiveName (string) –

      The name of the archive.

    • EventSourceArn (string) –

      The ARN of the event source associated with the archive.

    • Description (string) –

      The description of the archive.

    • EventPattern (string) –

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

    • State (string) –

      The state of the archive.

    • StateReason (string) –

      The reason that the archive is in the state.

    • KmsKeyIdentifier (string) –

      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.

    • RetentionDays (integer) –

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

    • SizeBytes (integer) –

      The size of the archive in bytes.

    • EventCount (integer) –

      The number of events in the archive.

    • CreationTime (datetime) –

      The time at which the archive was created.

Exceptions