swf_list_activity_types: Returns information about all activities registered in the...

View source: R/swf_operations.R

swf_list_activity_typesR Documentation

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.

See https://www.paws-r-sdk.com/docs/swf_list_activity_types/ for full documentation.

Usage

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

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 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 by name of the activity types.


paws.application.integration documentation built on Sept. 12, 2023, 1:18 a.m.