Module Smaws_Client_EventBridge.CreateArchive

val request : Smaws_Lib.Context.t -> create_archive_request -> (create_archive_response, [> Smaws_Lib.Protocols.AwsJson.error | `ConcurrentModificationException of concurrent_modification_exception | `InternalException of internal_exception | `InvalidEventPatternException of invalid_event_pattern_exception | `LimitExceededException of limit_exceeded_exception | `ResourceAlreadyExistsException of resource_already_exists_exception | `ResourceNotFoundException of resource_not_found_exception ]) Stdlib.result

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call

    {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html}CreateArchive}

    on an event bus set to use a customer managed key for encryption.

  • You call

    {{:https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer}CreateDiscoverer}

    on an event bus set to use a customer managed key for encryption.

  • You call

    {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html}UpdatedEventBus}

    to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.