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-bedrock:amazon-bedrock-inference-profiles-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.2.0
info:
  title: Amazon Bedrock Inference Profiles API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 4 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://bedrock.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Inference Profiles
paths:
  /inference-profiles:
    post:
      operationId: CreateInferenceProfile
      summary: Create Inference Profile
      description: Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInferenceProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ServiceQuotaExceededException; TooManyTagsException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInferenceProfileRequest'
      tags:
      - Inference Profiles
    get:
      operationId: ListInferenceProfiles
      summary: List Inference Profiles
      description: Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInferenceProfilesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListInferenceProfilesRequest'
      tags:
      - Inference Profiles
  /inference-profiles/{inferenceProfileIdentifier}:
    get:
      operationId: GetInferenceProfile
      summary: Get Inference Profile
      description: Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInferenceProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInferenceProfileRequest'
      tags:
      - Inference Profiles
    delete:
      operationId: DeleteInferenceProfile
      summary: Delete Inference Profile
      description: Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInferenceProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInferenceProfileRequest'
      tags:
      - Inference Profiles
components:
  schemas:
    DeleteInferenceProfileRequest:
      type: object
      properties:
        inferenceProfileIdentifier:
          type: string
          description: The Amazon Resource Name (ARN) or ID of the application inference profile to delete.
      required:
      - inferenceProfileIdentifier
    InferenceProfileModelSource:
      type: object
      properties:
        copyFrom:
          type: string
          description: The ARN of the model or system-defined inference profile that is the source for the inference profile.
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ListInferenceProfilesRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
        typeEquals:
          type: string
          enum:
          - SYSTEM_DEFINED
          - APPLICATION
          description: Filters for inference profiles that match the type you specify. SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateInferenceProfileResponse:
      type: object
      properties:
        inferenceProfileArn:
          type: string
          description: The ARN of the inference profile that you created.
        status:
          type: string
          enum:
          - ACTIVE
          description: The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
      required:
      - inferenceProfileArn
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        key:
          type: string
          description: Key for the tag.
        value:
          type: string
          description: Value for the tag.
      required:
      - key
      - value
    InferenceProfileSummary:
      type: object
      properties:
        inferenceProfileName:
          type: string
          description: The name of the inference profile.
        description:
          type: string
          description: The description of the inference profile.
        createdAt:
          type: string
          format: date-time
          description: The time at which the inference profile was created.
        updatedAt:
          type: string
          format: date-time
          description: The time at which the inference profile was last updated.
        inferenceProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the inference profile.
        models:
          type: array
          items:
            $ref: '#/components/schemas/InferenceProfileModel'
          description: A list of information about each model in the inference profile.
        inferenceProfileId:
          type: string
          description: The unique identifier of the inference profile.
        status:
          type: string
          enum:
          - ACTIVE
          description: The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
        type:
          type: string
          enum:
          - SYSTEM_DEFINED
          - APPLICATION
          description: 'The type of the inference profile. The following types are possible: SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.'
      required:
      - inferenceProfileName
      - inferenceProfileArn
      - models
      - inferenceProfileId
      - status
      - type
    ListInferenceProfilesResponse:
      type: object
      properties:
        inferenceProfileSummaries:
          type: array
          items:
            $ref: '#/components/schemas/InferenceProfileSummary'
          description: A list of information about each inference profile that you can use.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
    DeleteInferenceProfileResponse:
      type: object
      properties: {}
    InferenceProfileModel:
      type: object
      properties:
        modelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model.
    GetInferenceProfileRequest:
      type: object
      properties:
        inferenceProfileIdentifier:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the inference profile.
      required:
      - inferenceProfileIdentifier
    GetInferenceProfileResponse:
      type: object
      properties:
        inferenceProfileName:
          type: string
          description: The name of the inference profile.
        description:
          type: string
          description: The description of the inference profile.
        createdAt:
          type: string
          format: date-time
          description: The time at which the inference profile was created.
        updatedAt:
          type: string
          format: date-time
          description: The time at which the inference profile was last updated.
        inferenceProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the inference profile.
        models:
          type: array
          items:
            $ref: '#/components/schemas/InferenceProfileModel'
          description: A list of information about each model in the inference profile.
        inferenceProfileId:
          type: string
          description: The unique identifier of the inference profile.
        status:
          type: string
          enum:
          - ACTIVE
          description: The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
        type:
          type: string
          enum:
          - SYSTEM_DEFINED
          - APPLICATION
          description: 'The type of the inference profile. The following types are possible: SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.'
      required:
      - inferenceProfileName
      - inferenceProfileArn
      - models
      - inferenceProfileId
      - status
      - type
    CreateInferenceProfileRequest:
      type: object
      properties:
        inferenceProfileName:
          type: string
          description: A name for the inference profile.
        description:
          type: string
          description: A description for the inference profile.
        clientRequestToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
        modelSource:
          $ref: '#/components/schemas/InferenceProfileModelSource'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of objects, each of which contains a tag and its value. For more information, see Tagging resources in the Amazon Bedrock User Guide.
      required:
      - inferenceProfileName
      - modelSource
  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: bedrock
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)