find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-service-catalog:amazon-service-catalog-constraint-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS Service Catalog Constraint 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:
  /#CreateConstraint:
    post:
      operationId: CreateConstraint
      summary: Create Constraint
      description: Creates a constraint. A delegated admin is authorized to invoke this command.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateConstraintOutput'
        '400':
          description: DuplicateResourceException; InvalidParametersException; LimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.CreateConstraint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateConstraintInput'
      tags:
      - Constraint
  /#DeleteConstraint:
    post:
      operationId: DeleteConstraint
      summary: Delete Constraint
      description: Deletes the specified constraint. A delegated admin is authorized to invoke this command.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteConstraintOutput'
        '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.DeleteConstraint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteConstraintInput'
      tags:
      - Constraint
  /#DescribeConstraint:
    post:
      operationId: DescribeConstraint
      summary: Describe Constraint
      description: Gets information about the specified constraint.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeConstraintOutput'
        '400':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DescribeConstraint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeConstraintInput'
      tags:
      - Constraint
  /#ListConstraintsForPortfolio:
    post:
      operationId: ListConstraintsForPortfolio
      summary: List Constraints For Portfolio
      description: Lists the constraints for the specified portfolio and product.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListConstraintsForPortfolioOutput'
        '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.ListConstraintsForPortfolio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListConstraintsForPortfolioInput'
      tags:
      - Constraint
  /#UpdateConstraint:
    post:
      operationId: UpdateConstraint
      summary: Update Constraint
      description: Updates the specified constraint.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateConstraintOutput'
        '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.UpdateConstraint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateConstraintInput'
      tags:
      - Constraint
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:
    ConstraintDetail:
      type: object
      properties:
        ConstraintId:
          type: string
          description: The identifier of the constraint.
        Type:
          type: string
          description: The type of constraint. LAUNCH NOTIFICATION STACKSET TEMPLATE
        Description:
          type: string
          description: The description of the constraint.
        Owner:
          type: string
          description: The owner of the constraint.
        ProductId:
          type: string
          description: The identifier of the product the constraint applies to. Note that a constraint applies to a specific
            instance of a product within a certain portfolio.
        PortfolioId:
          type: string
          description: The identifier of the portfolio the product resides in. The constraint applies only to the instance
            of the product that lives within this portfolio.
    CreateConstraintInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PortfolioId:
          type: string
          description: The portfolio identifier.
        ProductId:
          type: string
          description: The product identifier.
        Parameters:
          type: string
          description: 'The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH
            You are required to specify either the RoleArn or the LocalRoleName but can''t use both. Specify the RoleArn property
            as follows: {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} Specify the LocalRoleName property as follows:
            {"LocalRoleName": "SCBasicLaunchRole"} If you specify the LocalRoleName property, when an account uses the launch
            constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be
            account-agnostic so the administrator'
        Type:
          type: string
          description: The type of constraint. LAUNCH NOTIFICATION RESOURCE_UPDATE STACKSET TEMPLATE
        Description:
          type: string
          description: The description of the constraint.
        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:
      - PortfolioId
      - ProductId
      - Parameters
      - Type
      - IdempotencyToken
    CreateConstraintOutput:
      type: object
      properties:
        ConstraintDetail:
          $ref: '#/components/schemas/ConstraintDetail'
        ConstraintParameters:
          type: string
          description: The constraint parameters.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - FAILED
          description: The status of the current request.
    DeleteConstraintInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The identifier of the constraint.
      required:
      - Id
    DeleteConstraintOutput:
      type: object
      properties: {}
    DescribeConstraintInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The identifier of the constraint.
      required:
      - Id
    DescribeConstraintOutput:
      type: object
      properties:
        ConstraintDetail:
          $ref: '#/components/schemas/ConstraintDetail'
        ConstraintParameters:
          type: string
          description: The constraint parameters.
        Status:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - FAILED
          description: The status of the current request.
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListConstraintsForPortfolioInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PortfolioId:
          type: string
          description: The portfolio identifier.
        ProductId:
          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.
      required:
      - PortfolioId
    ListConstraintsForPortfolioOutput:
      type: object
      properties:
        ConstraintDetails:
          type: array
          items:
            $ref: '#/components/schemas/ConstraintDetail'
          description: Information about the constraints.
        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.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    UpdateConstraintInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The identifier of the constraint.
        Description:
          type: string
          description: The updated description of the constraint.
        Parameters:
          type: string
          description: 'The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH
            You are required to specify either the RoleArn or the LocalRoleName but can''t use both. Specify the RoleArn property
            as follows: {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} Specify the LocalRoleName property as follows:
            {"LocalRoleName": "SCBasicLaunchRole"} If you specify the LocalRoleName property, when an account uses the launch
            constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be
            account-agnostic so the administrator'
      required:
      - Id
    UpdateConstraintOutput:
      type: object
      properties:
        ConstraintDetail:
          $ref: '#/components/schemas/ConstraintDetail'
        ConstraintParameters:
          type: string
          description: The constraint parameters.
        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)