AWS Service Catalog

2017/09/14 - AWS Service Catalog - 2 new api methods

Changes  This release of Service Catalog adds API support to copy products.

CopyProduct (new) Link ¶

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

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

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

See also: AWS API Documentation

Request Syntax

client.copy_product(
    AcceptLanguage='string',
    SourceProductArn='string',
    TargetProductId='string',
    TargetProductName='string',
    SourceProvisioningArtifactIdentifiers=[
        {
            'string': 'string'
        },
    ],
    CopyOptions=[
        'CopyTags',
    ],
    IdempotencyToken='string'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type SourceProductArn

string

param SourceProductArn

[REQUIRED]

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

type TargetProductId

string

param TargetProductId

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

type TargetProductName

string

param TargetProductName

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

type SourceProvisioningArtifactIdentifiers

list

param SourceProvisioningArtifactIdentifiers

The IDs of the product versions to copy. By default, all provisioning artifacts are copied.

  • (dict) --

    • (string) --

      • (string) --

type CopyOptions

list

param CopyOptions

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

  • (string) --

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'CopyProductToken': 'string'
}

Response Structure

  • (dict) --

    • CopyProductToken (string) --

      A unique token to pass to DescribeCopyProductStatus to track the progress of the operation.

DescribeCopyProductStatus (new) Link ¶

Describes the status of the specified copy product operation.

See also: AWS API Documentation

Request Syntax

client.describe_copy_product_status(
    AcceptLanguage='string',
    CopyProductToken='string'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type CopyProductToken

string

param CopyProductToken

[REQUIRED]

The token returned from the call to CopyProduct that initiated the operation.

rtype

dict

returns

Response Syntax

{
    'CopyProductStatus': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
    'TargetProductId': 'string',
    'StatusDetail': 'string'
}

Response Structure

  • (dict) --

    • CopyProductStatus (string) --

      The status of the copy product operation.

    • TargetProductId (string) --

      The ID of the copied product.

    • StatusDetail (string) --

      The status message.