Amazon ECR Ecr Repository Creation Template API

openapi: 3.2.0
info:
  title: Amazon Elastic Container Registry Repository Creation…
  version: '2015-09-21'
  description: Generated from AWS's published Smithy model for Amazon Elastic Container Registry. 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://api.ecr.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Repository Creation Template
paths:
  /#CreateRepositoryCreationTemplate:
    post:
      operationId: CreateRepositoryCreationTemplate
      summary: Create Repository Creation Template
      description: Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateRepositoryCreationTemplateResponse'
        '400':
          description: InvalidParameterException; LimitExceededException; TemplateAlreadyExistsException; 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.CreateRepositoryCreationTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateRepositoryCreationTemplateRequest'
      tags:
      - Repository Creation Template
  /#DeleteRepositoryCreationTemplate:
    post:
      operationId: DeleteRepositoryCreationTemplate
      summary: Delete Repository Creation Template
      description: Deletes a repository creation template.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteRepositoryCreationTemplateResponse'
        '400':
          description: InvalidParameterException; TemplateNotFoundException; 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.DeleteRepositoryCreationTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteRepositoryCreationTemplateRequest'
      tags:
      - Repository Creation Template
  /#DescribeRepositoryCreationTemplates:
    post:
      operationId: DescribeRepositoryCreationTemplates
      summary: Describe Repository Creation Templates
      description: Returns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific repository creation template.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeRepositoryCreationTemplatesResponse'
        '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.DescribeRepositoryCreationTemplates
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeRepositoryCreationTemplatesRequest'
      tags:
      - Repository Creation Template
  /#UpdateRepositoryCreationTemplate:
    post:
      operationId: UpdateRepositoryCreationTemplate
      summary: Update Repository Creation Template
      description: Updates an existing repository creation template.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateRepositoryCreationTemplateResponse'
        '400':
          description: InvalidParameterException; TemplateNotFoundException; 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.UpdateRepositoryCreationTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateRepositoryCreationTemplateRequest'
      tags:
      - Repository Creation Template
