ServiceCatalog / Client / execute_provisioned_product_service_action

execute_provisioned_product_service_action

ServiceCatalog.Client.execute_provisioned_product_service_action(**kwargs)

Executes a self-service action against a provisioned product.

See also: AWS API Documentation

Request Syntax

response = client.execute_provisioned_product_service_action(
    ProvisionedProductId='string',
    ServiceActionId='string',
    ExecuteToken='string',
    AcceptLanguage='string',
    Parameters={
        'string': [
            'string',
        ]
    }
)

Parameters:

• ProvisionedProductId (string) –

  [REQUIRED]

  The identifier of the provisioned product.

• ServiceActionId (string) –

  [REQUIRED]

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

• ExecuteToken (string) –

  [REQUIRED]

  An idempotency token that uniquely identifies the execute request.

  This field is autopopulated if not provided.

• AcceptLanguage (string) –

  The language code.

  • jp - Japanese

  • zh - Chinese

• Parameters (dict) –

  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 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.

  • (string) –

    • (list) –

      • (string) –

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) –

    An object containing detailed 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