AWS Service Catalog
Developer Guide

ExecuteProvisionedProductServiceAction

Executes a self-service action against a provisioned product.

Request Syntax

{ "AcceptLanguage": "string", "ExecuteToken": "string", "Parameters": { "string" : [ "string" ] }, "ProvisionedProductId": "string", "ServiceActionId": "string" }

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

ExecuteToken

An idempotency token that uniquely identifies the execute request.

Type: String

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

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

Required: Yes

Parameters

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET.

Type: String to array of strings map

Key Length Constraints: Minimum length of 1. Maximum length of 50.

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

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

Required: No

ProvisionedProductId

The identifier of the provisioned product.

Type: String

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

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

Required: Yes

ServiceActionId

The self-service action identifier. For example, act-fs7abcd89wxyz.

Type: String

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

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

Required: Yes

Response Syntax

{ "RecordDetail": { "CreatedTime": number, "PathId": "string", "ProductId": "string", "ProvisionedProductId": "string", "ProvisionedProductName": "string", "ProvisionedProductType": "string", "ProvisioningArtifactId": "string", "RecordErrors": [ { "Code": "string", "Description": "string" } ], "RecordId": "string", "RecordTags": [ { "Key": "string", "Value": "string" } ], "RecordType": "string", "Status": "string", "UpdatedTime": number } }

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.

RecordDetail

An object containing detailed information about the result of provisioning the product.

Type: RecordDetail object

Errors

InvalidParametersException

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

HTTP Status Code: 400

InvalidStateException

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

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