ListSourceServerActions

class mgn.Paginator.ListSourceServerActions
paginator = client.get_paginator('list_source_server_actions')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'actionIDs': [
            'string',
        ]
    },
    sourceServerID='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (dict) --

    Filters to apply when listing source server post migration custom actions.

    • actionIDs (list) --

      Action IDs to filter source server post migration custom actions by.

      • (string) --
  • sourceServerID (string) --

    [REQUIRED]

    Source server 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,
            'documentIdentifier': 'string',
            'documentVersion': 'string',
            'mustSucceedForCutover': True|False,
            'order': 123,
            'parameters': {
                'string': [
                    {
                        'parameterName': 'string',
                        'parameterType': 'STRING'
                    },
                ]
            },
            'timeoutSeconds': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      List of source server post migration custom actions.

      • (dict) --

        • actionID (string) --

          Source server post migration custom action ID.

        • actionName (string) --

          Source server post migration custom action name.

        • active (boolean) --

          Source server post migration custom action active status.

        • documentIdentifier (string) --

          Source server post migration custom action document identifier.

        • documentVersion (string) --

          Source server post migration custom action document version.

        • mustSucceedForCutover (boolean) --

          Source server post migration custom action must succeed for cutover.

        • order (integer) --

          Source server post migration custom action order.

        • parameters (dict) --

          Source server 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) --

          Source server post migration custom action timeout in seconds.

    • NextToken (string) --

      A token to resume pagination.