CreateApp
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
Request Syntax
{
"clientToken": "string",
"description": "string",
"name": "string",
"roleName": "string",
"serverGroups": [
{
"name": "string",
"serverGroupId": "string",
"serverList": [
{
"replicationJobId": "string",
"replicationJobTerminated": boolean,
"serverId": "string",
"serverType": "string",
"vmServer": {
"vmManagerName": "string",
"vmManagerType": "string",
"vmName": "string",
"vmPath": "string",
"vmServerAddress": {
"vmId": "string",
"vmManagerId": "string"
}
}
}
]
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.
Type: String
Required: No
- description
-
The description of the new application
Type: String
Required: No
- name
-
The name of the new application.
Type: String
Required: No
- roleName
-
The name of the service role in the customer's account to be used by Amazon SMS.
Type: String
Required: No
- serverGroups
-
The server groups to include in the application.
Type: Array of ServerGroup objects
Required: No
- tags
-
The tags to be associated with the application.
Type: Array of Tag objects
Required: No
Response Syntax
{
"appSummary": {
"appId": "string",
"creationTime": number,
"description": "string",
"importedAppId": "string",
"lastModified": number,
"latestReplicationTime": number,
"launchConfigurationStatus": "string",
"launchDetails": {
"latestLaunchTime": number,
"stackId": "string",
"stackName": "string"
},
"launchStatus": "string",
"launchStatusMessage": "string",
"name": "string",
"replicationConfigurationStatus": "string",
"replicationStatus": "string",
"replicationStatusMessage": "string",
"roleName": "string",
"status": "string",
"statusMessage": "string",
"totalServerGroups": number,
"totalServers": number
},
"serverGroups": [
{
"name": "string",
"serverGroupId": "string",
"serverList": [
{
"replicationJobId": "string",
"replicationJobTerminated": boolean,
"serverId": "string",
"serverType": "string",
"vmServer": {
"vmManagerName": "string",
"vmManagerType": "string",
"vmName": "string",
"vmPath": "string",
"vmServerAddress": {
"vmId": "string",
"vmManagerId": "string"
}
}
}
]
}
],
"tags": [
{
"key": "string",
"value": "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.
- appSummary
-
A summary description of the application.
Type: AppSummary object
- serverGroups
-
The server groups included in the application.
Type: Array of ServerGroup objects
- tags
-
The tags associated with the application.
Type: Array of Tag objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalError
-
An internal error occurred.
HTTP Status Code: 500
- InvalidParameterException
-
A specified parameter is not valid.
HTTP Status Code: 400
- MissingRequiredParameterException
-
A required parameter is missing.
HTTP Status Code: 400
- OperationNotPermittedException
-
This operation is not allowed.
HTTP Status Code: 400
- UnauthorizedOperationException
-
You lack permissions needed to perform this operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: