CreateApplicationInstance
Creates an application instance and deploys it to a device.
Request Syntax
POST /application-instances HTTP/1.1
Content-type: application/json
{
"ApplicationInstanceIdToReplace": "string",
"DefaultRuntimeContextDevice": "string",
"Description": "string",
"ManifestOverridesPayload": { ... },
"ManifestPayload": { ... },
"Name": "string",
"RuntimeRoleArn": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ApplicationInstanceIdToReplace
-
The ID of an application instance to replace with the new instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$Required: No
- DefaultRuntimeContextDevice
-
A device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$Required: Yes
- Description
-
A description for the application instance.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^.*$Required: No
- ManifestOverridesPayload
-
Setting overrides for the application manifest.
Type: ManifestOverridesPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- ManifestPayload
-
The application's manifest document.
Type: ManifestPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Name
-
A name for the application instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$Required: No
- RuntimeRoleArn
-
The ARN of a runtime role for the application instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$Required: No
- Tags
-
Tags for the application instance.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^.+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^.*$Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApplicationInstanceId": "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.
- ApplicationInstanceId
-
The application instance's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The request would cause a limit to be exceeded.
HTTP Status Code: 402
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
