ServiceCatalog / Client / describe_record

describe_record

ServiceCatalog.Client.describe_record(**kwargs)

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Note

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product’s history from when he was the owner.

See also: AWS API Documentation

Request Syntax

response = client.describe_record(
    AcceptLanguage='string',
    Id='string',
    PageToken='string',
    PageSize=123
)

Parameters:

• AcceptLanguage (string) –

  The language code.

  • jp - Japanese

  • zh - Chinese

• Id (string) –

  [REQUIRED]

  The record identifier of the provisioned product. This identifier is returned by the request operation.

• PageToken (string) – The page token for the next set of results. To retrieve the first set of results, use null.

• PageSize (integer) – The maximum number of items to return with this call.

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'
    },
    'RecordOutputs': [
        {
            'OutputKey': 'string',
            'OutputValue': 'string',
            'Description': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

• (dict) –

  • RecordDetail (dict) –

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

  • RecordOutputs (list) –

    Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

    • (dict) –

      The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

      • OutputKey (string) –

        The output key.

      • OutputValue (string) –

        The output value.

      • Description (string) –

        The description of the output.

  • NextPageToken (string) –

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Exceptions

• ServiceCatalog.Client.exceptions.ResourceNotFoundException