@datafire/amazonaws_ecr_public NPM

@datafire/amazonaws_ecr_public

Client library for Amazon Elastic Container Registry Public

Installation and Usage

npm install --save @datafire/amazonaws_ecr_public

let amazonaws_ecr_public = require('@datafire/amazonaws_ecr_public').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Elastic Container Registry Public Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.

Actions

BatchCheckLayerAvailability

amazonaws_ecr_public.BatchCheckLayerAvailability({
  "repositoryName": null,
  "layerDigests": null
}, context)

Input

input object
- layerDigests required
  - items BatchedOperationLayerDigest
- registryId
- repositoryName required

Output

output BatchCheckLayerAvailabilityResponse

BatchDeleteImage

amazonaws_ecr_public.BatchDeleteImage({
  "repositoryName": null,
  "imageIds": null
}, context)

Input

input object
- imageIds required
  - items ImageIdentifier
- registryId
- repositoryName required

Output

output BatchDeleteImageResponse

CompleteLayerUpload

amazonaws_ecr_public.CompleteLayerUpload({
  "repositoryName": null,
  "uploadId": null,
  "layerDigests": null
}, context)

Input

input object
- layerDigests required
  - items LayerDigest
- registryId
- repositoryName required
- uploadId required

Output

output CompleteLayerUploadResponse

CreateRepository

amazonaws_ecr_public.CreateRepository({
  "repositoryName": null
}, context)

Input

input object
- catalogData
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoImageBlob
  - operatingSystems
    - items OperatingSystem
  - usageText
- repositoryName required

Output

output CreateRepositoryResponse

DeleteRepository

amazonaws_ecr_public.DeleteRepository({
  "repositoryName": null
}, context)

Input

input object
- force
- registryId
- repositoryName required

Output

output DeleteRepositoryResponse

DeleteRepositoryPolicy

amazonaws_ecr_public.DeleteRepositoryPolicy({
  "repositoryName": null
}, context)

Input

input object
- registryId
- repositoryName required

Output

output DeleteRepositoryPolicyResponse

DescribeImageTags

amazonaws_ecr_public.DescribeImageTags({
  "repositoryName": null
}, context)

Input

input object
- maxResults string
- nextToken string
- maxResults
- nextToken
- registryId
- repositoryName required

Output

output DescribeImageTagsResponse

DescribeImages

amazonaws_ecr_public.DescribeImages({
  "repositoryName": null
}, context)

Input

input object
- maxResults string
- nextToken string
- imageIds
  - items ImageIdentifier
- maxResults
- nextToken
- registryId
- repositoryName required

Output

output DescribeImagesResponse

DescribeRegistries

amazonaws_ecr_public.DescribeRegistries({}, context)

Input

input object
- maxResults string
- nextToken string
- maxResults
- nextToken

Output

output DescribeRegistriesResponse

DescribeRepositories

amazonaws_ecr_public.DescribeRepositories({}, context)

Input

input object
- maxResults string
- nextToken string
- maxResults
- nextToken
- registryId
- repositoryNames
  - items RepositoryName

Output

output DescribeRepositoriesResponse

GetAuthorizationToken

amazonaws_ecr_public.GetAuthorizationToken({}, context)

Input

input object

Output

output GetAuthorizationTokenResponse

GetRegistryCatalogData

amazonaws_ecr_public.GetRegistryCatalogData({}, context)

Input

input object

Output

output GetRegistryCatalogDataResponse

GetRepositoryCatalogData

amazonaws_ecr_public.GetRepositoryCatalogData({
  "repositoryName": null
}, context)

Input

input object
- registryId
- repositoryName required

Output

output GetRepositoryCatalogDataResponse

GetRepositoryPolicy

amazonaws_ecr_public.GetRepositoryPolicy({
  "repositoryName": null
}, context)

Input

input object
- registryId
- repositoryName required

Output

output GetRepositoryPolicyResponse

InitiateLayerUpload

amazonaws_ecr_public.InitiateLayerUpload({
  "repositoryName": null
}, context)

Input

input object
- registryId
- repositoryName required

Output

output InitiateLayerUploadResponse

PutImage

amazonaws_ecr_public.PutImage({
  "repositoryName": null,
  "imageManifest": null
}, context)

Input

input object
- imageDigest
- imageManifest required
- imageManifestMediaType
- imageTag
- registryId
- repositoryName required

Output

output PutImageResponse

PutRegistryCatalogData

amazonaws_ecr_public.PutRegistryCatalogData({}, context)

Input

input object
- displayName

Output

output PutRegistryCatalogDataResponse

PutRepositoryCatalogData

amazonaws_ecr_public.PutRepositoryCatalogData({
  "repositoryName": null,
  "catalogData": null
}, context)

Input

input object
- catalogData required
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoImageBlob
  - operatingSystems
    - items OperatingSystem
  - usageText
- registryId
- repositoryName required

Output

output PutRepositoryCatalogDataResponse

SetRepositoryPolicy

amazonaws_ecr_public.SetRepositoryPolicy({
  "repositoryName": null,
  "policyText": null
}, context)

Input

input object
- force
- policyText required
- registryId
- repositoryName required

Output

output SetRepositoryPolicyResponse

UploadLayerPart

amazonaws_ecr_public.UploadLayerPart({
  "repositoryName": null,
  "uploadId": null,
  "partFirstByte": null,
  "partLastByte": null,
  "layerPartBlob": null
}, context)

Input

input object
- layerPartBlob required
- partFirstByte required
- partLastByte required
- registryId
- repositoryName required
- uploadId required

Output

output UploadLayerPartResponse

Definitions

AboutText

AboutText string

Architecture

Architecture string

ArchitectureList

ArchitectureList array
- items Architecture

Arn

Arn string

AuthorizationData

AuthorizationData object: An authorization token data object that corresponds to a public registry.
- authorizationToken
- expiresAt

Base64

Base64 string

BatchCheckLayerAvailabilityRequest

BatchCheckLayerAvailabilityRequest object
- layerDigests required
  - items BatchedOperationLayerDigest
- registryId
- repositoryName required

BatchCheckLayerAvailabilityResponse

BatchCheckLayerAvailabilityResponse object
- failures
  - items LayerFailure
- layers
  - items Layer

BatchDeleteImageRequest

BatchDeleteImageRequest object
- imageIds required
  - items ImageIdentifier
- registryId
- repositoryName required

BatchDeleteImageResponse

BatchDeleteImageResponse object
- failures
  - items ImageFailure
- imageIds
  - items ImageIdentifier

BatchedOperationLayerDigest

BatchedOperationLayerDigest string

BatchedOperationLayerDigestList

BatchedOperationLayerDigestList array
- items BatchedOperationLayerDigest

CompleteLayerUploadRequest

CompleteLayerUploadRequest object
- layerDigests required
  - items LayerDigest
- registryId
- repositoryName required
- uploadId required

CompleteLayerUploadResponse

CompleteLayerUploadResponse object
- layerDigest
- registryId
- repositoryName
- uploadId

CreateRepositoryRequest

CreateRepositoryRequest object
- catalogData
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoImageBlob
  - operatingSystems
    - items OperatingSystem
  - usageText
- repositoryName required

CreateRepositoryResponse

CreateRepositoryResponse object
- catalogData RepositoryCatalogData
- repository
  - createdAt
  - registryId
  - repositoryArn
  - repositoryName
  - repositoryUri

CreationTimestamp

CreationTimestamp string

DefaultRegistryAliasFlag

DefaultRegistryAliasFlag boolean

DeleteRepositoryPolicyRequest

DeleteRepositoryPolicyRequest object
- registryId
- repositoryName required

DeleteRepositoryPolicyResponse

DeleteRepositoryPolicyResponse object
- policyText
- registryId
- repositoryName

DeleteRepositoryRequest

DeleteRepositoryRequest object
- force
- registryId
- repositoryName required

DeleteRepositoryResponse

DeleteRepositoryResponse object
- repository
  - createdAt
  - registryId
  - repositoryArn
  - repositoryName
  - repositoryUri

DescribeImageTagsRequest

DescribeImageTagsRequest object
- maxResults
- nextToken
- registryId
- repositoryName required

DescribeImageTagsResponse

DescribeImageTagsResponse object
- imageTagDetails
  - items ImageTagDetail
- nextToken

DescribeImagesRequest

DescribeImagesRequest object
- imageIds
  - items ImageIdentifier
- maxResults
- nextToken
- registryId
- repositoryName required

DescribeImagesResponse

DescribeImagesResponse object
- imageDetails
  - items ImageDetail
- nextToken

DescribeRegistriesRequest

DescribeRegistriesRequest object
- maxResults
- nextToken

DescribeRegistriesResponse

DescribeRegistriesResponse object
- nextToken
- registries required
  - items Registry

