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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListWorkflowTypesInput as input to an Aws::Client method, you can use a vanilla 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

#domain ⇒ String

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

Returns:

  • (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. Use nextPageToken to obtain further pages of results.

Returns:

  • (Integer) —

    The maximum number of results that are returned per call.

#name ⇒ String

If specified, lists the workflow type with this name.

Returns:

  • (String) —

    If specified, lists the workflow type with this name.

#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 60 seconds. 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) —

    If NextPageToken is returned there are more results available.

#registration_status ⇒ String

Specifies the registration status of the workflow types to list.

Possible values:

  • REGISTERED
  • DEPRECATED

Returns:

  • (String) —

    Specifies the registration status of the workflow types to list.

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

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