mgn / Client / list_template_actions

list_template_actions#

mgn.Client.list_template_actions(**kwargs)#

List template post migration custom actions.

See also: AWS API Documentation

Request Syntax

response = client.list_template_actions(
    filters={
        'actionIDs': [
            'string',
        ]
    },
    launchConfigurationTemplateID='string',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – Maximum amount of items to return when listing template post migration custom actions.

  • nextToken (string) – Next token to use when listing template post migration custom actions.

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) –

      Next token returned when listing template post migration custom actions.

Exceptions