Skip to content

List Workflow Types

swf_list_workflow_types R Documentation

Returns information about workflow types in the specified domain

Description

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Usage

swf_list_workflow_types(domain, name, registrationStatus, nextPageToken,
  maximumPageSize, reverseOrder)

Arguments

domain

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

name

If specified, lists the workflow type with this name.

registrationStatus

[required] Specifies the registration status of the workflow types to list.

nextPageToken

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.

maximumPageSize

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

reverseOrder

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.

Value

A list with the following syntax: 

list(
  typeInfos = list(
    list(
      workflowType = list(
        name = "string",
        version = "string"
      ),
      status = "REGISTERED"|"DEPRECATED",
      description = "string",
      creationDate = as.POSIXct(
        "2015-01-01"
      ),
      deprecationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$list_workflow_types(
  domain = "string",
  name = "string",
  registrationStatus = "REGISTERED"|"DEPRECATED",
  nextPageToken = "string",
  maximumPageSize = 123,
  reverseOrder = TRUE|FALSE
)