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 |
- Service Configuration
- Errors
- LayersNotFoundException
- InvalidParameterException
- LayerAlreadyExistsException
- ServerException
- LayerInaccessibleException
- InvalidLayerException
- LayerPartTooSmallException
- ImageNotFoundException
- ImageAlreadyExistsException
- RepositoryNotFoundException
- UploadNotFoundException
- InvalidLayerPartException
- RepositoryNotEmptyException
- RepositoryAlreadyExistsException
- RepositoryPolicyNotFoundException
- EmptyUploadException
- LimitExceededException
- Waiters
- Operations
- GetRepositoryPolicy
- BatchDeleteImage
- BatchCheckLayerAvailability
- DeleteRepositoryPolicy
- CreateRepository
- CompleteLayerUpload
- DescribeRepositories (Paginated)
- UploadLayerPart
- BatchGetImage
- SetRepositoryPolicy
- InitiateLayerUpload
- DeleteRepository
- PutImage
- ListImages (Paginated)
- GetAuthorizationToken
- GetDownloadURLForLayer
- DescribeImages (Paginated)
- Types
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.
- ecr :: Service
- _LayersNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _LayerAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _LayerInaccessibleException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLayerException :: AsError a => Getting (First ServiceError) a ServiceError
- _LayerPartTooSmallException :: AsError a => Getting (First ServiceError) a ServiceError
- _ImageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ImageAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _RepositoryNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UploadNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLayerPartException :: AsError a => Getting (First ServiceError) a ServiceError
- _RepositoryNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError
- _RepositoryAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _RepositoryPolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _EmptyUploadException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.ECR.GetRepositoryPolicy
- module Network.AWS.ECR.BatchDeleteImage
- module Network.AWS.ECR.BatchCheckLayerAvailability
- module Network.AWS.ECR.DeleteRepositoryPolicy
- module Network.AWS.ECR.CreateRepository
- module Network.AWS.ECR.CompleteLayerUpload
- module Network.AWS.ECR.DescribeRepositories
- module Network.AWS.ECR.UploadLayerPart
- module Network.AWS.ECR.BatchGetImage
- module Network.AWS.ECR.SetRepositoryPolicy
- module Network.AWS.ECR.InitiateLayerUpload
- module Network.AWS.ECR.DeleteRepository
- module Network.AWS.ECR.PutImage
- module Network.AWS.ECR.ListImages
- module Network.AWS.ECR.GetAuthorizationToken
- module Network.AWS.ECR.GetDownloadURLForLayer
- module Network.AWS.ECR.DescribeImages
- data ImageFailureCode
- data LayerAvailability
- data LayerFailureCode
- data TagStatus
- data AuthorizationData
- authorizationData :: AuthorizationData
- adExpiresAt :: Lens' AuthorizationData (Maybe UTCTime)
- adProxyEndpoint :: Lens' AuthorizationData (Maybe Text)
- adAuthorizationToken :: Lens' AuthorizationData (Maybe Text)
- data DescribeImagesFilter
- describeImagesFilter :: DescribeImagesFilter
- difTagStatus :: Lens' DescribeImagesFilter (Maybe TagStatus)
- data Image
- image :: Image
- iRegistryId :: Lens' Image (Maybe Text)
- iImageId :: Lens' Image (Maybe ImageIdentifier)
- iRepositoryName :: Lens' Image (Maybe Text)
- iImageManifest :: Lens' Image (Maybe Text)
- data ImageDetail
- imageDetail :: ImageDetail
- idRegistryId :: Lens' ImageDetail (Maybe Text)
- idImageTags :: Lens' ImageDetail [Text]
- idImageSizeInBytes :: Lens' ImageDetail (Maybe Integer)
- idImageDigest :: Lens' ImageDetail (Maybe Text)
- idImagePushedAt :: Lens' ImageDetail (Maybe UTCTime)
- idRepositoryName :: Lens' ImageDetail (Maybe Text)
- data ImageFailure
- imageFailure :: ImageFailure
- ifFailureReason :: Lens' ImageFailure (Maybe Text)
- ifFailureCode :: Lens' ImageFailure (Maybe ImageFailureCode)
- ifImageId :: Lens' ImageFailure (Maybe ImageIdentifier)
- data ImageIdentifier
- imageIdentifier :: ImageIdentifier
- iiImageDigest :: Lens' ImageIdentifier (Maybe Text)
- iiImageTag :: Lens' ImageIdentifier (Maybe Text)
- data Layer
- layer :: Layer
- lLayerDigest :: Lens' Layer (Maybe Text)
- lLayerSize :: Lens' Layer (Maybe Integer)
- lLayerAvailability :: Lens' Layer (Maybe LayerAvailability)
- data LayerFailure
- layerFailure :: LayerFailure
- lfFailureReason :: Lens' LayerFailure (Maybe Text)
- lfFailureCode :: Lens' LayerFailure (Maybe LayerFailureCode)
- lfLayerDigest :: Lens' LayerFailure (Maybe Text)
- data ListImagesFilter
- listImagesFilter :: ListImagesFilter
- lifTagStatus :: Lens' ListImagesFilter (Maybe TagStatus)
- data Repository
- repository :: Repository
- rRepositoryARN :: Lens' Repository (Maybe Text)
- rCreatedAt :: Lens' Repository (Maybe UTCTime)
- rRegistryId :: Lens' Repository (Maybe Text)
- rRepositoryURI :: Lens' Repository (Maybe Text)
- rRepositoryName :: Lens' Repository (Maybe Text)
Service Configuration
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.
ImageNotFoundException
_ImageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The image requested does not exist in the specified repository.
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
BatchDeleteImage
BatchCheckLayerAvailability
DeleteRepositoryPolicy
CreateRepository
CompleteLayerUpload
DescribeRepositories (Paginated)
UploadLayerPart
BatchGetImage
SetRepositoryPolicy
InitiateLayerUpload
DeleteRepository
PutImage
module Network.AWS.ECR.PutImage
ListImages (Paginated)
module Network.AWS.ECR.ListImages
GetAuthorizationToken
GetDownloadURLForLayer
DescribeImages (Paginated)
Types
ImageFailureCode
data ImageFailureCode Source #
LayerAvailability
data LayerAvailability Source #
LayerFailureCode
data LayerFailureCode Source #
TagStatus
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
- The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.adProxyEndpoint
- The registry URL to use for this authorization token in adocker login
command. The Amazon ECR registry URL format ishttps://aws_account_id.dkr.ecr.region.amazonaws.com
. For example,https://012345678910.dkr.ecr.us-east-1.amazonaws.com
..adAuthorizationToken
- A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the formatuser:password
for private registry authentication usingdocker login
.
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
.
DescribeImagesFilter
data DescribeImagesFilter Source #
An object representing a filter on a DescribeImages
operation.
See: describeImagesFilter
smart constructor.
describeImagesFilter :: DescribeImagesFilter Source #
Creates a value of DescribeImagesFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
difTagStatus
- The tag status with which to filter yourDescribeImages
results. You can filter results based on whether they areTAGGED
orUNTAGGED
.
difTagStatus :: Lens' DescribeImagesFilter (Maybe TagStatus) Source #
The tag status with which to filter your DescribeImages
results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
Image
An object representing an Amazon ECR image.
See: image
smart constructor.
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
- The AWS account ID associated with the registry containing the image.iImageId
- An object containing the image tag and image digest associated with an image.iRepositoryName
- The name of the repository associated with the image.iImageManifest
- The image manifest associated with the image.
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.
ImageDetail
data ImageDetail Source #
An object that describes an image returned by a DescribeImages
operation.
See: imageDetail
smart constructor.
imageDetail :: ImageDetail Source #
Creates a value of ImageDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idRegistryId
- The AWS account ID associated with the registry to which this image belongs.idImageTags
- The list of tags associated with this image.idImageSizeInBytes
- The size, in bytes, of the image in the repository.idImageDigest
- Thesha256
digest of the image manifest.idImagePushedAt
- The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.idRepositoryName
- The name of the repository to which this image belongs.
idRegistryId :: Lens' ImageDetail (Maybe Text) Source #
The AWS account ID associated with the registry to which this image belongs.
idImageTags :: Lens' ImageDetail [Text] Source #
The list of tags associated with this image.
idImageSizeInBytes :: Lens' ImageDetail (Maybe Integer) Source #
The size, in bytes, of the image in the repository.
idImageDigest :: Lens' ImageDetail (Maybe Text) Source #
The sha256
digest of the image manifest.
idImagePushedAt :: Lens' ImageDetail (Maybe UTCTime) Source #
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
idRepositoryName :: Lens' ImageDetail (Maybe Text) Source #
The name of the repository to which this image belongs.
ImageFailure
data ImageFailure Source #
An object representing an Amazon ECR image failure.
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
- The reason for the failure.ifFailureCode
- The code associated with the failure.ifImageId
- The image ID associated with the failure.
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 #
An object with identifying information for an Amazon ECR image.
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
- Thesha256
digest of the image manifest.iiImageTag
- The tag used for the image.
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
An object representing an Amazon ECR image layer.
See: layer
smart constructor.
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
- Thesha256
digest of the image layer.lLayerSize
- The size, in bytes, of the image layer.lLayerAvailability
- The availability status of the image layer. Valid values areAVAILABLE
andUNAVAILABLE
.
lLayerAvailability :: Lens' Layer (Maybe LayerAvailability) Source #
The availability status of the image layer. Valid values are AVAILABLE
and UNAVAILABLE
.
LayerFailure
data LayerFailure Source #
An object representing an Amazon ECR image layer failure.
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
- The reason for the failure.lfFailureCode
- The failure code associated with the failure.lfLayerDigest
- The layer digest associated with the failure.
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.
ListImagesFilter
data ListImagesFilter Source #
An object representing a filter on a ListImages
operation.
See: listImagesFilter
smart constructor.
listImagesFilter :: ListImagesFilter Source #
Creates a value of ListImagesFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lifTagStatus
- The tag status with which to filter yourListImages
results. You can filter results based on whether they areTAGGED
orUNTAGGED
.
lifTagStatus :: Lens' ListImagesFilter (Maybe TagStatus) Source #
The tag status with which to filter your ListImages
results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
Repository
data Repository Source #
An 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
- The Amazon Resource Name (ARN) that identifies the repository. The ARN contains thearn: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
.rCreatedAt
- The date and time, in JavaScript date/time format, when the repository was created.rRegistryId
- The AWS account ID associated with the registry that contains the repository.rRepositoryURI
- The URI for the repository. You can use this URI for Dockerpush
andpull
operations.rRepositoryName
- The name of the repository.
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
.
rCreatedAt :: Lens' Repository (Maybe UTCTime) Source #
The date and time, in JavaScript date/time format, when the repository was created.
rRegistryId :: Lens' Repository (Maybe Text) Source #
The AWS account ID associated with the registry that contains the repository.
rRepositoryURI :: Lens' Repository (Maybe Text) Source #
The URI for the repository. You can use this URI for Docker push
and pull
operations.
rRepositoryName :: Lens' Repository (Maybe Text) Source #
The name of the repository.