NotifyResourceDeploymentStatusChange - AWS Proton

NotifyResourceDeploymentStatusChange

Notify AWS Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.

Important

Provisioning by pull request is currently in feature preview and is only usable with Terraform based AWS Proton Templates. To learn more about AWS Feature Preview terms, see section 2 on Beta and Previews.

Request Syntax

{ "deploymentId": "string", "outputs": [ { "key": "string", "valueString": "string" } ], "resourceArn": "string", "status": "string", "statusMessage": "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.

deploymentId

The deployment ID for your provisioned resource.

Type: String

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

Required: No

outputs

The provisioned resource state change detail data that's returned by AWS Proton.

Type: Array of Output objects

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

Required: No

resourceArn

The provisioned resource Amazon Resource Name (ARN).

Type: String

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

Required: Yes

status

The status of your provisioned resource.

Type: String

Valid Values: IN_PROGRESS | FAILED | SUCCEEDED

Required: Yes

statusMessage

The deployment status message for your provisioned resource.

Type: String

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

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

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: