mgn / Client / put_template_action

put_template_action#

mgn.Client.put_template_action(**kwargs)#

Put template post migration custom action.

See also: AWS API Documentation

Request Syntax

response = client.put_template_action(
    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'
        }
    },
    launchConfigurationTemplateID='string',
    mustSucceedForCutover=True|False,
    operatingSystem='string',
    order=123,
    parameters={
        'string': [
            {
                'parameterName': 'string',
                'parameterType': 'STRING'
            },
        ]
    },
    timeoutSeconds=123
)
Parameters:

  • actionID (string) –

    [REQUIRED]

    Template post migration custom action ID.

  • actionName (string) –

    [REQUIRED]

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

    [REQUIRED]

    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 can be set: dynamicPath.

        • dynamicPath (string) –

          AWS Systems Manager Document external parameters dynamic path.

  • launchConfigurationTemplateID (string) –

    [REQUIRED]

    Launch configuration template ID.

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

    [REQUIRED]

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

            AWS Systems Manager Parameter Store parameter name.

          • parameterType (string) – [REQUIRED]

            AWS Systems Manager Parameter Store parameter type.

  • timeoutSeconds (integer) – Template post migration custom action timeout in seconds.

Return type:

dict

Returns:

Response Syntax

{
    '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
}

Response Structure

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

Exceptions