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-model-import-jobs-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 Model Import Jobs API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 3 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: Model Import Jobs
paths:
  /model-import-jobs:
    post:
      operationId: CreateModelImportJob
      summary: Create Model Import Job
      description: Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateModelImportJobResponse'
        '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/CreateModelImportJobRequest'
      tags:
      - Model Import Jobs
    get:
      operationId: ListModelImportJobs
      summary: List Model Import Jobs
      description: Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelImportJobsResponse'
        '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/ListModelImportJobsRequest'
      tags:
      - Model Import Jobs
  /model-import-jobs/{jobIdentifier}:
    get:
      operationId: GetModelImportJob
      summary: Get Model Import Job
      description: Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelImportJobResponse'
        '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/GetModelImportJobRequest'
      tags:
      - Model Import Jobs
components:
  schemas:
    ListModelImportJobsResponse:
      type: object
      properties:
        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.
        modelImportJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ModelImportJobSummary'
          description: Import job summaries.
    CreateModelImportJobRequest:
      type: object
      properties:
        jobName:
          type: string
          description: The name of the import job.
        importedModelName:
          type: string
          description: The name of the imported model.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model import job.
        modelDataSource:
          $ref: '#/components/schemas/ModelDataSource'
        jobTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to attach to this import job.
        importedModelTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to attach to the imported model.
        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.
        vpcConfig:
          $ref: '#/components/schemas/VpcConfig'
        importedModelKmsKeyId:
          type: string
          description: The imported model is encrypted at rest using this key.
      required:
      - jobName
      - importedModelName
      - roleArn
      - modelDataSource
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    CreateModelImportJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model import job.
      required:
      - jobArn
    ListModelImportJobsRequest:
      type: object
      properties:
        creationTimeAfter:
          type: string
          format: date-time
          description: Return import jobs that were created after the specified time.
        creationTimeBefore:
          type: string
          format: date-time
          description: Return import jobs that were created before the specified time.
        statusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: Return imported jobs with the specified status.
        nameContains:
          type: string
          description: Return imported jobs only if the job name contains these characters.
        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.
        sortBy:
          type: string
          enum:
          - CreationTime
          description: The field to sort by in the returned list of imported jobs.
        sortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Specifies whether to sort the results in ascending or descending order.
    GetModelImportJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the import job.
        jobName:
          type: string
          description: The name of the import job.
        importedModelName:
          type: string
          description: The name of the imported model.
        importedModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the imported model.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role associated with this job.
        modelDataSource:
          $ref: '#/components/schemas/ModelDataSource'
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.
        failureMessage:
          type: string
          description: Information about why the import job failed.
        creationTime:
          type: string
          format: date-time
          description: The time the resource was created.
        lastModifiedTime:
          type: string
          format: date-time
          description: Time the resource was last modified.
        endTime:
          type: string
          format: date-time
          description: Time that the resource transitioned to terminal state.
        vpcConfig:
          $ref: '#/components/schemas/VpcConfig'
        importedModelKmsKeyArn:
          type: string
          description: The imported model is encrypted at rest using this key.
    S3DataSource:
      type: object
      properties:
        s3Uri:
          type: string
          description: The URI of the Amazon S3 data source.
      required:
      - s3Uri
    ConflictException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    GetModelImportJobRequest:
      type: object
      properties:
        jobIdentifier:
          type: string
          description: The identifier of the import job.
      required:
      - jobIdentifier
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ModelDataSource:
      type: object
      properties:
        s3DataSource:
          $ref: '#/components/schemas/S3DataSource'
      description: Exactly one member is set.
    VpcConfig:
      type: object
      properties:
        subnetIds:
          type: array
          items:
            type: string
          description: An array of IDs for each subnet in the VPC to use.
        securityGroupIds:
          type: array
          items:
            type: string
          description: An array of IDs for each security group in the VPC to use.
      required:
      - subnetIds
      - securityGroupIds
    Tag:
      type: object
      properties:
        key:
          type: string
          description: Key for the tag.
        value:
          type: string
          description: Value for the tag.
      required:
      - key
      - value
    ModelImportJobSummary:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the import job.
        jobName:
          type: string
          description: The name of the import job.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The status of the imported job.
        lastModifiedTime:
          type: string
          format: date-time
          description: The time when the import job was last modified.
        creationTime:
          type: string
          format: date-time
          description: The time import job was created.
        endTime:
          type: string
          format: date-time
          description: The time when import job ended.
        importedModelArn:
          type: string
          description: The Amazon resource Name (ARN) of the imported model.
        importedModelName:
          type: string
          description: The name of the imported model.
      required:
      - jobArn
      - jobName
      - status
      - creationTime
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
  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)