Amazon Service Catalog Service Catalog Provisioning Artifact API

openapi: 3.1.0
info:
  title: AWS Service Catalog Provisioning Artifact API
  version: '2015-12-10'
  description: Generated from AWS's published Smithy model for AWS Service Catalog. 6 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:
  /#CreateProvisioningArtifact:
    post:
      operationId: CreateProvisioningArtifact
      summary: Create Provisioning Artifact
      description: Creates a provisioning artifact (also known as a version) for the specified product. You cannot create
        a provisioning artifact for a product that was shared with you. The user or role that performs this operation must
        have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId
        template source in the information data section.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException; LimitExceededException; 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.CreateProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateProvisioningArtifactInput'
      tags:
      - Provisioning Artifact
  /#DeleteProvisioningArtifact:
    post:
      operationId: DeleteProvisioningArtifact
      summary: Delete Provisioning Artifact
      description: Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot
        delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning
        artifact for a product, because a product must have at least one provisioning artifact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException; ResourceInUseException; 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.DeleteProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProvisioningArtifactInput'
      tags:
      - Provisioning Artifact
  /#DescribeProvisioningArtifact:
    post:
      operationId: DescribeProvisioningArtifact
      summary: Describe Provisioning Artifact
      description: Gets information about the specified provisioning artifact (also known as a version) for the specified
        product.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProvisioningArtifactOutput'
        '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.DescribeProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProvisioningArtifactInput'
      tags:
      - Provisioning Artifact
  /#ListProvisioningArtifacts:
    post:
      operationId: ListProvisioningArtifacts
      summary: List Provisioning Artifacts
      description: Lists all provisioning artifacts (also known as versions) for the specified product.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProvisioningArtifactsOutput'
        '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.ListProvisioningArtifacts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProvisioningArtifactsInput'
      tags:
      - Provisioning Artifact
  /#ListProvisioningArtifactsForServiceAction:
    post:
      operationId: ListProvisioningArtifactsForServiceAction
      summary: List Provisioning Artifacts For Service Action
      description: Lists all provisioning artifacts (also known as versions) for the specified self-service action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProvisioningArtifactsForServiceActionOutput'
        '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.ListProvisioningArtifactsForServiceAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProvisioningArtifactsForServiceActionInput'
      tags:
      - Provisioning Artifact
  /#UpdateProvisioningArtifact:
    post:
      operationId: UpdateProvisioningArtifact
      summary: Update Provisioning Artifact
      description: Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot
        update a provisioning artifact for a product that was shared with you.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateProvisioningArtifactOutput'
        '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.UpdateProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateProvisioningArtifactInput'
      tags:
      - Provisioning Artifact
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:
    CreateProvisioningArtifactInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProductId:
          type: string
          description: The product identifier.
        Parameters:
          $ref: '#/components/schemas/ProvisioningArtifactProperties'
        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:
      - ProductId
      - Parameters
      - IdempotencyToken
    CreateProvisioningArtifactOutput:
      type: object
      properties:
        ProvisioningArtifactDetail:
          $ref: '#/components/schemas/ProvisioningArtifactDetail'
        Info:
          type: object
          additionalProperties:
            type: string
          description: 'Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL,
            ImportFromPhysicalId ]. Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. LoadTemplateFromURL
            Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. ImportFromPhysicalId Use the
            physical id of the resource that contains the template; currently supports CloudFormation stack ARN.'
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - FAILED
          description: The status of the current request.
    DeleteProvisioningArtifactInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProductId:
          type: string
          description: The product identifier.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
      required:
      - ProductId
      - ProvisioningArtifactId
    DeleteProvisioningArtifactOutput:
      type: object
      properties: {}
    DescribeProvisioningArtifactInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
        ProductId:
          type: string
          description: The product identifier.
        ProvisioningArtifactName:
          type: string
          description: The provisioning artifact name.
        ProductName:
          type: string
          description: The product name.
        Verbose:
          type: boolean
          description: Indicates whether a verbose level of detail is enabled.
        IncludeProvisioningArtifactParameters:
          type: boolean
          description: Indicates if the API call response does or does not include additional details about the provisioning
            parameters.
    DescribeProvisioningArtifactOutput:
      type: object
      properties:
        ProvisioningArtifactDetail:
          $ref: '#/components/schemas/ProvisioningArtifactDetail'
        Info:
          type: object
          additionalProperties:
            type: string
          description: The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - FAILED
          description: The status of the current request.
        ProvisioningArtifactParameters:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningArtifactParameter'
          description: Information about the parameters used to provision the product.
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListProvisioningArtifactsForServiceActionInput:
      type: object
      properties:
        ServiceActionId:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        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.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - ServiceActionId
    ListProvisioningArtifactsForServiceActionOutput:
      type: object
      properties:
        ProvisioningArtifactViews:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningArtifactView'
          description: An array of objects with information about product views and provisioning artifacts.
        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.
    ListProvisioningArtifactsInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProductId:
          type: string
          description: The product identifier.
      required:
      - ProductId
    ListProvisioningArtifactsOutput:
      type: object
      properties:
        ProvisioningArtifactDetails:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningArtifactDetail'
          description: Information about the provisioning artifacts.
        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.
    ParameterConstraints:
      type: object
      properties:
        AllowedValues:
          type: array
          items:
            type: string
          description: The values that the administrator has allowed for the parameter.
        AllowedPattern:
          type: string
          description: A regular expression that represents the patterns that allow for String types. The pattern must match
            the entire parameter value provided.
        ConstraintDescription:
          type: string
          description: 'A string that explains a constraint when the constraint is violated. For example, without a constraint
            description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when
            the user specifies an invalid value: Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+ By
            adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you
            can display the following customized error message: Malformed input-Parameter MyParameter must only contain uppercase
            and lowercase letters and numbers.'
        MaxLength:
          type: string
          description: An integer value that determines the largest number of characters you want to allow for String types.
        MinLength:
          type: string
          description: An integer value that determines the smallest number of characters you want to allow for String types.
        MaxValue:
          type: string
          description: A numeric value that determines the largest numeric value you want to allow for Number types.
        MinValue:
          type: string
          description: A numeric value that determines the smallest numeric value you want to allow for Number types.
    ProductViewSummary:
      type: object
      properties:
        Id:
          type: string
          description: The product view identifier.
        ProductId:
          type: string
          description: The product identifier.
        Name:
          type: string
          description: The name of the product.
        Owner:
          type: string
          description: The owner of the product. Contact the product administrator for the significance of this value.
        ShortDescription:
          type: string
          description: Short description of the product.
        Type:
          type: string
          enum:
          - CLOUD_FORMATION_TEMPLATE
          - MARKETPLACE
          - TERRAFORM_OPEN_SOURCE
          - TERRAFORM_CLOUD
          - EXTERNAL
          description: The product type. Contact the product administrator for the significance of this value. If this value
            is MARKETPLACE, the product was created by Amazon Web Services Marketplace.
        Distributor:
          type: string
          description: The distributor of the product. Contact the product administrator for the significance of this value.
        HasDefaultPath:
          type: boolean
          description: Indicates whether the product has a default path. If the product does not have a default path, call
            ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary
            can be used directly with DescribeProvisioningParameters.
        SupportEmail:
          type: string
          description: The email contact information to obtain support for this Product.
        SupportDescription:
          type: string
          description: The description of the support for this Product.
        SupportUrl:
          type: string
          description: The URL information to obtain support for this Product.
    ProvisioningArtifact:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the provisioning artifact.
        Name:
          type: string
          description: The name of the provisioning artifact.
        Description:
          type: string
          description: The description of the provisioning artifact.
        CreatedTime:
          type: string
          format: date-time
          description: The UTC time stamp of the creation time.
        Guidance:
          type: string
          enum:
          - DEFAULT
          - DEPRECATED
          description: Information set by the administrator to provide guidance to end users about which provisioning artifacts
            to use.
    ProvisioningArtifactDetail:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the provisioning artifact.
        Name:
          type: string
          description: The name of the provisioning artifact.
        Description:
          type: string
          description: The description of the provisioning artifact.
        Type:
          type: string
          enum:
          - CLOUD_FORMATION_TEMPLATE
          - MARKETPLACE_AMI
          - MARKETPLACE_CAR
          - TERRAFORM_OPEN_SOURCE
          - TERRAFORM_CLOUD
          - EXTERNAL
          description: The type of provisioning artifact. CLOUD_FORMATION_TEMPLATE - CloudFormation template TERRAFORM_OPEN_SOURCE
            - Terraform Open Source configuration file TERRAFORM_CLOUD - Terraform Cloud configuration file EXTERNAL - External
            configuration file
        CreatedTime:
          type: string
          format: date-time
          description: The UTC time stamp of the creation time.
        Active:
          type: boolean
          description: Indicates whether the product version is active.
        Guidance:
          type: string
          enum:
          - DEFAULT
          - DEPRECATED
          description: Information set by the administrator to provide guidance to end users about which provisioning artifacts
            to use.
        SourceRevision:
          type: string
          description: Specifies the revision of the external artifact that was used to automatically sync the Service Catalog
            product and create the provisioning artifact. Service Catalog includes this response parameter as a high level
            field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct,
            UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat
            APIs. This field only exists for Repo-Synced products.
    ProvisioningArtifactParameter:
      type: object
      properties:
        ParameterKey:
          type: string
          description: The parameter key.
        DefaultValue:
          type: string
          description: The default value.
        ParameterType:
          type: string
          description: The parameter type.
        IsNoEcho:
          type: boolean
          description: If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved.
            This parameter is used to hide sensitive information.
        Description:
          type: string
          description: The description of the parameter.
        ParameterConstraints:
          $ref: '#/components/schemas/ParameterConstraints'
    ProvisioningArtifactProperties:
      type: object
      properties:
        Name:
          type: string
          description: The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
        Description:
          type: string
          description: The description of the provisioning artifact, including how it differs from the previous provisioning
            artifact.
        Info:
          type: object
          additionalProperties:
            type: string
          description: 'Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL,
            ImportFromPhysicalId ] The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the
            URL in JSON format as follows: "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
            ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation
            stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId'
        Type:
          type: string
          enum:
          - CLOUD_FORMATION_TEMPLATE
          - MARKETPLACE_AMI
          - MARKETPLACE_CAR
          - TERRAFORM_OPEN_SOURCE
          - TERRAFORM_CLOUD
          - EXTERNAL
          description: The type of provisioning artifact. CLOUD_FORMATION_TEMPLATE - CloudFormation template TERRAFORM_OPEN_SOURCE
            - Terraform Open Source configuration file TERRAFORM_CLOUD - Terraform Cloud configuration file EXTERNAL - External
            configuration file
        DisableTemplateValidation:
          type: boolean
          description: If set to true, Service Catalog stops validating the specified provisioning artifact even if it is
            invalid. Service Catalog does not support template validation for the TERRAFORM_OS product type.
    ProvisioningArtifactView:
      type: object
      properties:
        ProductViewSummary:
          $ref: '#/components/schemas/ProductViewSummary'
        ProvisioningArtifact:
          $ref: '#/components/schemas/ProvisioningArtifact'
    UpdateProvisioningArtifactInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProductId:
          type: string
          description: The product identifier.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact.
        Name:
          type: string
          description: The updated name of the provisioning artifact.
        Description:
          type: string
          description: The updated description of the provisioning artifact.
        Active:
          type: boolean
          description: Indicates whether the product version is active. Inactive provisioning artifacts are invisible to end
            users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
        Guidance:
          type: string
          enum:
          - DEFAULT
          - DEPRECATED
          description: Information set by the administrator to provide guidance to end users about which provisioning artifacts
            to use. The DEFAULT value indicates that the product version is active. The administrator can set the guidance
            to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned
            product of a deprecated version but cannot launch new provisioned products using a deprecated version.
      required:
      - ProductId
      - ProvisioningArtifactId
    UpdateProvisioningArtifactOutput:
      type: object
      properties:
        ProvisioningArtifactDetail:
          $ref: '#/components/schemas/ProvisioningArtifactDetail'
        Info:
          type: object
          additionalProperties:
            type: string
          description: The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - FAILED
          description: The status of the current request.
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)