AWS Service Catalog
Developer Guide

CopyProduct

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Request Syntax

{ "AcceptLanguage": "string", "CopyOptions": [ "string" ], "IdempotencyToken": "string", "SourceProductArn": "string", "SourceProvisioningArtifactIdentifiers": [ { "string" : "string" } ], "TargetProductId": "string", "TargetProductName": "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

CopyOptions

The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

Type: Array of strings

Valid Values: CopyTags

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

SourceProductArn

The Amazon Resource Name (ARN) of the source product.

Type: String

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

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

SourceProvisioningArtifactIdentifiers

The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

Type: Array of string to string maps

Valid Keys: Id

Required: No

TargetProductId

The identifier of the target product. By default, a new product is created.

Type: String

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

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

Required: No

TargetProductName

A name for the target product. The default is the name of the source product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Response Syntax

{ "CopyProductToken": "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.

CopyProductToken

The token to use to track the progress of the operation.

Type: String

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

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

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

See Also

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