AWS Service Catalog

2019/07/10 - AWS Service Catalog - 1 new 1 updated api methods

Changes  This release adds support for Parameters in ExecuteProvisionedProductServiceAction and adds functionality to get the default parameter values for a Self-Service Action execution against a Provisioned Product via DescribeServiceActionExecutionParameters

DescribeServiceActionExecutionParameters (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_service_action_execution_parameters(
    ProvisionedProductId='string',
    ServiceActionId='string',
    AcceptLanguage='string'
)
type ProvisionedProductId

string

param ProvisionedProductId

[REQUIRED]

type ServiceActionId

string

param ServiceActionId

[REQUIRED]

type AcceptLanguage

string

param AcceptLanguage

rtype

dict

returns

Response Syntax

{
    'ServiceActionParameters': [
        {
            'Name': 'string',
            'Type': 'string',
            'DefaultValues': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • ServiceActionParameters (list) --

      • (dict) --

        • Name (string) --

        • Type (string) --

        • DefaultValues (list) --

          • (string) --

ExecuteProvisionedProductServiceAction (updated) Link ¶
Changes (request) 
{'Parameters': {'string': ['string']}}

Executes a self-service action against a provisioned product.

See also: AWS API Documentation

Request Syntax

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

string

param ProvisionedProductId

[REQUIRED]

The identifier of the provisioned product.

type ServiceActionId

string

param ServiceActionId

[REQUIRED]

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

type ExecuteToken

string

param ExecuteToken

[REQUIRED]

An idempotency token that uniquely identifies the execute request.

This field is autopopulated if not provided.

type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type Parameters

dict

param Parameters

  • (string) --

    • (list) --

      • (string) --

rtype

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'
            },
        ]
    }
}

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

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