You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EventBridge::Types::ListArchivesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListArchivesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name_prefix: "ArchiveName",
  event_source_arn: "Arn",
  state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
  next_token: "NextToken",
  limit: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#event_source_arn ⇒ String

The ARN of the event source associated with the archive.

Returns:

  • (String) —

    The ARN of the event source associated with the archive.

#limit ⇒ Integer

The maximum number of results to return.

Returns:

  • (Integer) —

    The maximum number of results to return.

#name_prefix ⇒ String

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

Returns:

  • (String) —

    A name prefix to filter the archives returned.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#state ⇒ String

The state of the archive.

Possible values:

  • ENABLED
  • DISABLED
  • CREATING
  • UPDATING
  • CREATE_FAILED
  • UPDATE_FAILED

Returns:

  • (String) —

    The state of the archive.