describe_archive

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',
    '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.

    • 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

  • EventBridge.Client.exceptions.ResourceAlreadyExistsException
  • EventBridge.Client.exceptions.ResourceNotFoundException
  • EventBridge.Client.exceptions.InternalException