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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

When making an API call, you may pass ListArchivesRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_source_arnString

The ARN of the event source associated with the archive.

Returns:

  • (String)


3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3196

class ListArchivesRequest < Struct.new(
  :name_prefix,
  :event_source_arn,
  :state,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

The maximum number of results to return.

Returns:

  • (Integer)


3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3196

class ListArchivesRequest < Struct.new(
  :name_prefix,
  :event_source_arn,
  :state,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#name_prefixString

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

Returns:

  • (String)


3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3196

class ListArchivesRequest < Struct.new(
  :name_prefix,
  :event_source_arn,
  :state,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3196

class ListArchivesRequest < Struct.new(
  :name_prefix,
  :event_source_arn,
  :state,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the archive.

Returns:

  • (String)


3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3196

class ListArchivesRequest < Struct.new(
  :name_prefix,
  :event_source_arn,
  :state,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end