GetServiceInstance - AWS Proton

GetServiceInstance

Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.

Request Syntax

{ "name": "string", "serviceName": "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.

name

The name of a service instance that you want to get the detail data for.

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 that the service instance belongs to.

Type: String

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

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

Required: Yes

Response Syntax

{ "serviceInstance": { "arn": "string", "createdAt": number, "deploymentStatus": "string", "deploymentStatusMessage": "string", "environmentName": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "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 service instance detail data that's returned by AWS Proton.

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: