ServiceCatalog / Client / execute_provisioned_product_plan

execute_provisioned_product_plan

ServiceCatalog.Client.execute_provisioned_product_plan(**kwargs)

Provisions or modifies a product based on the resource changes for the specified plan.

See also: AWS API Documentation

Request Syntax

response = client.execute_provisioned_product_plan(
    AcceptLanguage='string',
    PlanId='string',
    IdempotencyToken='string'
)

Parameters:

• AcceptLanguage (string) –

  The language code.

  • jp - Japanese

  • zh - Chinese

• PlanId (string) –

  [REQUIRED]

  The plan identifier.

• IdempotencyToken (string) –

  [REQUIRED]

  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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'RecordDetail': {
        'RecordId': 'string',
        'ProvisionedProductName': 'string',
        'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
        'CreatedTime': datetime(2015, 1, 1),
        'UpdatedTime': datetime(2015, 1, 1),
        'ProvisionedProductType': 'string',
        'RecordType': 'string',
        'ProvisionedProductId': 'string',
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string',
        'PathId': 'string',
        'RecordErrors': [
            {
                'Code': 'string',
                'Description': 'string'
            },
        ],
        'RecordTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LaunchRoleArn': 'string'
    }
}

Response Structure

• (dict) –

  • RecordDetail (dict) –

    Information about the result of provisioning the product.

    • RecordId (string) –

      The identifier of the record.

    • ProvisionedProductName (string) –

      The user-friendly name of the provisioned product.

    • Status (string) –

      The status of the provisioned product.

      • CREATED - The request was created but the operation has not started.

      • IN_PROGRESS - The requested operation is in progress.

      • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

      • SUCCEEDED - The requested operation has successfully completed.

      • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

    • CreatedTime (datetime) –

      The UTC time stamp of the creation time.

    • UpdatedTime (datetime) –

      The time when the record was last updated.

    • ProvisionedProductType (string) –

      The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

    • RecordType (string) –

      The record type.

      • PROVISION_PRODUCT

      • UPDATE_PROVISIONED_PRODUCT

      • TERMINATE_PROVISIONED_PRODUCT

    • ProvisionedProductId (string) –

      The identifier of the provisioned product.

    • ProductId (string) –

      The product identifier.

    • ProvisioningArtifactId (string) –

      The identifier of the provisioning artifact.

    • PathId (string) –

      The path identifier.

    • RecordErrors (list) –

      The errors that occurred.

      • (dict) –

        The error code and description resulting from an operation.

        • Code (string) –

          The numeric value of the error.

        • Description (string) –

          The description of the error.

    • RecordTags (list) –

      One or more tags.

      • (dict) –

        Information about a tag, which is a key-value pair.

        • Key (string) –

          The key for this tag.

        • Value (string) –

          The value for this tag.

    • LaunchRoleArn (string) –

      The ARN of the launch role associated with the provisioned product.

Exceptions

• ServiceCatalog.Client.exceptions.InvalidParametersException

• ServiceCatalog.Client.exceptions.ResourceNotFoundException

• ServiceCatalog.Client.exceptions.InvalidStateException