Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_template_actions

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,
            'documentIdentifier': 'string',
            'documentVersion': '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.

        • documentIdentifier (string) --

          Template post migration custom action document identifier.

        • documentVersion (string) --

          Template post migration custom action document version.

        • 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

  • mgn.Client.exceptions.UninitializedAccountException
  • mgn.Client.exceptions.ResourceNotFoundException