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

Class: Aws::SWF::Types::ListDomainsInput

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

Overview

Note:

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

{
  next_page_token: "PageToken",
  registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
  maximum_page_size: 1,
  reverse_order: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#maximum_page_sizeInteger

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:

  • (Integer)


3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3348

class ListDomainsInput < Struct.new(
  :next_page_token,
  :registration_status,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#next_page_tokenString

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (String)


3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3348

class ListDomainsInput < Struct.new(
  :next_page_token,
  :registration_status,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#registration_statusString

Specifies the registration status of the domains to list.

Returns:

  • (String)


3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3348

class ListDomainsInput < Struct.new(
  :next_page_token,
  :registration_status,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#reverse_orderBoolean

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Returns:

  • (Boolean)


3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3348

class ListDomainsInput < Struct.new(
  :next_page_token,
  :registration_status,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end