components:
  schemas:
    ServerException:
      type: object
      properties:
        message:
          type: string
          description: The error message associated with the exception.
    EncryptionConfigurationForRepositoryCreationTemplate:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - AES256
          - KMS
          - KMS_DSSE
          description: The encryption type to use. If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide. If you use the AES256 encryption type, Am
        kmsKey:
          type: string
          description: If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
      required:
      - encryptionType
    CreateRepositoryCreationTemplateResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        repositoryCreationTemplate:
          $ref: '#/components/schemas/RepositoryCreationTemplate'
    ImageTagMutabilityExclusionFilter:
      type: object
      properties:
        filterType:
          type: string
          enum:
          - WILDCARD
          description: The type of filter to apply for excluding image tags from mutability settings.
        filter:
          type: string
          description: The filter value used to match image tags for exclusion from mutability settings.
      required:
      - filterType
      - filter
    UpdateRepositoryCreationTemplateRequest:
      type: object
      properties:
        prefix:
          type: string
          description: The repository namespace prefix that matches an existing repository creation template in the registry. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. This includes a repository named prod/team1 as well as a repository named prod/repository1. To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.
        description:
          type: string
          description: A description for the repository creation template.
        encryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfigurationForRepositoryCreationTemplate'
        resourceTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
        imageTagMutability:
          type: string
          enum:
          - MUTABLE
          - IMMUTABLE
          - IMMUTABLE_WITH_EXCLUSION
          - MUTABLE_WITH_EXCLUSION
          description: Updates the tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
        imageTagMutabilityExclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter'
          description: A list of filters that specify which image tags should be excluded from the repository creation template's image tag mutability setting.
        repositoryPolicy:
          type: string
          description: Updates the repository policy created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.
        lifecyclePolicy:
          type: string
          description: Updates the lifecycle policy associated with the specified repository creation template.
        appliedFor:
          type: array
          items:
            type: string
            enum:
            - REPLICATION
            - PULL_THROUGH_CACHE
            - CREATE_ON_PUSH
          description: Updates the list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
        customRoleArn:
          type: string
          description: The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.
      required:
      - prefix
    CreateRepositoryCreationTemplateRequest:
      type: object
      properties:
        prefix:
          type: string
          description: The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. Similarly, a prefix of prod/team would apply to all repositories beginning with prod/team/. To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix. There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon E
        description:
          type: string
          description: A description for the repository creation template.
        encryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfigurationForRepositoryCreationTemplate'
        resourceTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
        imageTagMutability:
          type: string
          enum:
          - MUTABLE
          - IMMUTABLE
          - IMMUTABLE_WITH_EXCLUSION
          - MUTABLE_WITH_EXCLUSION
          description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
        imageTagMutabilityExclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter'
          description: A list of filters that specify which image tags should be excluded from the repository creation template's image tag mutability setting.
        repositoryPolicy:
          type: string
          description: The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.
        lifecyclePolicy:
          type: string
          description: The lifecycle policy to use for repositories created using the template.
        appliedFor:
          type: array
          items:
            type: string
            enum:
            - REPLICATION
            - PULL_THROUGH_CACHE
            - CREATE_ON_PUSH
          description: A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
        customRoleArn:
          type: string
          description: The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.
      required:
      - prefix
      - appliedFor
    DescribeRepositoryCreationTemplatesRequest:
      type: object
      properties:
        prefixes:
          type: array
          items:
            type: string
          description: The repository namespace prefixes associated with the repository creation templates to describe. If this value is not specified, all repository creation templates are returned.
        nextToken:
          type: string
          description: The nextToken value returned from a previous paginated DescribeRepositoryCreationTemplates 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.
        maxResults:
          type: integer
          description: 'The maximum number of repository results returned by DescribeRepositoryCreationTemplatesRequest in paginated output. When this parameter is used, DescribeRepositoryCreationTemplatesRequest 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 DescribeRepositoryCreationTemplatesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositoryCreationTemplatesRequest returns up to 100 results and a nextToken '
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
        Value:
          type: string
          description: A value acts as a descriptor within a tag category (key).
      required:
      - Key
      - Value
    DeleteRepositoryCreationTemplateResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        repositoryCreationTemplate:
          $ref: '#/components/schemas/RepositoryCreationTemplate'
    DescribeRepositoryCreationTemplatesResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        repositoryCreationTemplates:
          type: array
          items:
            $ref: '#/components/schemas/RepositoryCreationTemplate'
          description: The details of the repository creation templates.
        nextToken:
          type: string
          description: The nextToken value to include in a future DescribeRepositoryCreationTemplates request. When the results of a DescribeRepositoryCreationTemplates 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.
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
          description: The error message associated with the exception.
    UpdateRepositoryCreationTemplateResponse:
      type: object
      properties:
        registryId:
          type: string
          description: The registry ID associated with the request.
        repositoryCreationTemplate:
          $ref: '#/components/schemas/RepositoryCreationTemplate'
    RepositoryCreationTemplate:
      type: object
      properties:
        prefix:
          type: string
          description: The repository namespace prefix associated with the repository creation template.
        description:
          type: string
          description: The description associated with the repository creation template.
        encryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfigurationForRepositoryCreationTemplate'
        resourceTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
        imageTagMutability:
          type: string
          enum:
          - MUTABLE
          - IMMUTABLE
          - IMMUTABLE_WITH_EXCLUSION
          - MUTABLE_WITH_EXCLUSION
          description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
        imageTagMutabilityExclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter'
          description: A list of filters that specify which image tags are excluded from the repository creation template's image tag mutability setting.
        repositoryPolicy:
          type: string
          description: The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.
        lifecyclePolicy:
          type: string
          description: The lifecycle policy to use for repositories created using the template.
        appliedFor:
          type: array
          items:
            type: string
            enum:
            - REPLICATION
            - PULL_THROUGH_CACHE
            - CREATE_ON_PUSH
          description: A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
        customRoleArn:
          type: string
          description: The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.
        createdAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the repository creation template was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time, in JavaScript date format, when the repository creation template was last updated.
    DeleteRepositoryCreationTemplateRequest:
      type: object
      properties:
        prefix:
          type: string
          description: The repository namespace prefix associated with the repository creation template.
      required:
      - prefix
  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)