Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateServiceInstance

Create a service instance.

Request Syntax


{
   "clientToken": "string",
   "name": "string",
   "serviceName": "string",
   "spec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateMajorVersion": "string",
   "templateMinorVersion": "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

The client token of the service instance to create.

Type: String

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

Pattern: ^[!-~]*$

Required: No

name

The name of the service instance to create.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

serviceName

The name of the service the service instance is added to.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

spec

The spec for the service instance you want to create.

Type: String

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

Required: Yes

tags

An optional list of metadata items that you can associate with the AWS Proton service instance. A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide.

Type: Array of Tag objects

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

Required: No

templateMajorVersion

To create a new major and minor version of the service template, exclude major Version.

Type: String

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

Pattern: ^(0|([1-9]{1}\d*))$

Required: No

templateMinorVersion

To create a new minor version of the service template, include a major Version.

Type: String

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

Pattern: ^(0|([1-9]{1}\d*))$

Required: No

Response Syntax


{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "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.

serviceInstance

The detailed data of the service instance being created.

Type: ServiceInstance object

Errors

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

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400