ServiceCatalog / Client / describe_provisioned_product_plan



Gets information about the resource changes for the specified plan.

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioned_product_plan(
  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PlanId (string) –


    The plan identifier.

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

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

Return type:



Response Syntax

    'ProvisionedProductPlanDetails': {
        'CreatedTime': datetime(2015, 1, 1),
        'PathId': 'string',
        'ProductId': 'string',
        'PlanName': 'string',
        'PlanId': 'string',
        'ProvisionProductId': 'string',
        'ProvisionProductName': 'string',
        'PlanType': 'CLOUDFORMATION',
        'ProvisioningArtifactId': 'string',
        'UpdatedTime': datetime(2015, 1, 1),
        'NotificationArns': [
        'ProvisioningParameters': [
                'Key': 'string',
                'Value': 'string',
                'UsePreviousValue': True|False
        'Tags': [
                'Key': 'string',
                'Value': 'string'
        'StatusMessage': 'string'
    'ResourceChanges': [
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'ResourceType': 'string',
            'Replacement': 'TRUE'|'FALSE'|'CONDITIONAL',
            'Scope': [
            'Details': [
                    'Target': {
                        'Name': 'string',
                        'RequiresRecreation': 'NEVER'|'CONDITIONALLY'|'ALWAYS'
                    'Evaluation': 'STATIC'|'DYNAMIC',
                    'CausingEntity': 'string'
    'NextPageToken': 'string'

Response Structure

  • (dict) –

    • ProvisionedProductPlanDetails (dict) –

      Information about the plan.

      • CreatedTime (datetime) –

        The UTC time stamp of the creation time.

      • PathId (string) –

        The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

      • ProductId (string) –

        The product identifier.

      • PlanName (string) –

        The name of the plan.

      • PlanId (string) –

        The plan identifier.

      • ProvisionProductId (string) –

        The product identifier.

      • ProvisionProductName (string) –

        The user-friendly name of the provisioned product.

      • PlanType (string) –

        The plan type.

      • ProvisioningArtifactId (string) –

        The identifier of the provisioning artifact.

      • Status (string) –

        The status.

      • UpdatedTime (datetime) –

        The UTC time stamp when the plan was last updated.

      • NotificationArns (list) –

        Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

        • (string) –

      • ProvisioningParameters (list) –

        Parameters specified by the administrator that are required for provisioning the product.

        • (dict) –

          The parameter key-value pair used to update a provisioned product.

          • Key (string) –

            The parameter key.

          • Value (string) –

            The parameter value.

          • UsePreviousValue (boolean) –

            If set to true, Value is ignored and the previous parameter value is kept.

      • Tags (list) –

        One or more tags.

        • (dict) –

          Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

          • Key (string) –

            The tag key.

          • Value (string) –

            The value for this key.

      • StatusMessage (string) –

        The status message.

    • ResourceChanges (list) –

      Information about the resource changes that will occur when the plan is executed.

      • (dict) –

        Information about a resource change that will occur when a plan is executed.

        • Action (string) –

          The change action.

        • LogicalResourceId (string) –

          The ID of the resource, as defined in the CloudFormation template.

        • PhysicalResourceId (string) –

          The ID of the resource, if it was already created.

        • ResourceType (string) –

          The type of resource.

        • Replacement (string) –

          If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

        • Scope (list) –

          The change scope.

          • (string) –

        • Details (list) –

          Information about the resource changes.

          • (dict) –

            Information about a change to a resource attribute.

            • Target (dict) –

              Information about the resource attribute to be modified.

              • Attribute (string) –

                The attribute to be changed.

              • Name (string) –

                If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

              • RequiresRecreation (string) –

                If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

            • Evaluation (string) –

              For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

            • CausingEntity (string) –

              The ID of the entity that caused the change.

    • NextPageToken (string) –

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


  • ServiceCatalog.Client.exceptions.ResourceNotFoundException

  • ServiceCatalog.Client.exceptions.InvalidParametersException