Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.ECR

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using AWS IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

Synopsis

Service Configuration

ecr :: Service Source

API version '2015-09-21' of the Amazon EC2 Container Registry SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by ECR.

LayersNotFoundException

_LayersNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified layers could not be found, or the specified layer is not valid for this repository.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified parameter is invalid. Review the available parameters for the API request.

LayerAlreadyExistsException

_LayerAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

The image layer already exists in the associated repository.

ServerException

_ServerException :: AsError a => Getting (First ServiceError) a ServiceError Source

These errors are usually caused by a server-side issue.

LayerInaccessibleException

_LayerInaccessibleException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

InvalidLayerException

_InvalidLayerException :: AsError a => Getting (First ServiceError) a ServiceError Source

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

LayerPartTooSmallException

_LayerPartTooSmallException :: AsError a => Getting (First ServiceError) a ServiceError Source

Layer parts must be at least 5 MiB in size.

ImageAlreadyExistsException

_ImageAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified image has already been pushed, and there are no changes to the manifest or image tag since the last push.

RepositoryNotFoundException

_RepositoryNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UploadNotFoundException

_UploadNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

The upload could not be found, or the specified upload id is not valid for this repository.

InvalidLayerPartException

_InvalidLayerPartException :: AsError a => Getting (First ServiceError) a ServiceError Source

The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

RepositoryNotEmptyException

_RepositoryNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

RepositoryAlreadyExistsException

_RepositoryAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified repository already exists in the specified registry.

RepositoryPolicyNotFoundException

_RepositoryPolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified repository and registry combination does not have an associated repository policy.

EmptyUploadException

_EmptyUploadException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified layer upload does not contain any layer parts.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon EC2 Container Registry User Guide.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetRepositoryPolicy

module Network.AWS.ECR.GetRepositoryPolicy

BatchDeleteImage

module Network.AWS.ECR.BatchDeleteImage

BatchCheckLayerAvailability

module Network.AWS.ECR.BatchCheckLayerAvailability

DeleteRepositoryPolicy

module Network.AWS.ECR.DeleteRepositoryPolicy

CreateRepository

module Network.AWS.ECR.CreateRepository

CompleteLayerUpload

module Network.AWS.ECR.CompleteLayerUpload

DescribeRepositories

module Network.AWS.ECR.DescribeRepositories

UploadLayerPart

module Network.AWS.ECR.UploadLayerPart

BatchGetImage

module Network.AWS.ECR.BatchGetImage

SetRepositoryPolicy

module Network.AWS.ECR.SetRepositoryPolicy

InitiateLayerUpload

module Network.AWS.ECR.InitiateLayerUpload

DeleteRepository

module Network.AWS.ECR.DeleteRepository

PutImage

module Network.AWS.ECR.PutImage

ListImages

module Network.AWS.ECR.ListImages

GetAuthorizationToken

module Network.AWS.ECR.GetAuthorizationToken

GetDownloadURLForLayer

module Network.AWS.ECR.GetDownloadURLForLayer

Types

ImageFailureCode

LayerAvailability

LayerFailureCode

AuthorizationData

data AuthorizationData Source

An object representing authorization data for an Amazon ECR registry.

See: authorizationData smart constructor.

authorizationData :: AuthorizationData Source

Creates a value of AuthorizationData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

adExpiresAt :: Lens' AuthorizationData (Maybe UTCTime) Source

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

adProxyEndpoint :: Lens' AuthorizationData (Maybe Text) Source

The registry URL to use for this authorization token in a 'docker login' command. The Amazon ECR registry URL format is 'https:\/\/aws_account_id.dkr.ecr.region.amazonaws.com'. For example, 'https:\/\/012345678910.dkr.ecr.us-east-1.amazonaws.com'.

adAuthorizationToken :: Lens' AuthorizationData (Maybe Text) Source

A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format 'user:password' for private registry authentication using 'docker login'.

Image

data Image Source

Object representing an image.

See: image smart constructor.

Instances

Eq Image Source
Data Image Source
Read Image Source
Show Image Source
Generic Image Source
FromJSON Image Source
Hashable Image Source
type Rep Image Source

image :: Image Source

Creates a value of Image with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iRegistryId :: Lens' Image (Maybe Text) Source

The AWS account ID associated with the registry containing the image.

iImageId :: Lens' Image (Maybe ImageIdentifier) Source

An object containing the image tag and image digest associated with an image.

iRepositoryName :: Lens' Image (Maybe Text) Source

The name of the repository associated with the image.

iImageManifest :: Lens' Image (Maybe Text) Source

The image manifest associated with the image.

ImageFailure

data ImageFailure Source

See: imageFailure smart constructor.

imageFailure :: ImageFailure Source

Creates a value of ImageFailure with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ifFailureReason :: Lens' ImageFailure (Maybe Text) Source

The reason for the failure.

ifFailureCode :: Lens' ImageFailure (Maybe ImageFailureCode) Source

The code associated with the failure.

ifImageId :: Lens' ImageFailure (Maybe ImageIdentifier) Source

The image ID associated with the failure.

ImageIdentifier

data ImageIdentifier Source

See: imageIdentifier smart constructor.

imageIdentifier :: ImageIdentifier Source

Creates a value of ImageIdentifier with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iiImageDigest
iiImageTag

iiImageDigest :: Lens' ImageIdentifier (Maybe Text) Source

The sha256 digest of the image manifest.

iiImageTag :: Lens' ImageIdentifier (Maybe Text) Source

The tag used for the image.

Layer

data Layer Source

See: layer smart constructor.

Instances

Eq Layer Source
Data Layer Source
Read Layer Source
Show Layer Source
Generic Layer Source
FromJSON Layer Source
Hashable Layer Source
type Rep Layer Source

layer :: Layer Source

Creates a value of Layer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lLayerDigest :: Lens' Layer (Maybe Text) Source

The sha256 digest of the image layer.

lLayerSize :: Lens' Layer (Maybe Integer) Source

The size, in bytes, of the image layer.

lLayerAvailability :: Lens' Layer (Maybe LayerAvailability) Source

The availability status of the image layer. Valid values are AVAILABLE and UNAVAILABLE.

LayerFailure

data LayerFailure Source

See: layerFailure smart constructor.

layerFailure :: LayerFailure Source

Creates a value of LayerFailure with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lfFailureReason :: Lens' LayerFailure (Maybe Text) Source

The reason for the failure.

lfFailureCode :: Lens' LayerFailure (Maybe LayerFailureCode) Source

The failure code associated with the failure.

lfLayerDigest :: Lens' LayerFailure (Maybe Text) Source

The layer digest associated with the failure.

Repository

data Repository Source

Object representing a repository.

See: repository smart constructor.

repository :: Repository Source

Creates a value of Repository with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rRepositoryARN :: Lens' Repository (Maybe Text) Source

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the 'arn:aws:ecr' namespace, followed by the region of the repository, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, 'arn:aws:ecr:region:012345678910:repository\/test'.

rRegistryId :: Lens' Repository (Maybe Text) Source

The AWS account ID associated with the registry that contains the repository.

rRepositoryName :: Lens' Repository (Maybe Text) Source

The name of the repository.

ImageNotFound
ImageTagDoesNotMatchDigest
InvalidImageDigest
InvalidImageTag
MissingDigestAndTag

Bounded ImageFailureCode Source
Enum ImageFailureCode Source
Eq ImageFailureCode Source
Data ImageFailureCode Source
Ord ImageFailureCode Source
Read ImageFailureCode Source
Show ImageFailureCode Source
Generic ImageFailureCode Source
FromJSON ImageFailureCode Source
Hashable ImageFailureCode Source
ToHeader ImageFailureCode Source
ToQuery ImageFailureCode Source
ToByteString ImageFailureCode Source
FromText ImageFailureCode Source
ToText ImageFailureCode Source
type Rep ImageFailureCode Source

Bounded LayerAvailability Source
Enum LayerAvailability Source
Eq LayerAvailability Source
Data LayerAvailability Source
Ord LayerAvailability Source
Read LayerAvailability Source
Show LayerAvailability Source
Generic LayerAvailability Source
FromJSON LayerAvailability Source
Hashable LayerAvailability Source
ToHeader LayerAvailability Source
ToQuery LayerAvailability Source
ToByteString LayerAvailability Source
FromText LayerAvailability Source
ToText LayerAvailability Source
type Rep LayerAvailability Source

Bounded LayerFailureCode Source
Enum LayerFailureCode Source
Eq LayerFailureCode Source
Data LayerFailureCode Source
Ord LayerFailureCode Source
Read LayerFailureCode Source
Show LayerFailureCode Source
Generic LayerFailureCode Source
FromJSON LayerFailureCode Source
Hashable LayerFailureCode Source
ToHeader LayerFailureCode Source
ToQuery LayerFailureCode Source
ToByteString LayerFailureCode Source
FromText LayerFailureCode Source
ToText LayerFailureCode Source
type Rep LayerFailureCode Source

Eq AuthorizationData Source
Data AuthorizationData Source
Read AuthorizationData Source
Show AuthorizationData Source
Generic AuthorizationData Source
FromJSON AuthorizationData Source
Hashable AuthorizationData Source
type Rep AuthorizationData Source

Eq ImageFailure Source
Data ImageFailure Source
Read ImageFailure Source
Show ImageFailure Source
Generic ImageFailure Source
FromJSON ImageFailure Source
Hashable ImageFailure Source
type Rep ImageFailure Source

Eq ImageIdentifier Source
Data ImageIdentifier Source
Read ImageIdentifier Source
Show ImageIdentifier Source
Generic ImageIdentifier Source
ToJSON ImageIdentifier Source
FromJSON ImageIdentifier Source
Hashable ImageIdentifier Source
type Rep ImageIdentifier Source

Eq LayerFailure Source
Data LayerFailure Source
Read LayerFailure Source
Show LayerFailure Source
Generic LayerFailure Source
FromJSON LayerFailure Source
Hashable LayerFailure Source
type Rep LayerFailure Source

Eq Repository Source
Data Repository Source
Read Repository Source
Show Repository Source
Generic Repository Source
FromJSON Repository Source
Hashable Repository Source
type Rep Repository Source