eventbridge_list_archives: Lists your archives

Description Usage Arguments Value Request syntax

View source: R/eventbridge_operations.R

Description

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

Usage

1
2
eventbridge_list_archives(NamePrefix, EventSourceArn, State, NextToken,
  Limit)

Arguments

NamePrefix

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

EventSourceArn

The ARN of the event source associated with the archive.

State

The state of the archive.

NextToken

The token returned by a previous call to retrieve the next set of results.

Limit

The maximum number of results to return.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
list(
  Archives = list(
    list(
      ArchiveName = "string",
      EventSourceArn = "string",
      State = "ENABLED"|"DISABLED"|"CREATING"|"UPDATING"|"CREATE_FAILED"|"UPDATE_FAILED",
      StateReason = "string",
      RetentionDays = 123,
      SizeBytes = 123,
      EventCount = 123,
      CreationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$list_archives(
  NamePrefix = "string",
  EventSourceArn = "string",
  State = "ENABLED"|"DISABLED"|"CREATING"|"UPDATING"|"CREATE_FAILED"|"UPDATE_FAILED",
  NextToken = "string",
  Limit = 123
)

paws.application.integration documentation built on Aug. 23, 2021, 9:20 a.m.