put_image ¶

def put_image(
    self,
    repository_name: "capo_ecr_public.types.repository_name.RepositoryName",
    image_manifest: "capo_ecr_public.types.image_manifest.ImageManifest",
    *,
    config_overrides: Optional[ECRPUBLICClientConfig] = None,
    registry_id: Optional[
        "capo_ecr_public.types.registry_id_or_alias.RegistryIdOrAlias"
    ] = None,
    image_manifest_media_type: Optional[
        "capo_ecr_public.types.media_type.MediaType"
    ] = None,
    image_tag: Optional["capo_ecr_public.types.image_tag.ImageTag"] = None,
    image_digest: Optional["capo_ecr_public.types.image_digest.ImageDigest"] = None,
) -> "capo_ecr_public.types.put_image_response.PutImageResponse":
    """<p>Creates or updates the image manifest and tags that are associated with an image.</p> <p>When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.</p> <note> <p>This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>

    Args:
        registry_id: <p>The Amazon Web Services account ID, or registry alias, that's associated with the public registry that contains the repository where the image is put. If you do not specify a registry, the default public registry is assumed.</p>
        repository_name: <p>The name of the repository where the image is put.</p>
        image_manifest: <p>The image manifest that corresponds to the image to be uploaded.</p>
        image_manifest_media_type: <p>The media type of the image manifest. If you push an image manifest that doesn't contain the <code>mediaType</code> field, you must specify the <code>imageManifestMediaType</code> in the request.</p>
        image_tag: <p>The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.</p>
        image_digest: <p>The image digest of the image manifest that corresponds to the image.</p>

    Raises:
        capo_ecr_public.errors.image_already_exists_exception.ImageAlreadyExistsException: <p>The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.</p>
        capo_ecr_public.errors.image_digest_does_not_match_exception.ImageDigestDoesNotMatchException: <p>The specified image digest doesn't match the digest that Amazon ECR calculated for the image.</p>
        capo_ecr_public.errors.image_tag_already_exists_exception.ImageTagAlreadyExistsException: <p>The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.</p>
        capo_ecr_public.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_ecr_public.errors.layers_not_found_exception.LayersNotFoundException: <p>The specified layers can't be found, or the specified layer isn't valid for this repository.</p>
        capo_ecr_public.errors.limit_exceeded_exception.LimitExceededException: <p>The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR Service Quotas</a> in the Amazon Elastic Container Registry User Guide.</p>
        capo_ecr_public.errors.referenced_images_not_found_exception.ReferencedImagesNotFoundException: <p>The manifest list is referencing an image that doesn't exist.</p>
        capo_ecr_public.errors.registry_not_found_exception.RegistryNotFoundException: <p>The registry doesn't exist.</p>
        capo_ecr_public.errors.repository_not_found_exception.RepositoryNotFoundException: <p>The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.</p>
        capo_ecr_public.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_ecr_public.errors.unsupported_command_exception.UnsupportedCommandException: <p>The action isn't supported in this Region.</p>
        capo_ecr_public.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ecr_public.types.put_image_request.PutImageRequest]",
    ) -> OperationResponse[
        "capo_ecr_public.types.put_image_response.PutImageResponse"
    ]:
        import capo_ecr_public._operations.spencer_frontend_service.put_image

        output, http_response = (
            capo_ecr_public._operations.spencer_frontend_service.put_image.put_image(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutImage")
    )
    input_: capo_ecr_public.types.put_image_request.PutImageRequest = {
        "repository_name": repository_name,
        "image_manifest": image_manifest,
    }
    if registry_id is not None:
        input_["registry_id"] = registry_id
    if image_manifest_media_type is not None:
        input_["image_manifest_media_type"] = image_manifest_media_type
    if image_tag is not None:
        input_["image_tag"] = image_tag
    if image_digest is not None:
        input_["image_digest"] = image_digest

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output