ImportAsProvisionedProduct - AWS Service Catalog

ImportAsProvisionedProduct

Requests the import of a resource as a AWS Service Catalog provisioned product that is associated to a AWS Service Catalog product and provisioning artifact. Once imported, all supported AWS Service Catalog governance actions are supported on the provisioned product.

Resource import only supports AWS CloudFormation stack ARNs. AWS CloudFormation StackSets and non-root nested stacks are not supported.

The AWS CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the AWS CloudFormation stack template matches the associated AWS Service Catalog product provisioning artifact.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

Request Syntax

{ "AcceptLanguage": "string", "IdempotencyToken": "string", "PhysicalId": "string", "ProductId": "string", "ProvisionedProductName": "string", "ProvisioningArtifactId": "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

IdempotencyToken

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

Type: String

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

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

Required: Yes

PhysicalId

The unique identifier of the resource to be imported. It only currently supports AWS CloudFormation stack IDs.

Type: String

Required: Yes

ProductId

The product identifier.

Type: String

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

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

Required: Yes

ProvisionedProductName

The user-friendly name of the provisioned product. The value must be unique for the AWS account. The name cannot be updated after the product is provisioned.

Type: String

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

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

Required: Yes

ProvisioningArtifactId

The identifier of the provisioning artifact.

Type: String

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

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

Required: Yes

Response Syntax

{ "RecordDetail": { "CreatedTime": number, "LaunchRoleArn": "string", "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

Information about a request operation.

Type: RecordDetail object

Errors

DuplicateResourceException

The specified resource is a duplicate.

HTTP Status Code: 400

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: