Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDeployment

Get detailed data for a deployment.

Request Syntax


{
   "componentName": "string",
   "environmentName": "string",
   "id": "string",
   "serviceInstanceName": "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.

componentName

The name of a component that you want to get the detailed data for.

Type: String

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

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

Required: No

environmentName

The name of a environment that you want to get the detailed data for.

Type: String

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

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

Required: No

id

The ID of the deployment that you want to get the detailed data for.

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

serviceInstanceName

The name of the service instance associated with the given deployment ID. serviceName must be specified to identify the service instance.

Type: String

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

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

Required: No

serviceName

The name of the service associated with the given deployment ID.

Type: String

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

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

Required: No

Response Syntax


{
   "deployment": { 
      "arn": "string",
      "completedAt": number,
      "componentName": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "id": "string",
      "initialState": { ... },
      "lastAttemptedDeploymentId": "string",
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "targetArn": "string",
      "targetResourceCreatedAt": number,
      "targetResourceType": "string",
      "targetState": { ... }
   }
}

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.

deployment

The detailed data of the requested deployment.

Type: Deployment 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