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-ecr:amazon-ecr-replication-backfill-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 Elastic Container Registry Replication Backfill API
  version: '2015-09-21'
  description: Generated from AWS's published Smithy model for Amazon Elastic Container Registry. 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://api.ecr.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Replication Backfill
paths:
  /#ListReplicationBackfills:
    post:
      operationId: ListReplicationBackfills
      summary: List Replication Backfills
      description: Lists the replication backfills for a registry, including their status and progress. Replication backfills that have reached a terminal status are retained for 90 days after they end, after which they are no longer returned.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListReplicationBackfillsResponse'
        '400':
          description: InvalidParameterException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerRegistry_V20150921.ListReplicationBackfills
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListReplicationBackfillsRequest'
      tags:
      - Replication Backfill
  /#StartReplicationBackfill:
    post:
      operationId: StartReplicationBackfill
      summary: Start Replication Backfill
      description: Starts a replication backfill for a registry. A replication backfill replicates a registry's existing images that match its replication configuration to the specified destination. Use the DescribeReplicationBackfillResults operation to monitor the progress of a replication backfill, and to retrieve its per-image results after it reaches a terminal status. The destination must already be configured in the registry's replication configuration. Only one replication backfill can be in progress for a given destination Region at a time. Starting a replication backfill for a destination Region that already has one in progress fails with a ReplicationBackfillInProgressException. In addition, a registry can have at most 10 replication backfills in progress at once. Starting a replication backfill that would exceed this limit fails with a LimitExceededException.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartReplicationBackfillResponse'
        '400':
          description: InvalidParameterException; LimitExceededException; ReplicationBackfillInProgressException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerRegistry_V20150921.StartReplicationBackfill
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartReplicationBackfillRequest'
      tags:
      - Replication Backfill
  /#StopReplicationBackfill:
    post:
      operationId: StopReplicationBackfill
      summary: Stop Replication Backfill
      description: Stops an in progress replication backfill for a registry. The backfill to stop is identified by the replicationBackfillId returned by the StartReplicationBackfill operation. Images that have already been replicated are not affected, and replications that are already in progress continue to completion.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopReplicationBackfillResponse'
        '400':
          description: InvalidParameterException; ReplicationBackfillInvalidStatusException; ReplicationBackfillNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerRegistry_V20150921.StopReplicationBackfill
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopReplicationBackfillRequest'
      tags:
      - Replication Backfill
components:
  schemas:
    ServerException:
      type: object
      properties:
        message:
          type: string
          description: The error message associated with the exception.
    ListReplicationBackfillsRequest:
      type: object
      properties:
        registryId:
          type: string
          description: The Amazon Web Services account ID associated with the registry for which to list replication backfills. If you do not specify a registry, the default registry is assumed.
        maxResults:
          type: integer
          description: The maximum number of replication backfill results returned by ListReplicationBackfills in paginated output. When this parameter is used, ListReplicationBackfills only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListReplicationBackfills request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then ListReplicationBackfills returns up to 25 results and a nextToken value, if applicable.
        nextToken:
          type: string
          description: The nextToken value returned from a previous paginated ListReplicationBackfills request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
    StopReplicationBackfillResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        replicationBackfillId:
          type: string
          description: The ID of the replication backfill.
        destination:
          $ref: '#/components/schemas/ReplicationDestination'
        status:
          type: string
          enum:
          - PREPARING
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - STOPPING
          - STOPPED
          description: The current status of the replication backfill. When you stop a replication backfill, its status is STOPPED if the backfill is stopped immediately, or STOPPING if there are replications still in progress that must complete before the backfill stops.
        startedAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the replication backfill was started.
    StartReplicationBackfillResponse:
      type: object
      properties:
        replicationBackfillId:
          type: string
          description: The ID of the replication backfill that was started. Use this value to describe or stop the backfill.
        registryId:
          type: string
          description: The registry ID associated with the request.
        destination:
          $ref: '#/components/schemas/ReplicationDestination'
        status:
          type: string
          enum:
          - PREPARING
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - STOPPING
          - STOPPED
          description: The current status of the replication backfill. A newly started replication backfill is returned with a status of PREPARING.
        startedAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the replication backfill was started.
    StartReplicationBackfillRequest:
      type: object
      properties:
        registryId:
          type: string
          description: The Amazon Web Services account ID associated with the registry from which to start the replication backfill. If you do not specify a registry, the default registry is assumed.
        destination:
          $ref: '#/components/schemas/ReplicationDestination'
      required:
      - destination
    StopReplicationBackfillRequest:
      type: object
      properties:
        registryId:
          type: string
          description: The Amazon Web Services account ID associated with the registry that contains the replication backfill to stop. If you do not specify a registry, the default registry is assumed.
        replicationBackfillId:
          type: string
          description: The ID of the replication backfill to stop.
      required:
      - replicationBackfillId
    ReplicationBackfillSummary:
      type: object
      properties:
        replicationBackfillId:
          type: string
          description: The ID of the replication backfill.
        destination:
          $ref: '#/components/schemas/ReplicationDestination'
        status:
          type: string
          enum:
          - PREPARING
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - STOPPING
          - STOPPED
          description: The current status of the replication backfill.
        failureCode:
          type: string
          description: The failure code for a replication backfill that has failed.
        progress:
          $ref: '#/components/schemas/ReplicationBackfillProgress'
        startedAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the replication backfill was started.
        endedAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the replication backfill ended. This value is null while the replication backfill is still in progress.
      required:
      - replicationBackfillId
      - destination
      - status
      - startedAt
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
          description: The error message associated with the exception.
    ReplicationDestination:
      type: object
      properties:
        region:
          type: string
          description: The Region to replicate to.
        registryId:
          type: string
          description: The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.
      required:
      - region
      - registryId
    ListReplicationBackfillsResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        backfills:
          type: array
          items:
            $ref: '#/components/schemas/ReplicationBackfillSummary'
          description: A list of the replication backfills for the registry.
        nextToken:
          type: string
          description: The nextToken value to include in a future ListReplicationBackfills request. When the results of a ListReplicationBackfills request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
    ReplicationBackfillProgress:
      type: object
      properties:
        totalReplicationCount:
          type: integer
          description: The total number of replications that the backfill will perform. Each image and tag combination is counted as a single replication.
        completedReplicationCount:
          type: integer
          description: The number of replications that have completed successfully.
        failedReplicationCount:
          type: integer
          description: The number of replications that have failed.
        failureCodes:
          type: array
          items:
            type: string
          description: The distinct failure codes for the replications that have failed. Each failure code appears at most once, regardless of how many replications failed with that code.
      required:
      - totalReplicationCount
      - completedReplicationCount
      - failedReplicationCount
      - failureCodes
  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: ecr
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ecr/service/2015-09-21/ecr-2015-09-21.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)