AWS Service Catalog

{'Name': 'string'}

Gets information about the specified provisioned product.

See also: AWS API Documentation

Request Syntax

client.describe_provisioned_product(
    AcceptLanguage='string',
    Id='string',
    Name='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

type Id

string

param Id

The provisioned product identifier. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

type Name

string

param Name

The name of the provisioned product. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

rtype

dict

returns

Response Syntax

{
    'ProvisionedProductDetail': {
        'Name': 'string',
        'Arn': 'string',
        'Type': 'string',
        'Id': 'string',
        'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
        'StatusMessage': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'IdempotencyToken': 'string',
        'LastRecordId': 'string',
        'LastProvisioningRecordId': 'string',
        'LastSuccessfulProvisioningRecordId': 'string',
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string'
    },
    'CloudWatchDashboards': [
        {
            'Name': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • ProvisionedProductDetail (dict) --

    Information about the provisioned product.

    • Name (string) --

      The user-friendly name of the provisioned product.

    • Arn (string) --

      The ARN of the provisioned product.

    • Type (string) --

      The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .

    • Id (string) --

      The identifier of the provisioned product.

    • Status (string) --

      The current status of the provisioned product.

      • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

      • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

      • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

      • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    • StatusMessage (string) --

      The current status message of the provisioned product.

    • CreatedTime (datetime) --

      The UTC time stamp of the creation time.

    • IdempotencyToken (string) --

      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.

    • LastRecordId (string) --

      The record identifier of the last request performed on this provisioned product.

    • LastProvisioningRecordId (string) --

      The record identifier of the last request performed on this provisioned product of the following types:

      • ProvisionedProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

    • LastSuccessfulProvisioningRecordId (string) --

      The record identifier of the last successful request performed on this provisioned product of the following types:

      • ProvisionedProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

    • ProductId (string) --

      The product identifier. For example, prod-abcdzk7xy33qa .

    • ProvisioningArtifactId (string) --

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .

  • CloudWatchDashboards (list) --

    Any CloudWatch dashboards that were created when provisioning the product.

    • (dict) --

      Information about a CloudWatch dashboard.

      • Name (string) --

        The name of the CloudWatch dashboard.