Amazon Service Catalog Service Catalog Provisioned Product Plan API

openapi: 3.1.0
info:
  title: AWS Service Catalog Provisioned Product Plan API
  version: '2015-12-10'
  description: Generated from AWS's published Smithy model for AWS Service Catalog. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://servicecatalog.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateProvisionedProductPlan:
    post:
      operationId: CreateProvisionedProductPlan
      summary: Create Provisioned Product Plan
      description: Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or
        modified (when updating a provisioned product) when the plan is executed. You can create one plan for each provisioned
        product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED. To
        view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned
        product, use ExecuteProvisionedProductPlan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateProvisionedProductPlanOutput'
        '400':
          description: InvalidParametersException; InvalidStateException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.CreateProvisionedProductPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateProvisionedProductPlanInput'
      tags:
      - Provisioned Product Plan
  /#DeleteProvisionedProductPlan:
    post:
      operationId: DeleteProvisionedProductPlan
      summary: Delete Provisioned Product Plan
      description: Deletes the specified plan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteProvisionedProductPlanOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DeleteProvisionedProductPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProvisionedProductPlanInput'
      tags:
      - Provisioned Product Plan
  /#DescribeProvisionedProductPlan:
    post:
      operationId: DescribeProvisionedProductPlan
      summary: Describe Provisioned Product Plan
      description: Gets information about the resource changes for the specified plan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProvisionedProductPlanOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DescribeProvisionedProductPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProvisionedProductPlanInput'
      tags:
      - Provisioned Product Plan
  /#ExecuteProvisionedProductPlan:
    post:
      operationId: ExecuteProvisionedProductPlan
      summary: Execute Provisioned Product Plan
      description: Provisions or modifies a product based on the resource changes for the specified plan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ExecuteProvisionedProductPlanOutput'
        '400':
          description: InvalidParametersException; InvalidStateException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.ExecuteProvisionedProductPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ExecuteProvisionedProductPlanInput'
      tags:
      - Provisioned Product Plan
  /#ListProvisionedProductPlans:
    post:
      operationId: ListProvisionedProductPlans
      summary: List Provisioned Product Plans
      description: Lists the plans for the specified provisioned product or all plans to which the user has access.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProvisionedProductPlansOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.ListProvisionedProductPlans
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProvisionedProductPlansInput'
      tags:
      - Provisioned Product Plan
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: servicecatalog
  schemas:
    AccessLevelFilter:
      type: object
      properties:
        Key:
          type: string
          enum:
          - Account
          - Role
          - User
          description: The access level. Account - Filter results based on the account. Role - Filter results based on the
            federated role of the specified user. User - Filter results based on the specified user.
        Value:
          type: string
          description: The user to which the access level applies. The only supported value is self.
    CreateProvisionedProductPlanInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PlanName:
          type: string
          description: The name of the plan.
        PlanType:
          type: string
          enum:
          - CLOUDFORMATION
          description: The plan type.
        NotificationArns:
          type: array
          items:
            type: string
          description: Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
        PathId:
          type: string
          description: 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:
          type: string
          description: The product identifier.
        ProvisionedProductName:
          type: string
          description: A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services
            account and cannot be updated after the product is provisioned.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
        ProvisioningParameters:
          type: array
          items:
            $ref: '#/components/schemas/UpdateProvisioningParameter'
          description: Parameters specified by the administrator that are required for provisioning the product.
        IdempotencyToken:
          type: string
          description: 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.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags. If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE
            constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
      required:
      - PlanName
      - PlanType
      - ProductId
      - ProvisionedProductName
      - ProvisioningArtifactId
      - IdempotencyToken
    CreateProvisionedProductPlanOutput:
      type: object
      properties:
        PlanName:
          type: string
          description: The name of the plan.
        PlanId:
          type: string
          description: The plan identifier.
        ProvisionProductId:
          type: string
          description: The product identifier.
        ProvisionedProductName:
          type: string
          description: The user-friendly name of the provisioned product.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
    DeleteProvisionedProductPlanInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PlanId:
          type: string
          description: The plan identifier.
        IgnoreErrors:
          type: boolean
          description: If set to true, Service Catalog stops managing the specified provisioned product even if it cannot
            delete the underlying resources.
      required:
      - PlanId
    DeleteProvisionedProductPlanOutput:
      type: object
      properties: {}
    DescribeProvisionedProductPlanInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PlanId:
          type: string
          description: The plan identifier.
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
      required:
      - PlanId
    DescribeProvisionedProductPlanOutput:
      type: object
      properties:
        ProvisionedProductPlanDetails:
          $ref: '#/components/schemas/ProvisionedProductPlanDetails'
        ResourceChanges:
          type: array
          items:
            $ref: '#/components/schemas/ResourceChange'
          description: Information about the resource changes that will occur when the plan is executed.
        NextPageToken:
          type: string
          description: The page token to use to retrieve the next set of results. If there are no additional results, this
            value is null.
    ExecuteProvisionedProductPlanInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PlanId:
          type: string
          description: The plan identifier.
        IdempotencyToken:
          type: string
          description: 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.
      required:
      - PlanId
      - IdempotencyToken
    ExecuteProvisionedProductPlanOutput:
      type: object
      properties:
        RecordDetail:
          $ref: '#/components/schemas/RecordDetail'
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListProvisionedProductPlansInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProvisionProductId:
          type: string
          description: The product identifier.
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
        AccessLevelFilter:
          $ref: '#/components/schemas/AccessLevelFilter'
    ListProvisionedProductPlansOutput:
      type: object
      properties:
        ProvisionedProductPlans:
          type: array
          items:
            $ref: '#/components/schemas/ProvisionedProductPlanSummary'
          description: Information about the plans.
        NextPageToken:
          type: string
          description: The page token to use to retrieve the next set of results. If there are no additional results, this
            value is null.
    ProvisionedProductPlanDetails:
      type: object
      properties:
        CreatedTime:
          type: string
          format: date-time
          description: The UTC time stamp of the creation time.
        PathId:
          type: string
          description: 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:
          type: string
          description: The product identifier.
        PlanName:
          type: string
          description: The name of the plan.
        PlanId:
          type: string
          description: The plan identifier.
        ProvisionProductId:
          type: string
          description: The product identifier.
        ProvisionProductName:
          type: string
          description: The user-friendly name of the provisioned product.
        PlanType:
          type: string
          enum:
          - CLOUDFORMATION
          description: The plan type.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
        Status:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_SUCCESS
          - CREATE_FAILED
          - EXECUTE_IN_PROGRESS
          - EXECUTE_SUCCESS
          - EXECUTE_FAILED
          description: The status.
        UpdatedTime:
          type: string
          format: date-time
          description: The UTC time stamp when the plan was last updated.
        NotificationArns:
          type: array
          items:
            type: string
          description: Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
        ProvisioningParameters:
          type: array
          items:
            $ref: '#/components/schemas/UpdateProvisioningParameter'
          description: Parameters specified by the administrator that are required for provisioning the product.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags.
        StatusMessage:
          type: string
          description: The status message.
    ProvisionedProductPlanSummary:
      type: object
      properties:
        PlanName:
          type: string
          description: The name of the plan.
        PlanId:
          type: string
          description: The plan identifier.
        ProvisionProductId:
          type: string
          description: The product identifier.
        ProvisionProductName:
          type: string
          description: The user-friendly name of the provisioned product.
        PlanType:
          type: string
          enum:
          - CLOUDFORMATION
          description: The plan type.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
    RecordDetail:
      type: object
      properties:
        RecordId:
          type: string
          description: The identifier of the record.
        ProvisionedProductName:
          type: string
          description: The user-friendly name of the provisioned product.
        Status:
          type: string
          enum:
          - CREATED
          - IN_PROGRESS
          - IN_PROGRESS_IN_ERROR
          - SUCCEEDED
          - FAILED
          description: 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:
          type: string
          format: date-time
          description: The UTC time stamp of the creation time.
        UpdatedTime:
          type: string
          format: date-time
          description: The time when the record was last updated.
        ProvisionedProductType:
          type: string
          description: The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE,
            TERRAFORM_CLOUD, and EXTERNAL.
        RecordType:
          type: string
          description: The record type. PROVISION_PRODUCT UPDATE_PROVISIONED_PRODUCT TERMINATE_PROVISIONED_PRODUCT
        ProvisionedProductId:
          type: string
          description: The identifier of the provisioned product.
        ProductId:
          type: string
          description: The product identifier.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
        PathId:
          type: string
          description: The path identifier.
        RecordErrors:
          type: array
          items:
            $ref: '#/components/schemas/RecordError'
          description: The errors that occurred.
        RecordTags:
          type: array
          items:
            $ref: '#/components/schemas/RecordTag'
          description: One or more tags.
        LaunchRoleArn:
          type: string
          description: The ARN of the launch role associated with the provisioned product.
    RecordError:
      type: object
      properties:
        Code:
          type: string
          description: The numeric value of the error.
        Description:
          type: string
          description: The description of the error.
    RecordTag:
      type: object
      properties:
        Key:
          type: string
          description: The key for this tag.
        Value:
          type: string
          description: The value for this tag.
    ResourceChange:
      type: object
      properties:
        Action:
          type: string
          enum:
          - ADD
          - MODIFY
          - REMOVE
          description: The change action.
        LogicalResourceId:
          type: string
          description: The ID of the resource, as defined in the CloudFormation template.
        PhysicalResourceId:
          type: string
          description: The ID of the resource, if it was already created.
        ResourceType:
          type: string
          description: The type of resource.
        Replacement:
          type: string
          enum:
          - 'TRUE'
          - 'FALSE'
          - CONDITIONAL
          description: If the change type is Modify, indicates whether the existing resource is deleted and replaced with
            a new one.
        Scope:
          type: array
          items:
            type: string
            enum:
            - PROPERTIES
            - METADATA
            - CREATIONPOLICY
            - UPDATEPOLICY
            - DELETIONPOLICY
            - TAGS
          description: The change scope.
        Details:
          type: array
          items:
            $ref: '#/components/schemas/ResourceChangeDetail'
          description: Information about the resource changes.
    ResourceChangeDetail:
      type: object
      properties:
        Target:
          $ref: '#/components/schemas/ResourceTargetDefinition'
        Evaluation:
          type: string
          enum:
          - STATIC
          - DYNAMIC
          description: 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:
          type: string
          description: The ID of the entity that caused the change.
    ResourceTargetDefinition:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - PROPERTIES
          - METADATA
          - CREATIONPOLICY
          - UPDATEPOLICY
          - DELETIONPOLICY
          - TAGS
          description: The attribute to be changed.
        Name:
          type: string
          description: If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.
        RequiresRecreation:
          type: string
          enum:
          - NEVER
          - CONDITIONALLY
          - ALWAYS
          description: If the attribute is Properties, indicates whether a change to this property causes the resource to
            be re-created.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key.
        Value:
          type: string
          description: The value for this key.
      required:
      - Key
      - Value
    UpdateProvisioningParameter:
      type: object
      properties:
        Key:
          type: string
          description: The parameter key.
        Value:
          type: string
          description: The parameter value.
        UsePreviousValue:
          type: boolean
          description: If set to true, Value is ignored and the previous parameter value is kept.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)