paws.application.integration (version 0.1.0)

swf_list_activity_types: Returns information about all activities registered in the specified domain that match the specified name and registration status

Description

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Usage

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

Arguments

domain

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

name

If specified, only lists the activity types that have this name.

registrationStatus

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

nextPageToken

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.

maximumPageSize

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.

reverseOrder

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

Request syntax

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

Details

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.