PutLaunchAction
Puts a resource launch action.
Request Syntax
POST /PutLaunchAction HTTP/1.1
Content-type: application/json
{
"actionCode": "string",
"actionId": "string",
"actionVersion": "string",
"active": boolean,
"category": "string",
"description": "string",
"name": "string",
"optional": boolean,
"order": number,
"parameters": {
"string" : {
"type": "string",
"value": "string"
}
},
"resourceId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- actionCode
-
Launch action code.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
^([A-Za-z0-9-/:])+$Required: Yes
- actionId
-
Launch action Id.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Required: Yes
- actionVersion
-
Launch action version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
^(\$DEFAULT|\$LATEST|[0-9]+)$Required: Yes
- active
-
Whether the launch action is active.
Type: Boolean
Required: Yes
- category
-
Launch action category.
Type: String
Valid Values:
MONITORING | VALIDATION | CONFIGURATION | SECURITY | OTHERRequired: Yes
- description
-
Launch action description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
^[0-9a-zA-Z ():/.,'-_#*; ]*$Required: Yes
- name
-
Launch action name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[A-Za-z0-9][A-Za-z0-9 /_-]*$Required: Yes
- optional
-
Whether the launch will not be marked as failed if this action fails.
Type: Boolean
Required: Yes
- order
-
Launch action order.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10000.
Required: Yes
- parameters
-
Launch action parameters.
Type: String to LaunchActionParameter 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
- resourceId
-
Launch configuration template Id or Source Server Id
Type: String
Pattern:
^(s-[0-9a-zA-Z]{17}$|lct-[0-9a-zA-Z]{17})$Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionCode": "string",
"actionId": "string",
"actionVersion": "string",
"active": boolean,
"category": "string",
"description": "string",
"name": "string",
"optional": boolean,
"order": number,
"parameters": {
"string" : {
"type": "string",
"value": "string"
}
},
"resourceId": "string",
"type": "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.
- actionCode
-
Launch action code.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
^([A-Za-z0-9-/:])+$ - actionId
-
Launch action Id.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - actionVersion
-
Launch action version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
^(\$DEFAULT|\$LATEST|[0-9]+)$ - active
-
Whether the launch action is active.
Type: Boolean
- category
-
Launch action category.
Type: String
Valid Values:
MONITORING | VALIDATION | CONFIGURATION | SECURITY | OTHER - description
-
Launch action description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
^[0-9a-zA-Z ():/.,'-_#*; ]*$ - name
-
Launch action name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[A-Za-z0-9][A-Za-z0-9 /_-]*$ - optional
-
Whether the launch will not be marked as failed if this action fails.
Type: Boolean
- order
-
Launch action order.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10000.
- parameters
-
Launch action parameters.
Type: String to LaunchActionParameter 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])+$ - resourceId
-
Launch configuration template Id or Source Server Id
Type: String
Pattern:
^(s-[0-9a-zA-Z]{17}$|lct-[0-9a-zA-Z]{17})$ - type
-
Launch action type.
Type: String
Valid Values:
SSM_AUTOMATION | SSM_COMMAND
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
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource for this operation was not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UninitializedAccountException
-
The account performing the request has not been initialized.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
