list_source_server_actions

mgn.Client.list_source_server_actions(**kwargs)

List source server post migration custom actions.

See also: AWS API Documentation

Request Syntax

response = client.list_source_server_actions(
    filters={
        'actionIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string',
    sourceServerID='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) --
  • maxResults (integer) -- Maximum amount of items to return when listing source server post migration custom actions.
  • nextToken (string) -- Next token to use when listing source server post migration custom actions.
  • sourceServerID (string) --

    [REQUIRED]

    Source server ID.

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

      Next token returned when listing source server post migration custom actions.

Exceptions

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