SWF / Client / list_activity_types

list_activity_types#

SWF.Client.list_activity_types(**kwargs)#

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.list_activity_types(
    domain='string',
    name='string',
    registrationStatus='REGISTERED'|'DEPRECATED',
    nextPageToken='string',
    maximumPageSize=123,
    reverseOrder=True|False
)
Parameters:

  • domain (string) –

    [REQUIRED]

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

  • name (string) – If specified, only lists the activity types that have this name.

  • registrationStatus (string) –

    [REQUIRED]

    Specifies the registration status of the activity types to list.

  • nextPageToken (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.

  • maximumPageSize (integer) – The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

  • reverseOrder (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'typeInfos': [
        {
            'activityType': {
                'name': 'string',
                'version': 'string'
            },
            'status': 'REGISTERED'|'DEPRECATED',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'deprecationDate': datetime(2015, 1, 1)
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

  • (dict) –

    Contains a paginated list of activity type information structures.

    • typeInfos (list) –

      List of activity type information.

      • (dict) –

        Detailed information about an activity type.

        • activityType (dict) –

          The ActivityType type structure representing the activity type.

          • name (string) –

            The name of this activity.

            Note

            The combination of activity type name and version must be unique within a domain.

          • version (string) –

            The version of this activity.

            Note

            The combination of activity type name and version must be unique with in a domain.

        • status (string) –

          The current status of the activity type.

        • description (string) –

          The description of the activity type provided in RegisterActivityType.

        • creationDate (datetime) –

          The date and time this activity type was created through RegisterActivityType.

        • deprecationDate (datetime) –

          If DEPRECATED, the date and time DeprecateActivityType was called.

    • nextPageToken (string) –

      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.

Exceptions