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

Class: Aws::SWF::Types::ListWorkflowTypesInput

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 ListWorkflowTypesInput data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

The name of the domain in which the workflow types have been registered.

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

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

#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)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

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

#nameString

If specified, lists the workflow type with this name.

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

class ListWorkflowTypesInput < Struct.new(
  :domain,
  :name,
  :registration_status,
  :next_page_token,
  :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)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

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

#registration_statusString

Specifies the registration status of the workflow types to list.

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

class ListWorkflowTypesInput < Struct.new(
  :domain,
  :name,
  :registration_status,
  :next_page_token,
  :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 of the name of the workflow types.

Returns:

  • (Boolean)


3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3509

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