- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateArchiveCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudWatchEventsClient, CreateArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import
// const { CloudWatchEventsClient, CreateArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import
const client = new CloudWatchEventsClient(config);
const input = { // CreateArchiveRequest
ArchiveName: "STRING_VALUE", // required
EventSourceArn: "STRING_VALUE", // required
Description: "STRING_VALUE",
EventPattern: "STRING_VALUE",
RetentionDays: Number("int"),
};
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
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ArchiveNameRequired | string | undefined | The name for the archive to create. |
EventSourceArnRequired | 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. |
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
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | 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 |
|---|
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. |
| CloudWatchEventsServiceException | Base exception class for all service exceptions from CloudWatchEvents service. |