update_archive

EventBridge.Client.update_archive(**kwargs)

Updates the specified archive.

See also: AWS API Documentation

Request Syntax

response = client.update_archive(
    ArchiveName='string',
    Description='string',
    EventPattern='string',
    RetentionDays=123
)

Parameters

• ArchiveName (string) --

  [REQUIRED]

  The name of the archive to update.

• Description (string) -- The description for the archive.
• EventPattern (string) -- The event pattern to use to filter events sent to the archive.
• RetentionDays (integer) -- The number of days to retain events in the archive.

Return type

dict

Returns

Response Syntax

{
    'ArchiveArn': 'string',
    'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'StateReason': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • ArchiveArn (string) --

    The ARN of the archive.

  • State (string) --

    The state of the archive.

  • StateReason (string) --

    The reason that the archive is in the current state.

  • CreationTime (datetime) --

    The time at which the archive was updated.

Exceptions

• EventBridge.Client.exceptions.ConcurrentModificationException
• EventBridge.Client.exceptions.ResourceNotFoundException
• EventBridge.Client.exceptions.InternalException
• EventBridge.Client.exceptions.LimitExceededException
• EventBridge.Client.exceptions.InvalidEventPatternException