Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTemplateActions

List template post migration custom actions.

Request Syntax


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

{
   "filters": { 
      "actionIDs": [ "string" ]
   },
   "launchConfigurationTemplateID": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

Filters to apply when listing template post migration custom actions.

Type: TemplateActionsRequestFilters object

Required: No

launchConfigurationTemplateID

Launch configuration template ID.

Type: String

Length Constraints: Fixed length of 21.

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

Required: Yes

maxResults

Maximum amount of items to return when listing template post migration custom actions.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

Next token to use when listing template post migration custom actions.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "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
      }
   ],
   "nextToken": "string"
}

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.

items

List of template post migration custom actions.

Type: Array of TemplateActionDocument objects

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

nextToken

Next token returned when listing template post migration custom actions.

Type: String

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

Errors

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

ResourceNotFoundException

Resource not found exception.

HTTP Status Code: 404

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400