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.

put_source_server_action

put_source_server_action(**kwargs)

Put source server post migration custom action.

See also: AWS API Documentation

Request Syntax

response = client.put_source_server_action(
    actionID='string',
    actionName='string',
    active=True|False,
    documentIdentifier='string',
    documentVersion='string',
    mustSucceedForCutover=True|False,
    order=123,
    parameters={
        'string': [
            {
                'parameterName': 'string',
                'parameterType': 'STRING'
            },
        ]
    },
    sourceServerID='string',
    timeoutSeconds=123
)
Parameters
  • actionID (string) --

    [REQUIRED]

    Source server post migration custom action ID.

  • actionName (string) --

    [REQUIRED]

    Source server post migration custom action name.

  • active (boolean) -- Source server post migration custom action active status.
  • documentIdentifier (string) --

    [REQUIRED]

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

    [REQUIRED]

    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) -- [REQUIRED]

            AWS Systems Manager Parameter Store parameter name.

          • parameterType (string) -- [REQUIRED]

            AWS Systems Manager Parameter Store parameter type.

  • sourceServerID (string) --

    [REQUIRED]

    Source server ID.

  • timeoutSeconds (integer) -- Source server post migration custom action timeout in seconds.
Return type

dict

Returns

Response Syntax

{
    'actionID': 'string',
    'actionName': 'string',
    'active': True|False,
    'documentIdentifier': 'string',
    'documentVersion': 'string',
    'mustSucceedForCutover': True|False,
    'order': 123,
    'parameters': {
        'string': [
            {
                'parameterName': 'string',
                'parameterType': 'STRING'
            },
        ]
    },
    'timeoutSeconds': 123
}

Response Structure

  • (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.

Exceptions

  • mgn.Client.exceptions.UninitializedAccountException
  • mgn.Client.exceptions.ResourceNotFoundException
  • mgn.Client.exceptions.ValidationException
  • mgn.Client.exceptions.ConflictException