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, documentIdentifier='string', documentVersion='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.
documentIdentifier (string) –
[REQUIRED]
Template post migration custom action document identifier.
documentVersion (string) – Template post migration custom action document version.
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, 'documentIdentifier': 'string', 'documentVersion': '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.
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.
Exceptions
mgn.Client.exceptions.UninitializedAccountException
mgn.Client.exceptions.ResourceNotFoundException
mgn.Client.exceptions.ValidationException
mgn.Client.exceptions.ConflictException