PutTemplateAction - ApplicationMigrationService
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

PutTemplateAction

Put template post migration custom action.

Request Syntax

POST /PutTemplateAction HTTP/1.1
Content-type: application/json

{
   "actionID": "string",
   "actionName": "string",
   "active": boolean,
   "category": "string",
   "description": "string",
   "documentIdentifier": "string",
   "documentVersion": "string",
   "externalParameters": { 
      "string" : { ... }
   },
   "launchConfigurationTemplateID": "string",
   "mustSucceedForCutover": boolean,
   "operatingSystem": "string",
   "order": number,
   "parameters": { 
      "string" : [ 
         { 
            "parameterName": "string",
            "parameterType": "string"
         }
      ]
   },
   "timeoutSeconds": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

actionID

Template post migration custom action ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-zA-Z]$

Required: Yes

actionName

Template post migration custom action name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

active

Template post migration custom action active status.

Type: Boolean

Required: No

category

Template post migration custom action category.

Type: String

Valid Values: DISASTER_RECOVERY | OPERATING_SYSTEM | LICENSE_AND_SUBSCRIPTION | VALIDATION | OBSERVABILITY | REFACTORING | SECURITY | NETWORKING | CONFIGURATION | BACKUP | OTHER

Required: No

description

Template post migration custom action description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[0-9a-zA-Z ():/.,'-_#*; ]*$

Required: No

documentIdentifier

Template post migration custom action document identifier.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

documentVersion

Template post migration custom action document version.

Type: String

Pattern: ^(\$DEFAULT|\$LATEST|[0-9]+)$

Required: No

externalParameters

Template post migration custom action external parameters.

Type: String to SsmExternalParameter object map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Key Length Constraints: Minimum length of 1. Maximum length of 1011.

Key Pattern: ^([A-Za-z0-9])+$

Required: No

launchConfigurationTemplateID

Launch configuration template ID.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^lct-[0-9a-zA-Z]{17}$

Required: Yes

mustSucceedForCutover

Template post migration custom action must succeed for cutover.

Type: Boolean

Required: No

operatingSystem

Operating system eligible for this template post migration custom action.

Type: String

Pattern: ^(linux|windows)$

Required: No

order

Template post migration custom action order.

Type: Integer

Valid Range: Minimum value of 1001. Maximum value of 10000.

Required: Yes

parameters

Template post migration custom action parameters.

Type: String to array of SsmParameterStoreParameter objects map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Key Length Constraints: Minimum length of 1. Maximum length of 1011.

Key Pattern: ^([A-Za-z0-9])+$

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

timeoutSeconds

Template post migration custom action timeout in seconds.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "actionID": "string",
   "actionName": "string",
   "active": boolean,
   "category": "string",
   "description": "string",
   "documentIdentifier": "string",
   "documentVersion": "string",
   "externalParameters": { 
      "string" : { ... }
   },
   "mustSucceedForCutover": boolean,
   "operatingSystem": "string",
   "order": number,
   "parameters": { 
      "string" : [ 
         { 
            "parameterName": "string",
            "parameterType": "string"
         }
      ]
   },
   "timeoutSeconds": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionID

Template post migration custom action ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-zA-Z]$

actionName

Template post migration custom action name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

active

Template post migration custom action active status.

Type: Boolean

category

Template post migration custom action category.

Type: String

Valid Values: DISASTER_RECOVERY | OPERATING_SYSTEM | LICENSE_AND_SUBSCRIPTION | VALIDATION | OBSERVABILITY | REFACTORING | SECURITY | NETWORKING | CONFIGURATION | BACKUP | OTHER

description

Template post migration custom action description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[0-9a-zA-Z ():/.,'-_#*; ]*$

documentIdentifier

Template post migration custom action document identifier.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

documentVersion

Template post migration custom action document version.

Type: String

Pattern: ^(\$DEFAULT|\$LATEST|[0-9]+)$

externalParameters

Template post migration custom action external parameters.

Type: String to SsmExternalParameter object map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Key Length Constraints: Minimum length of 1. Maximum length of 1011.

Key Pattern: ^([A-Za-z0-9])+$

mustSucceedForCutover

Template post migration custom action must succeed for cutover.

Type: Boolean

operatingSystem

Operating system eligible for this template post migration custom action.

Type: String

Pattern: ^(linux|windows)$

order

Template post migration custom action order.

Type: Integer

Valid Range: Minimum value of 1001. Maximum value of 10000.

parameters

Template post migration custom action parameters.

Type: String to array of SsmParameterStoreParameter objects map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Key Length Constraints: Minimum length of 1. Maximum length of 1011.

Key Pattern: ^([A-Za-z0-9])+$

Array Members: Minimum number of 0 items. Maximum number of 10 items.

timeoutSeconds

Template post migration custom action timeout in seconds.

Type: Integer

Valid Range: Minimum value of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

HTTP Status Code: 409

ResourceNotFoundException

Resource not found exception.

HTTP Status Code: 404

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: