Class: Aws::SQS::Types::ListQueuesRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sqs/types.rb

Overview

Note:

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

{
  queue_name_prefix: "String",
  next_token: "Token",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Maximum number of results to include in the response. Value range is 1 to 1000. You must set `MaxResults` to receive a value for `NextToken` in the response.

Returns:

  • (Integer)

1128
1129
1130
1131
1132
1133
1134
# File 'lib/aws-sdk-sqs/types.rb', line 1128

class ListQueuesRequest < Struct.new(
  :queue_name_prefix,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

Pagination token to request the next set of results.

Returns:

  • (String)

1128
1129
1130
1131
1132
1133
1134
# File 'lib/aws-sdk-sqs/types.rb', line 1128

class ListQueuesRequest < Struct.new(
  :queue_name_prefix,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#queue_name_prefixString

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Returns:

  • (String)

1128
1129
1130
1131
1132
1133
1134
# File 'lib/aws-sdk-sqs/types.rb', line 1128

class ListQueuesRequest < Struct.new(
  :queue_name_prefix,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end