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

Inherits:

Struct

• Object
• Struct
• Aws::SWF::Types::ListWorkflowTypesInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-swf/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain ⇒ String

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

• #maximum_page_size ⇒ Integer

  The maximum number of results that are returned per call.

• #name ⇒ String

  If specified, lists the workflow type with this name.

• #next_page_token ⇒ String

  If ‘NextPageToken` is returned there are more results available.

• #registration_status ⇒ String

  Specifies the registration status of the workflow types to list.

• #reverse_order ⇒ Boolean

  When set to ‘true`, returns the results in reverse order.

Instance Attribute Details

#domain ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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

#maximum_page_size ⇒ Integer

The maximum number of results that are returned per call. Use ‘nextPageToken` to obtain further pages of results.

Returns:

• (Integer)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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

#name ⇒ String

If specified, lists the workflow type with this name.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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

#next_page_token ⇒ String

If ‘NextPageToken` is returned there are more results available. The value of `NextPageToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a `400` error: “`Specified token has exceeded its maximum lifetime`”.

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

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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

#registration_status ⇒ String

Specifies the registration status of the workflow types to list.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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

#reverse_order ⇒ Boolean

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)

# File 'lib/aws-sdk-swf/types.rb', line 3294

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