Request Syntax Request Parameters Response Elements Errors See Also

NotifyProvisionProductEngineWorkflowResult

Notifies the result of the provisioning engine execution.

Request Syntax


{
   "FailureReason": "string",
   "IdempotencyToken": "string",
   "Outputs": [ 
      { 
         "Description": "string",
         "OutputKey": "string",
         "OutputValue": "string"
      }
   ],
   "RecordId": "string",
   "ResourceIdentifier": { 
      "UniqueTag": { 
         "Key": "string",
         "Value": "string"
      }
   },
   "Status": "string",
   "WorkflowToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

FailureReason

The reason why the provisioning engine execution failed.

Type: String

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

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

Required: No

IdempotencyToken

The idempotency token that identifies the provisioning engine execution.

Type: String

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

Outputs

The output of the provisioning engine execution.

Type: Array of RecordOutput objects

Required: No

RecordId

The identifier of the record.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

ResourceIdentifier

The ID for the provisioned product resources that are part of a resource group.

Type: EngineWorkflowResourceIdentifier object

Required: No

Status

The status of the provisioning engine execution.

Type: String

Valid Values: SUCCEEDED | FAILED

Required: Yes

WorkflowToken

The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

Type: String

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

Pattern: [0-9A-Za-z+\/=]+

Required: Yes

Response Elements

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

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400