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-copy-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 Copy 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 Copy Jobs
paths:
  /model-copy-jobs:
    post:
      operationId: CreateModelCopyJob
      summary: Create Model Copy Job
      description: Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateModelCopyJobResponse'
        '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'
        '400':
          description: TooManyTagsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyTagsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModelCopyJobRequest'
      tags:
      - Model Copy Jobs
    get:
      operationId: ListModelCopyJobs
      summary: List Model Copy Jobs
      description: Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelCopyJobsResponse'
        '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/ListModelCopyJobsRequest'
      tags:
      - Model Copy Jobs
  /model-copy-jobs/{jobArn}:
    get:
      operationId: GetModelCopyJob
      summary: Get Model Copy Job
      description: Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelCopyJobResponse'
        '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/GetModelCopyJobRequest'
      tags:
      - Model Copy Jobs
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    TooManyTagsException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource with too many tags.
    GetModelCopyJobRequest:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model copy job.
      required:
      - jobArn
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ListModelCopyJobsRequest:
      type: object
      properties:
        creationTimeAfter:
          type: string
          format: date-time
          description: Filters for model copy jobs created after the specified time.
        creationTimeBefore:
          type: string
          format: date-time
          description: Filters for model copy jobs created before the specified time.
        statusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: Filters for model copy jobs whose status matches the value that you specify.
        sourceAccountEquals:
          type: string
          description: Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.
        sourceModelArnEquals:
          type: string
          description: Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.
        targetModelNameContains:
          type: string
          description: Filters for model copy jobs in which the name of the copied model contains the string that you specify.
        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 model copy jobs.
        sortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Specifies whether to sort the results in ascending or descending order.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    CreateModelCopyJobRequest:
      type: object
      properties:
        sourceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model to be copied.
        targetModelName:
          type: string
          description: A name for the copied model.
        modelKmsKeyId:
          type: string
          description: The ARN of the KMS key that you use to encrypt the model copy.
        targetModelTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.
        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.
      required:
      - sourceModelArn
      - targetModelName
    Tag:
      type: object
      properties:
        key:
          type: string
          description: Key for the tag.
        value:
          type: string
          description: Value for the tag.
      required:
      - key
      - value
    ListModelCopyJobsResponse:
      type: object
      properties:
        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.
        modelCopyJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ModelCopyJobSummary'
          description: A list of information about each model copy job.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ModelCopyJobSummary:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resoource Name (ARN) of the model copy job.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The status of the model copy job.
        creationTime:
          type: string
          format: date-time
          description: The time that the model copy job was created.
        targetModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the copied model.
        targetModelName:
          type: string
          description: The name of the copied model.
        sourceAccountId:
          type: string
          description: The unique identifier of the account that the model being copied originated from.
        sourceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the original model being copied.
        targetModelKmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.
        targetModelTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags associated with the copied model.
        failureMessage:
          type: string
          description: If a model fails to be copied, a message describing why the job failed is included here.
        sourceModelName:
          type: string
          description: The name of the original model being copied.
      required:
      - jobArn
      - status
      - creationTime
      - targetModelArn
      - sourceAccountId
      - sourceModelArn
    GetModelCopyJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model copy job.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The status of the model copy job.
        creationTime:
          type: string
          format: date-time
          description: The time at which the model copy job was created.
        targetModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the copied model.
        targetModelName:
          type: string
          description: The name of the copied model.
        sourceAccountId:
          type: string
          description: The unique identifier of the account that the model being copied originated from.
        sourceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the original model being copied.
        targetModelKmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
        targetModelTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the copied model.
        failureMessage:
          type: string
          description: An error message for why the model copy job failed.
        sourceModelName:
          type: string
          description: The name of the original model being copied.
      required:
      - jobArn
      - status
      - creationTime
      - targetModelArn
      - sourceAccountId
      - sourceModelArn
    CreateModelCopyJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model copy job.
      required:
      - jobArn
  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)