5.0.0 • Published 7 years ago
@datafire/amazonaws_ecr v5.0.0
@datafire/amazonaws_ecr
Client library for Amazon EC2 Container Registry
Installation and Usage
npm install --save @datafire/amazonaws_ecr
let amazonaws_ecr = require('@datafire/amazonaws_ecr').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_ecr.BatchCheckLayerAvailability({
"repositoryName": "",
"layerDigests": []
}).then(data => {
console.log(data);
});
Description
Amazon EC2 Container Registry (Amazon ECR) is a managed 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 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.
Actions
BatchCheckLayerAvailability
amazonaws_ecr.BatchCheckLayerAvailability({
"repositoryName": "",
"layerDigests": []
}, context)
Input
- input
object
- layerDigests required BatchedOperationLayerDigestList
- registryId RegistryId
- repositoryName required RepositoryName
Output
BatchDeleteImage
amazonaws_ecr.BatchDeleteImage({
"repositoryName": "",
"imageIds": []
}, context)
Input
- input
object
- imageIds required ImageIdentifierList
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output BatchDeleteImageResponse
BatchGetImage
amazonaws_ecr.BatchGetImage({
"repositoryName": "",
"imageIds": []
}, context)
Input
- input
object
- acceptedMediaTypes MediaTypeList
- imageIds required ImageIdentifierList
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output BatchGetImageResponse
CompleteLayerUpload
amazonaws_ecr.CompleteLayerUpload({
"repositoryName": "",
"uploadId": "",
"layerDigests": []
}, context)
Input
- input
object
- layerDigests required LayerDigestList
- registryId RegistryId
- repositoryName required RepositoryName
- uploadId required UploadId
Output
- output CompleteLayerUploadResponse
CreateRepository
amazonaws_ecr.CreateRepository({
"repositoryName": ""
}, context)
Input
- input
object
- repositoryName required RepositoryName
Output
- output CreateRepositoryResponse
DeleteLifecyclePolicy
amazonaws_ecr.DeleteLifecyclePolicy({
"repositoryName": ""
}, context)
Input
- input
object
- registryId RegistryId
- repositoryName required RepositoryName
Output
DeleteRepository
amazonaws_ecr.DeleteRepository({
"repositoryName": ""
}, context)
Input
- input
object
- force ForceFlag
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output DeleteRepositoryResponse
DeleteRepositoryPolicy
amazonaws_ecr.DeleteRepositoryPolicy({
"repositoryName": ""
}, context)
Input
- input
object
- registryId RegistryId
- repositoryName required RepositoryName
Output
DescribeImages
amazonaws_ecr.DescribeImages({
"repositoryName": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- filter DescribeImagesFilter
- imageIds ImageIdentifierList
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
- maxResults
Output
- output DescribeImagesResponse
DescribeRepositories
amazonaws_ecr.DescribeRepositories({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryNames RepositoryNameList
- maxResults
Output
- output DescribeRepositoriesResponse
GetAuthorizationToken
amazonaws_ecr.GetAuthorizationToken({}, context)
Input
- input
object
- registryIds GetAuthorizationTokenRegistryIdList
Output
GetDownloadUrlForLayer
amazonaws_ecr.GetDownloadUrlForLayer({
"repositoryName": "",
"layerDigest": ""
}, context)
Input
- input
object
- layerDigest required LayerDigest
- registryId RegistryId
- repositoryName required RepositoryName
Output
GetLifecyclePolicy
amazonaws_ecr.GetLifecyclePolicy({
"repositoryName": ""
}, context)
Input
- input
object
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output GetLifecyclePolicyResponse
GetLifecyclePolicyPreview
amazonaws_ecr.GetLifecyclePolicyPreview({
"repositoryName": ""
}, context)
Input
- input
object
- filter LifecyclePolicyPreviewFilter
- imageIds ImageIdentifierList
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
Output
GetRepositoryPolicy
amazonaws_ecr.GetRepositoryPolicy({
"repositoryName": ""
}, context)
Input
- input
object
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output GetRepositoryPolicyResponse
InitiateLayerUpload
amazonaws_ecr.InitiateLayerUpload({
"repositoryName": ""
}, context)
Input
- input
object
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output InitiateLayerUploadResponse
ListImages
amazonaws_ecr.ListImages({
"repositoryName": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- filter ListImagesFilter
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
- maxResults
Output
- output ListImagesResponse
PutImage
amazonaws_ecr.PutImage({
"repositoryName": "",
"imageManifest": ""
}, context)
Input
- input
object
- imageManifest required ImageManifest
- imageTag ImageTag
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output PutImageResponse
PutLifecyclePolicy
amazonaws_ecr.PutLifecyclePolicy({
"repositoryName": "",
"lifecyclePolicyText": ""
}, context)
Input
- input
object
- lifecyclePolicyText required LifecyclePolicyText
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output PutLifecyclePolicyResponse
SetRepositoryPolicy
amazonaws_ecr.SetRepositoryPolicy({
"repositoryName": "",
"policyText": ""
}, context)
Input
- input
object
- force ForceFlag
- policyText required RepositoryPolicyText
- registryId RegistryId
- repositoryName required RepositoryName
Output
- output SetRepositoryPolicyResponse
StartLifecyclePolicyPreview
amazonaws_ecr.StartLifecyclePolicyPreview({
"repositoryName": ""
}, context)
Input
- input
object
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName required RepositoryName
Output
UploadLayerPart
amazonaws_ecr.UploadLayerPart({
"repositoryName": "",
"uploadId": "",
"partFirstByte": 0,
"partLastByte": 0,
"layerPartBlob": ""
}, context)
Input
- input
object
- layerPartBlob required LayerPartBlob
- partFirstByte required PartSize
- partLastByte required PartSize
- registryId RegistryId
- repositoryName required RepositoryName
- uploadId required UploadId
Output
- output UploadLayerPartResponse
Definitions
Arn
- Arn
string
AuthorizationData
- AuthorizationData
object
: An object representing authorization data for an Amazon ECR registry.- authorizationToken Base64
- expiresAt ExpirationTimestamp
- proxyEndpoint ProxyEndpoint
AuthorizationDataList
- AuthorizationDataList
array
- items AuthorizationData
Base64
- Base64
string
BatchCheckLayerAvailabilityRequest
- BatchCheckLayerAvailabilityRequest
object
- layerDigests required BatchedOperationLayerDigestList
- registryId RegistryId
- repositoryName required RepositoryName
BatchCheckLayerAvailabilityResponse
- BatchCheckLayerAvailabilityResponse
object
- failures LayerFailureList
- layers LayerList
BatchDeleteImageRequest
- BatchDeleteImageRequest
object
: Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.- imageIds required ImageIdentifierList
- registryId RegistryId
- repositoryName required RepositoryName
BatchDeleteImageResponse
- BatchDeleteImageResponse
object
- failures ImageFailureList
- imageIds ImageIdentifierList
BatchGetImageRequest
- BatchGetImageRequest
object
- acceptedMediaTypes MediaTypeList
- imageIds required ImageIdentifierList
- registryId RegistryId
- repositoryName required RepositoryName
BatchGetImageResponse
- BatchGetImageResponse
object
- failures ImageFailureList
- images ImageList
BatchedOperationLayerDigest
- BatchedOperationLayerDigest
string
BatchedOperationLayerDigestList
- BatchedOperationLayerDigestList
array
CompleteLayerUploadRequest
- CompleteLayerUploadRequest
object
- layerDigests required LayerDigestList
- registryId RegistryId
- repositoryName required RepositoryName
- uploadId required UploadId
CompleteLayerUploadResponse
- CompleteLayerUploadResponse
object
- layerDigest LayerDigest
- registryId RegistryId
- repositoryName RepositoryName
- uploadId UploadId
CreateRepositoryRequest
- CreateRepositoryRequest
object
- repositoryName required RepositoryName
CreateRepositoryResponse
- CreateRepositoryResponse
object
- repository Repository
CreationTimestamp
- CreationTimestamp
string
DeleteLifecyclePolicyRequest
- DeleteLifecyclePolicyRequest
object
- registryId RegistryId
- repositoryName required RepositoryName
DeleteLifecyclePolicyResponse
- DeleteLifecyclePolicyResponse
object
- lastEvaluatedAt EvaluationTimestamp
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName RepositoryName
DeleteRepositoryPolicyRequest
- DeleteRepositoryPolicyRequest
object
- registryId RegistryId
- repositoryName required RepositoryName
DeleteRepositoryPolicyResponse
- DeleteRepositoryPolicyResponse
object
- policyText RepositoryPolicyText
- registryId RegistryId
- repositoryName RepositoryName
DeleteRepositoryRequest
- DeleteRepositoryRequest
object
- force ForceFlag
- registryId RegistryId
- repositoryName required RepositoryName
DeleteRepositoryResponse
- DeleteRepositoryResponse
object
- repository Repository
DescribeImagesFilter
- DescribeImagesFilter
object
: An object representing a filter on a DescribeImages operation.- tagStatus TagStatus
DescribeImagesRequest
- DescribeImagesRequest
object
- filter DescribeImagesFilter
- imageIds ImageIdentifierList
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
DescribeImagesResponse
- DescribeImagesResponse
object
- imageDetails ImageDetailList
- nextToken NextToken
DescribeRepositoriesRequest
- DescribeRepositoriesRequest
object
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryNames RepositoryNameList
DescribeRepositoriesResponse
- DescribeRepositoriesResponse
object
- nextToken NextToken
- repositories RepositoryList
EmptyUploadException
- EmptyUploadException
object
: The specified layer upload does not contain any layer parts.- message ExceptionMessage
EvaluationTimestamp
- EvaluationTimestamp
string
ExceptionMessage
- ExceptionMessage
string
ExpirationTimestamp
- ExpirationTimestamp
string
ForceFlag
- ForceFlag
boolean
GetAuthorizationTokenRegistryIdList
- GetAuthorizationTokenRegistryIdList
array
- items RegistryId
GetAuthorizationTokenRequest
- GetAuthorizationTokenRequest
object
- registryIds GetAuthorizationTokenRegistryIdList
GetAuthorizationTokenResponse
- GetAuthorizationTokenResponse
object
- authorizationData AuthorizationDataList
GetDownloadUrlForLayerRequest
- GetDownloadUrlForLayerRequest
object
- layerDigest required LayerDigest
- registryId RegistryId
- repositoryName required RepositoryName
GetDownloadUrlForLayerResponse
- GetDownloadUrlForLayerResponse
object
- downloadUrl Url
- layerDigest LayerDigest
GetLifecyclePolicyPreviewRequest
- GetLifecyclePolicyPreviewRequest
object
- filter LifecyclePolicyPreviewFilter
- imageIds ImageIdentifierList
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
GetLifecyclePolicyPreviewResponse
- GetLifecyclePolicyPreviewResponse
object
- lifecyclePolicyText LifecyclePolicyText
- nextToken NextToken
- previewResults LifecyclePolicyPreviewResultList
- registryId RegistryId
- repositoryName RepositoryName
- status LifecyclePolicyPreviewStatus
- summary LifecyclePolicyPreviewSummary
GetLifecyclePolicyRequest
- GetLifecyclePolicyRequest
object
- registryId RegistryId
- repositoryName required RepositoryName
GetLifecyclePolicyResponse
- GetLifecyclePolicyResponse
object
- lastEvaluatedAt EvaluationTimestamp
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName RepositoryName
GetRepositoryPolicyRequest
- GetRepositoryPolicyRequest
object
- registryId RegistryId
- repositoryName required RepositoryName
GetRepositoryPolicyResponse
- GetRepositoryPolicyResponse
object
- policyText RepositoryPolicyText
- registryId RegistryId
- repositoryName RepositoryName
Image
- Image
object
: An object representing an Amazon ECR image.- imageId ImageIdentifier
- imageManifest ImageManifest
- registryId RegistryId
- repositoryName RepositoryName
ImageActionType
- ImageActionType
string
(values: EXPIRE)
ImageAlreadyExistsException
- ImageAlreadyExistsException
object
: The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.- message ExceptionMessage
ImageCount
- ImageCount
integer
ImageDetail
- ImageDetail
object
: An object that describes an image returned by a DescribeImages operation.- imageDigest ImageDigest
- imagePushedAt PushTimestamp
- imageSizeInBytes ImageSizeInBytes
- imageTags ImageTagList
- registryId RegistryId
- repositoryName RepositoryName
ImageDetailList
- ImageDetailList
array
- items ImageDetail
ImageDigest
- ImageDigest
string
ImageFailure
- ImageFailure
object
: An object representing an Amazon ECR image failure.- failureCode ImageFailureCode
- failureReason ImageFailureReason
- imageId ImageIdentifier
ImageFailureCode
- ImageFailureCode
string
(values: InvalidImageDigest, InvalidImageTag, ImageTagDoesNotMatchDigest, ImageNotFound, MissingDigestAndTag)
ImageFailureList
- ImageFailureList
array
- items ImageFailure
ImageFailureReason
- ImageFailureReason
string
ImageIdentifier
- ImageIdentifier
object
: An object with identifying information for an Amazon ECR image.- imageDigest ImageDigest
- imageTag ImageTag
ImageIdentifierList
- ImageIdentifierList
array
- items ImageIdentifier
ImageList
- ImageList
array
- items Image
ImageManifest
- ImageManifest
string
ImageNotFoundException
- ImageNotFoundException
object
: The image requested does not exist in the specified repository.- message ExceptionMessage
ImageSizeInBytes
- ImageSizeInBytes
integer
ImageTag
- ImageTag
string
ImageTagList
- ImageTagList
array
- items ImageTag
InitiateLayerUploadRequest
- InitiateLayerUploadRequest
object
- registryId RegistryId
- repositoryName required RepositoryName
InitiateLayerUploadResponse
InvalidLayerException
- InvalidLayerException
object
: The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.- message ExceptionMessage
InvalidLayerPartException
- InvalidLayerPartException
object
: 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.- lastValidByteReceived PartSize
- message ExceptionMessage
- registryId RegistryId
- repositoryName RepositoryName
- uploadId UploadId
InvalidParameterException
- InvalidParameterException
object
: The specified parameter is invalid. Review the available parameters for the API request.- message ExceptionMessage
Layer
- Layer
object
: An object representing an Amazon ECR image layer.- layerAvailability LayerAvailability
- layerDigest LayerDigest
- layerSize LayerSizeInBytes
- mediaType MediaType
LayerAlreadyExistsException
- LayerAlreadyExistsException
object
: The image layer already exists in the associated repository.- message ExceptionMessage
LayerAvailability
- LayerAvailability
string
(values: AVAILABLE, UNAVAILABLE)
LayerDigest
- LayerDigest
string
LayerDigestList
- LayerDigestList
array
- items LayerDigest
LayerFailure
- LayerFailure
object
: An object representing an Amazon ECR image layer failure.- failureCode LayerFailureCode
- failureReason LayerFailureReason
- layerDigest BatchedOperationLayerDigest
LayerFailureCode
- LayerFailureCode
string
(values: InvalidLayerDigest, MissingLayerDigest)
LayerFailureList
- LayerFailureList
array
- items LayerFailure
LayerFailureReason
- LayerFailureReason
string
LayerInaccessibleException
- LayerInaccessibleException
object
: The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.- message ExceptionMessage
LayerList
- LayerList
array
- items Layer
LayerPartBlob
- LayerPartBlob
string
LayerPartTooSmallException
- LayerPartTooSmallException
object
: Layer parts must be at least 5 MiB in size.- message ExceptionMessage
LayerSizeInBytes
- LayerSizeInBytes
integer
LayersNotFoundException
- LayersNotFoundException
object
: The specified layers could not be found, or the specified layer is not valid for this repository.- message ExceptionMessage
LifecyclePolicyNotFoundException
- LifecyclePolicyNotFoundException
object
: The lifecycle policy could not be found, and no policy is set to the repository.- message ExceptionMessage
LifecyclePolicyPreviewFilter
- LifecyclePolicyPreviewFilter
object
: The filter for the lifecycle policy preview.- tagStatus TagStatus
LifecyclePolicyPreviewInProgressException
- LifecyclePolicyPreviewInProgressException
object
: The previous lifecycle policy preview request has not completed. Please try again later.- message ExceptionMessage
LifecyclePolicyPreviewNotFoundException
- LifecyclePolicyPreviewNotFoundException
object
: There is no dry run for this repository.- message ExceptionMessage
LifecyclePolicyPreviewResult
- LifecyclePolicyPreviewResult
object
: The result of the lifecycle policy preview.- action LifecyclePolicyRuleAction
- appliedRulePriority LifecyclePolicyRulePriority
- imageDigest ImageDigest
- imagePushedAt PushTimestamp
- imageTags ImageTagList
LifecyclePolicyPreviewResultList
- LifecyclePolicyPreviewResultList
array
LifecyclePolicyPreviewStatus
- LifecyclePolicyPreviewStatus
string
(values: IN_PROGRESS, COMPLETE, EXPIRED, FAILED)
LifecyclePolicyPreviewSummary
- LifecyclePolicyPreviewSummary
object
: The summary of the lifecycle policy preview request.- expiringImageTotalCount ImageCount
LifecyclePolicyRuleAction
- LifecyclePolicyRuleAction
object
: The type of action to be taken.- type ImageActionType
LifecyclePolicyRulePriority
- LifecyclePolicyRulePriority
integer
LifecyclePolicyText
- LifecyclePolicyText
string
LimitExceededException
- LimitExceededException
object
: 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.- message ExceptionMessage
ListImagesFilter
- ListImagesFilter
object
: An object representing a filter on a ListImages operation.- tagStatus TagStatus
ListImagesRequest
- ListImagesRequest
object
- filter ListImagesFilter
- maxResults MaxResults
- nextToken NextToken
- registryId RegistryId
- repositoryName required RepositoryName
ListImagesResponse
- ListImagesResponse
object
- imageIds ImageIdentifierList
- nextToken NextToken
MaxResults
- MaxResults
integer
MediaType
- MediaType
string
MediaTypeList
- MediaTypeList
array
- items MediaType
NextToken
- NextToken
string
PartSize
- PartSize
integer
ProxyEndpoint
- ProxyEndpoint
string
PushTimestamp
- PushTimestamp
string
PutImageRequest
- PutImageRequest
object
- imageManifest required ImageManifest
- imageTag ImageTag
- registryId RegistryId
- repositoryName required RepositoryName
PutImageResponse
- PutImageResponse
object
- image Image
PutLifecyclePolicyRequest
- PutLifecyclePolicyRequest
object
- lifecyclePolicyText required LifecyclePolicyText
- registryId RegistryId
- repositoryName required RepositoryName
PutLifecyclePolicyResponse
- PutLifecyclePolicyResponse
object
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName RepositoryName
RegistryId
- RegistryId
string
Repository
- Repository
object
: An object representing a repository.- createdAt CreationTimestamp
- registryId RegistryId
- repositoryArn Arn
- repositoryName RepositoryName
- repositoryUri Url
RepositoryAlreadyExistsException
- RepositoryAlreadyExistsException
object
: The specified repository already exists in the specified registry.- message ExceptionMessage
RepositoryList
- RepositoryList
array
- items Repository
RepositoryName
- RepositoryName
string
RepositoryNameList
- RepositoryNameList
array
- items RepositoryName
RepositoryNotEmptyException
- RepositoryNotEmptyException
object
: The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.- message ExceptionMessage
RepositoryNotFoundException
- RepositoryNotFoundException
object
: 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.- message ExceptionMessage
RepositoryPolicyNotFoundException
- RepositoryPolicyNotFoundException
object
: The specified repository and registry combination does not have an associated repository policy.- message ExceptionMessage
RepositoryPolicyText
- RepositoryPolicyText
string
ServerException
- ServerException
object
: These errors are usually caused by a server-side issue.- message ExceptionMessage
SetRepositoryPolicyRequest
- SetRepositoryPolicyRequest
object
- force ForceFlag
- policyText required RepositoryPolicyText
- registryId RegistryId
- repositoryName required RepositoryName
SetRepositoryPolicyResponse
- SetRepositoryPolicyResponse
object
- policyText RepositoryPolicyText
- registryId RegistryId
- repositoryName RepositoryName
StartLifecyclePolicyPreviewRequest
- StartLifecyclePolicyPreviewRequest
object
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName required RepositoryName
StartLifecyclePolicyPreviewResponse
- StartLifecyclePolicyPreviewResponse
object
- lifecyclePolicyText LifecyclePolicyText
- registryId RegistryId
- repositoryName RepositoryName
- status LifecyclePolicyPreviewStatus
TagStatus
- TagStatus
string
(values: TAGGED, UNTAGGED)
UploadId
- UploadId
string
UploadLayerPartRequest
- UploadLayerPartRequest
object
- layerPartBlob required LayerPartBlob
- partFirstByte required PartSize
- partLastByte required PartSize
- registryId RegistryId
- repositoryName required RepositoryName
- uploadId required UploadId
UploadLayerPartResponse
- UploadLayerPartResponse
object
- lastByteReceived PartSize
- registryId RegistryId
- repositoryName RepositoryName
- uploadId UploadId
UploadNotFoundException
- UploadNotFoundException
object
: The upload could not be found, or the specified upload id is not valid for this repository.- message ExceptionMessage
Url
- Url
string