DescribeRepositoriesRequest

DescribeRepositoriesRequest object
- maxResults
- nextToken
- registryId
- repositoryNames
  - items RepositoryName

DescribeRepositoriesResponse

DescribeRepositoriesResponse object
- nextToken
- repositories
  - items Repository

EmptyUploadException

ExpirationTimestamp

ExpirationTimestamp string

ForceFlag

ForceFlag boolean

GetAuthorizationTokenRequest

GetAuthorizationTokenRequest object

GetAuthorizationTokenResponse

GetAuthorizationTokenResponse object
- authorizationData
  - authorizationToken
  - expiresAt

GetRegistryCatalogDataRequest

GetRegistryCatalogDataRequest object

GetRegistryCatalogDataResponse

GetRegistryCatalogDataResponse object
- registryCatalogData required
  - displayName

GetRepositoryCatalogDataRequest

GetRepositoryCatalogDataRequest object
- registryId
- repositoryName required

GetRepositoryCatalogDataResponse

GetRepositoryCatalogDataResponse object
- catalogData
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoUrl
  - marketplaceCertified
  - operatingSystems
    - items OperatingSystem
  - usageText

GetRepositoryPolicyRequest

GetRepositoryPolicyRequest object
- registryId
- repositoryName required

GetRepositoryPolicyResponse

GetRepositoryPolicyResponse object
- policyText
- registryId
- repositoryName

Image

Image object: An object representing an Amazon ECR image.
- imageId
  - imageDigest
  - imageTag
- imageManifest
- imageManifestMediaType
- registryId
- repositoryName

ImageAlreadyExistsException

ImageDetail

ImageDetail object: An object that describes an image returned by a DescribeImages operation.
- artifactMediaType
- imageDigest
- imageManifestMediaType
- imagePushedAt
- imageSizeInBytes
- imageTags
  - items ImageTag
- registryId
- repositoryName

ImageDetailList

ImageDetailList array
- items ImageDetail

ImageDigest

ImageDigest string

ImageDigestDoesNotMatchException

ImageFailure

ImageFailure object: An object representing an Amazon ECR image failure.
- failureCode
- failureReason
- imageId
  - imageDigest
  - imageTag

ImageFailureCode

ImageFailureCode string (values: InvalidImageDigest, InvalidImageTag, ImageTagDoesNotMatchDigest, ImageNotFound, MissingDigestAndTag, ImageReferencedByManifestList, KmsError)

ImageFailureList

ImageFailureList array
- items ImageFailure

ImageFailureReason

ImageFailureReason string

ImageIdentifier

ImageIdentifier object: An object with identifying information for an Amazon ECR image.
- imageDigest
- imageTag

ImageIdentifierList

ImageIdentifierList array
- items ImageIdentifier

ImageManifest

ImageManifest string

ImageNotFoundException

ImageSizeInBytes

ImageSizeInBytes integer

ImageTag

ImageTag string

ImageTagAlreadyExistsException

ImageTagDetail

ImageTagDetail object: An object representing the image tag details for an image.
- createdAt
- imageDetail
  - artifactMediaType
  - imageDigest
  - imageManifestMediaType
  - imagePushedAt
  - imageSizeInBytes
- imageTag

ImageTagDetailList

ImageTagDetailList array
- items ImageTagDetail

ImageTagList

ImageTagList array
- items ImageTag

InitiateLayerUploadRequest

InitiateLayerUploadRequest object
- registryId
- repositoryName required

InitiateLayerUploadResponse

InitiateLayerUploadResponse object
- partSize
- uploadId

InvalidLayerException

InvalidLayerPartException

InvalidParameterException

Layer

Layer object: An object representing an Amazon ECR image layer.
- layerAvailability
- layerDigest
- layerSize
- mediaType

LayerAlreadyExistsException

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
- failureReason
- layerDigest

LayerFailureCode

LayerFailureCode string (values: InvalidLayerDigest, MissingLayerDigest)

LayerFailureList

LayerFailureList array
- items LayerFailure

LayerFailureReason

LayerFailureReason string

LayerList

LayerList array
- items Layer

LayerPartBlob

LayerPartBlob string

LayerPartTooSmallException

LayerSizeInBytes

LayerSizeInBytes integer

LayersNotFoundException

LimitExceededException

LogoImageBlob

LogoImageBlob string

MarketplaceCertified

MarketplaceCertified boolean

MaxResults

MaxResults integer

MediaType

MediaType string

NextToken

