mgn / Paginator / ListTemplateActions

ListTemplateActions

class mgn.Paginator.ListTemplateActions

paginator = client.get_paginator('list_template_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.list_template_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'actionIDs': [
            'string',
        ]
    },
    launchConfigurationTemplateID='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (dict) –

  Filters to apply when listing template post migration custom actions.

  • actionIDs (list) –

    Action IDs to filter template post migration custom actions by.

    • (string) –

• launchConfigurationTemplateID (string) –

  [REQUIRED]

  Launch configuration template ID.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'actionID': 'string',
            'actionName': 'string',
            'active': True|False,
            'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
            'description': 'string',
            'documentIdentifier': 'string',
            'documentVersion': 'string',
            'externalParameters': {
                'string': {
                    'dynamicPath': 'string'
                }
            },
            'mustSucceedForCutover': True|False,
            'operatingSystem': 'string',
            'order': 123,
            'parameters': {
                'string': [
                    {
                        'parameterName': 'string',
                        'parameterType': 'STRING'
                    },
                ]
            },
            'timeoutSeconds': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    List of template post migration custom actions.

    • (dict) –

      • actionID (string) –

        Template post migration custom action ID.

      • actionName (string) –

        Template post migration custom action name.

      • active (boolean) –

        Template post migration custom action active status.

      • category (string) –

        Template post migration custom action category.

      • description (string) –

        Template post migration custom action description.

      • documentIdentifier (string) –

        Template post migration custom action document identifier.

      • documentVersion (string) –

        Template post migration custom action document version.

      • externalParameters (dict) –

        Template post migration custom action external parameters.

        • (string) –

          • (dict) –

            AWS Systems Manager Document external parameter.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • dynamicPath (string) –

              AWS Systems Manager Document external parameters dynamic path.

      • mustSucceedForCutover (boolean) –

        Template post migration custom action must succeed for cutover.

      • operatingSystem (string) –

        Operating system eligible for this template post migration custom action.

      • order (integer) –

        Template post migration custom action order.

      • parameters (dict) –

        Template post migration custom action parameters.

        • (string) –

          • (list) –

            • (dict) –

              AWS Systems Manager Parameter Store parameter.

              • parameterName (string) –

                AWS Systems Manager Parameter Store parameter name.

              • parameterType (string) –

                AWS Systems Manager Parameter Store parameter type.

      • timeoutSeconds (integer) –

        Template post migration custom action timeout in seconds.

  • NextToken (string) –

    A token to resume pagination.