Describe Archive

eventbridge_describe_archive

R Documentation

Retrieves details about an archive¶

Description¶

Retrieves details about an archive.

Usage¶

eventbridge_describe_archive(ArchiveName)

Arguments¶

ArchiveName

[required] The name of the archive to retrieve.

Value¶

A list with the following syntax:

list(
  ArchiveArn = "string",
  ArchiveName = "string",
  EventSourceArn = "string",
  Description = "string",
  EventPattern = "string",
  State = "ENABLED"|"DISABLED"|"CREATING"|"UPDATING"|"CREATE_FAILED"|"UPDATE_FAILED",
  StateReason = "string",
  RetentionDays = 123,
  SizeBytes = 123,
  EventCount = 123,
  CreationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$describe_archive(
  ArchiveName = "string"
)