GetDeployment - AWS Mainframe Modernization (M2)

GetDeployment

Gets details of a specific deployment with a given deployment identifier.

Request Syntax

GET /applications/applicationId/deployments/deploymentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the application.

Pattern: ^\S{1,80}$

Required: Yes

deploymentId

The unique identifier for the deployment.

Pattern: ^\S{1,80}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "applicationVersion": number, "creationTime": number, "deploymentId": "string", "environmentId": "string", "status": "string", "statusReason": "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.

applicationId

The unique identifier of the application.

Type: String

Pattern: ^\S{1,80}$

applicationVersion

The application version.

Type: Integer

Valid Range: Minimum value of 1.

creationTime

The timestamp when the deployment was created.

Type: Timestamp

deploymentId

The unique identifier of the deployment.

Type: String

Pattern: ^\S{1,80}$

environmentId

The unique identifier of the runtime environment.

Type: String

Pattern: ^\S{1,80}$

status

The status of the deployment.

Type: String

Valid Values: Deploying | Succeeded | Failed

statusReason

The reason for the reported status.

Type: String

Errors

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

AccessDeniedException

The account or role doesn't have the right permissions to make the request.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The number of requests made exceeds the limit.

HTTP Status Code: 429

ValidationException

One or more parameters provided in the request is not valid.

HTTP Status Code: 400

See Also

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