NextToken string

OperatingSystem

OperatingSystem string

OperatingSystemList

OperatingSystemList array
- items OperatingSystem

PartSize

PartSize integer

PrimaryRegistryAliasFlag

PrimaryRegistryAliasFlag boolean

PushTimestamp

PushTimestamp string

PutImageRequest

PutImageRequest object
- imageDigest
- imageManifest required
- imageManifestMediaType
- imageTag
- registryId
- repositoryName required

PutImageResponse

PutImageResponse object
- image
  - imageId
    - imageDigest
    - imageTag
  - imageManifest
  - imageManifestMediaType
  - registryId
  - repositoryName

PutRegistryCatalogDataRequest

PutRegistryCatalogDataRequest object
- displayName

PutRegistryCatalogDataResponse

PutRegistryCatalogDataResponse object
- registryCatalogData required
  - displayName

PutRepositoryCatalogDataRequest

PutRepositoryCatalogDataRequest object
- catalogData required
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoImageBlob
  - operatingSystems
    - items OperatingSystem
  - usageText
- registryId
- repositoryName required

PutRepositoryCatalogDataResponse

PutRepositoryCatalogDataResponse object
- catalogData
  - aboutText
  - architectures
    - items Architecture
  - description
  - logoUrl
  - marketplaceCertified
  - operatingSystems
    - items OperatingSystem
  - usageText

ReferencedImageDetail

ReferencedImageDetail object: An object that describes the image tag details returned by a DescribeImageTags action.
- artifactMediaType
- imageDigest
- imageManifestMediaType
- imagePushedAt
- imageSizeInBytes

ReferencedImagesNotFoundException

Registry

Registry object: The details of a public registry.
- aliases required
  - items RegistryAlias
- registryArn required
- registryId required
- registryUri required
- verified required

RegistryAlias

RegistryAlias object: An object representing the aliases for a public registry. A public registry is given an alias upon creation but a custom alias can be set using the Amazon ECR console. For more information, see Registries in the Amazon Elastic Container Registry User Guide.
- defaultRegistryAlias required
- name required
- primaryRegistryAlias required
- status required

RegistryAliasList

RegistryAliasList array
- items RegistryAlias

RegistryAliasName

RegistryAliasName string

RegistryAliasStatus

RegistryAliasStatus string (values: ACTIVE, PENDING, REJECTED)

RegistryCatalogData

RegistryCatalogData object: The metadata for a public registry.
- displayName

RegistryDisplayName

RegistryDisplayName string

RegistryId

RegistryId string

RegistryIdOrAlias

RegistryIdOrAlias string

RegistryList

RegistryList array
- items Registry

RegistryNotFoundException

RegistryVerified

RegistryVerified boolean

Repository

Repository object: An object representing a repository.
- createdAt
- registryId
- repositoryArn
- repositoryName
- repositoryUri

RepositoryAlreadyExistsException

RepositoryCatalogData

RepositoryCatalogData object: The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
- aboutText
- architectures
  - items Architecture
- description
- logoUrl
- marketplaceCertified
- operatingSystems
  - items OperatingSystem
- usageText

RepositoryCatalogDataInput

RepositoryCatalogDataInput object: An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
- aboutText
- architectures
  - items Architecture
- description
- logoImageBlob
- operatingSystems
  - items OperatingSystem
- usageText

RepositoryDescription

RepositoryDescription string

RepositoryList

RepositoryList array
- items Repository

RepositoryName

RepositoryName string

RepositoryNameList

RepositoryNameList array
- items RepositoryName

RepositoryNotEmptyException

RepositoryNotFoundException

RepositoryPolicyNotFoundException

RepositoryPolicyText

RepositoryPolicyText string

ResourceUrl

ResourceUrl string

ServerException

SetRepositoryPolicyRequest

SetRepositoryPolicyRequest object
- force
- policyText required
- registryId
- repositoryName required

SetRepositoryPolicyResponse

SetRepositoryPolicyResponse object
- policyText
- registryId
- repositoryName

UnsupportedCommandException

UploadId

UploadId string

UploadLayerPartRequest

UploadLayerPartRequest object
- layerPartBlob required
- partFirstByte required
- partLastByte required
- registryId
- repositoryName required
- uploadId required

UploadLayerPartResponse

UploadLayerPartResponse object
- lastByteReceived
- registryId
- repositoryName
- uploadId

UploadNotFoundException

Url

Url string

UsageText

UsageText string

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago