CreateArchiveCommand

Suggest an Edit

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.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EventBridgeClient, CreateArchiveCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
// const { EventBridgeClient, CreateArchiveCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
const client = new EventBridgeClient(config);
const input = { // CreateArchiveRequest
  ArchiveName: "STRING_VALUE", // required
  EventSourceArn: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  EventPattern: "STRING_VALUE",
  RetentionDays: Number("int"),
  KmsKeyIdentifier: "STRING_VALUE",
};
const command = new CreateArchiveCommand(input);
const response = await client.send(command);
// { // CreateArchiveResponse
//   ArchiveArn: "STRING_VALUE",
//   State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
//   StateReason: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
// };

CreateArchiveCommand Input

See CreateArchiveCommandInput for more details

Parameter
Type
Description
ArchiveName
Required
string | undefined

The name for the archive to create.

EventSourceArn
Required
string | undefined

The ARN of the event bus that sends events to the archive.

Description
string | undefined

A description for the archive.

EventPattern
string | undefined

An event pattern to use to filter events sent to the archive.

KmsKeyIdentifier
string | undefined

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

For more information, see Identify and view keys  in the Key Management Service Developer Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

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

RetentionDays
number | undefined

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

CreateArchiveCommand Output

See CreateArchiveCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ArchiveArn
string | undefined

The ARN of the archive that was created.

CreationTime
Date | undefined

The time at which the archive was created.

State
ArchiveState | undefined

The state of the archive that was created.

StateReason
string | undefined

The reason that the archive is in the state.

Throws

Name
Fault
Details
ConcurrentModificationException
client

There is concurrent modification on a rule, target, archive, or replay.

InternalException
server

This exception occurs due to unexpected causes.

InvalidEventPatternException
client

The event pattern is not valid.

LimitExceededException
client

The request failed because it attempted to create resource beyond the allowed service quota.

ResourceAlreadyExistsException
client

The resource you are trying to create already exists.

ResourceNotFoundException
client

An entity that you specified does not exist.

EventBridgeServiceException
Base exception class for all service exceptions from EventBridge service.