Skip to content

Type definitions#

Index > ECRPublic > Type definitions

Auto-generated documentation for ECRPublic type annotations stubs module mypy-boto3-ecr-public.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AuthorizationDataTypeDef#

# AuthorizationDataTypeDef definition

class AuthorizationDataTypeDef(TypedDict):
    authorizationToken: NotRequired[str],
    expiresAt: NotRequired[datetime],

BatchCheckLayerAvailabilityRequestRequestTypeDef#

# BatchCheckLayerAvailabilityRequestRequestTypeDef definition

class BatchCheckLayerAvailabilityRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    layerDigests: Sequence[str],
    registryId: NotRequired[str],

LayerFailureTypeDef#

# LayerFailureTypeDef definition

class LayerFailureTypeDef(TypedDict):
    layerDigest: NotRequired[str],
    failureCode: NotRequired[LayerFailureCodeType],  # (1)
    failureReason: NotRequired[str],
  1. See LayerFailureCodeType

LayerTypeDef#

# LayerTypeDef definition

class LayerTypeDef(TypedDict):
    layerDigest: NotRequired[str],
    layerAvailability: NotRequired[LayerAvailabilityType],  # (1)
    layerSize: NotRequired[int],
    mediaType: NotRequired[str],
  1. See LayerAvailabilityType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ImageIdentifierTypeDef#

# ImageIdentifierTypeDef definition

class ImageIdentifierTypeDef(TypedDict):
    imageDigest: NotRequired[str],
    imageTag: NotRequired[str],

CompleteLayerUploadRequestRequestTypeDef#

# CompleteLayerUploadRequestRequestTypeDef definition

class CompleteLayerUploadRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    uploadId: str,
    layerDigests: Sequence[str],
    registryId: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

RepositoryCatalogDataTypeDef#

# RepositoryCatalogDataTypeDef definition

class RepositoryCatalogDataTypeDef(TypedDict):
    description: NotRequired[str],
    architectures: NotRequired[List[str]],
    operatingSystems: NotRequired[List[str]],
    logoUrl: NotRequired[str],
    aboutText: NotRequired[str],
    usageText: NotRequired[str],
    marketplaceCertified: NotRequired[bool],

RepositoryTypeDef#

# RepositoryTypeDef definition

class RepositoryTypeDef(TypedDict):
    repositoryArn: NotRequired[str],
    registryId: NotRequired[str],
    repositoryName: NotRequired[str],
    repositoryUri: NotRequired[str],
    createdAt: NotRequired[datetime],

DeleteRepositoryPolicyRequestRequestTypeDef#

# DeleteRepositoryPolicyRequestRequestTypeDef definition

class DeleteRepositoryPolicyRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],

DeleteRepositoryRequestRequestTypeDef#

# DeleteRepositoryRequestRequestTypeDef definition

class DeleteRepositoryRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],
    force: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeImageTagsRequestRequestTypeDef#

# DescribeImageTagsRequestRequestTypeDef definition

class DescribeImageTagsRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ImageDetailTypeDef#

# ImageDetailTypeDef definition

class ImageDetailTypeDef(TypedDict):
    registryId: NotRequired[str],
    repositoryName: NotRequired[str],
    imageDigest: NotRequired[str],
    imageTags: NotRequired[List[str]],
    imageSizeInBytes: NotRequired[int],
    imagePushedAt: NotRequired[datetime],
    imageManifestMediaType: NotRequired[str],
    artifactMediaType: NotRequired[str],

DescribeRegistriesRequestRequestTypeDef#

# DescribeRegistriesRequestRequestTypeDef definition

class DescribeRegistriesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

DescribeRepositoriesRequestRequestTypeDef#

# DescribeRepositoriesRequestRequestTypeDef definition

class DescribeRepositoriesRequestRequestTypeDef(TypedDict):
    registryId: NotRequired[str],
    repositoryNames: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

RegistryCatalogDataTypeDef#

# RegistryCatalogDataTypeDef definition

class RegistryCatalogDataTypeDef(TypedDict):
    displayName: NotRequired[str],

GetRepositoryCatalogDataRequestRequestTypeDef#

# GetRepositoryCatalogDataRequestRequestTypeDef definition

class GetRepositoryCatalogDataRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],

GetRepositoryPolicyRequestRequestTypeDef#

# GetRepositoryPolicyRequestRequestTypeDef definition

class GetRepositoryPolicyRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],

ReferencedImageDetailTypeDef#

# ReferencedImageDetailTypeDef definition

class ReferencedImageDetailTypeDef(TypedDict):
    imageDigest: NotRequired[str],
    imageSizeInBytes: NotRequired[int],
    imagePushedAt: NotRequired[datetime],
    imageManifestMediaType: NotRequired[str],
    artifactMediaType: NotRequired[str],

InitiateLayerUploadRequestRequestTypeDef#

# InitiateLayerUploadRequestRequestTypeDef definition

class InitiateLayerUploadRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

PutImageRequestRequestTypeDef#

# PutImageRequestRequestTypeDef definition

class PutImageRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    imageManifest: str,
    registryId: NotRequired[str],
    imageManifestMediaType: NotRequired[str],
    imageTag: NotRequired[str],
    imageDigest: NotRequired[str],

PutRegistryCatalogDataRequestRequestTypeDef#

# PutRegistryCatalogDataRequestRequestTypeDef definition

class PutRegistryCatalogDataRequestRequestTypeDef(TypedDict):
    displayName: NotRequired[str],

RegistryAliasTypeDef#

# RegistryAliasTypeDef definition

class RegistryAliasTypeDef(TypedDict):
    name: str,
    status: RegistryAliasStatusType,  # (1)
    primaryRegistryAlias: bool,
    defaultRegistryAlias: bool,
  1. See RegistryAliasStatusType

SetRepositoryPolicyRequestRequestTypeDef#

# SetRepositoryPolicyRequestRequestTypeDef definition

class SetRepositoryPolicyRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    policyText: str,
    registryId: NotRequired[str],
    force: NotRequired[bool],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

BatchCheckLayerAvailabilityResponseTypeDef#

# BatchCheckLayerAvailabilityResponseTypeDef definition

class BatchCheckLayerAvailabilityResponseTypeDef(TypedDict):
    layers: List[LayerTypeDef],  # (1)
    failures: List[LayerFailureTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LayerTypeDef
  2. See LayerFailureTypeDef
  3. See ResponseMetadataTypeDef

CompleteLayerUploadResponseTypeDef#

# CompleteLayerUploadResponseTypeDef definition

class CompleteLayerUploadResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    uploadId: str,
    layerDigest: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteRepositoryPolicyResponseTypeDef#

# DeleteRepositoryPolicyResponseTypeDef definition

class DeleteRepositoryPolicyResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    policyText: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAuthorizationTokenResponseTypeDef#

# GetAuthorizationTokenResponseTypeDef definition

class GetAuthorizationTokenResponseTypeDef(TypedDict):
    authorizationData: AuthorizationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizationDataTypeDef
  2. See ResponseMetadataTypeDef

GetRepositoryPolicyResponseTypeDef#

# GetRepositoryPolicyResponseTypeDef definition

class GetRepositoryPolicyResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    policyText: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateLayerUploadResponseTypeDef#

# InitiateLayerUploadResponseTypeDef definition

class InitiateLayerUploadResponseTypeDef(TypedDict):
    uploadId: str,
    partSize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetRepositoryPolicyResponseTypeDef#

# SetRepositoryPolicyResponseTypeDef definition

class SetRepositoryPolicyResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    policyText: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UploadLayerPartResponseTypeDef#

# UploadLayerPartResponseTypeDef definition

class UploadLayerPartResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    uploadId: str,
    lastByteReceived: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchDeleteImageRequestRequestTypeDef#

# BatchDeleteImageRequestRequestTypeDef definition

class BatchDeleteImageRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    imageIds: Sequence[ImageIdentifierTypeDef],  # (1)
    registryId: NotRequired[str],
  1. See ImageIdentifierTypeDef

DescribeImagesRequestRequestTypeDef#

# DescribeImagesRequestRequestTypeDef definition

class DescribeImagesRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],
    imageIds: NotRequired[Sequence[ImageIdentifierTypeDef]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ImageIdentifierTypeDef

ImageFailureTypeDef#

# ImageFailureTypeDef definition

class ImageFailureTypeDef(TypedDict):
    imageId: NotRequired[ImageIdentifierTypeDef],  # (1)
    failureCode: NotRequired[ImageFailureCodeType],  # (2)
    failureReason: NotRequired[str],
  1. See ImageIdentifierTypeDef
  2. See ImageFailureCodeType

ImageTypeDef#

# ImageTypeDef definition

class ImageTypeDef(TypedDict):
    registryId: NotRequired[str],
    repositoryName: NotRequired[str],
    imageId: NotRequired[ImageIdentifierTypeDef],  # (1)
    imageManifest: NotRequired[str],
    imageManifestMediaType: NotRequired[str],
  1. See ImageIdentifierTypeDef

RepositoryCatalogDataInputTypeDef#

# RepositoryCatalogDataInputTypeDef definition

class RepositoryCatalogDataInputTypeDef(TypedDict):
    description: NotRequired[str],
    architectures: NotRequired[Sequence[str]],
    operatingSystems: NotRequired[Sequence[str]],
    logoImageBlob: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    aboutText: NotRequired[str],
    usageText: NotRequired[str],

UploadLayerPartRequestRequestTypeDef#

# UploadLayerPartRequestRequestTypeDef definition

class UploadLayerPartRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    uploadId: str,
    partFirstByte: int,
    partLastByte: int,
    layerPartBlob: Union[str, bytes, IO[Any], StreamingBody],
    registryId: NotRequired[str],

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

GetRepositoryCatalogDataResponseTypeDef#

# GetRepositoryCatalogDataResponseTypeDef definition

class GetRepositoryCatalogDataResponseTypeDef(TypedDict):
    catalogData: RepositoryCatalogDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RepositoryCatalogDataTypeDef
  2. See ResponseMetadataTypeDef

PutRepositoryCatalogDataResponseTypeDef#

# PutRepositoryCatalogDataResponseTypeDef definition

class PutRepositoryCatalogDataResponseTypeDef(TypedDict):
    catalogData: RepositoryCatalogDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RepositoryCatalogDataTypeDef
  2. See ResponseMetadataTypeDef

CreateRepositoryResponseTypeDef#

# CreateRepositoryResponseTypeDef definition

class CreateRepositoryResponseTypeDef(TypedDict):
    repository: RepositoryTypeDef,  # (1)
    catalogData: RepositoryCatalogDataTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RepositoryTypeDef
  2. See RepositoryCatalogDataTypeDef
  3. See ResponseMetadataTypeDef

DeleteRepositoryResponseTypeDef#

# DeleteRepositoryResponseTypeDef definition

class DeleteRepositoryResponseTypeDef(TypedDict):
    repository: RepositoryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RepositoryTypeDef
  2. See ResponseMetadataTypeDef

DescribeRepositoriesResponseTypeDef#

# DescribeRepositoriesResponseTypeDef definition

class DescribeRepositoriesResponseTypeDef(TypedDict):
    repositories: List[RepositoryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RepositoryTypeDef
  2. See ResponseMetadataTypeDef

DescribeImageTagsRequestDescribeImageTagsPaginateTypeDef#

# DescribeImageTagsRequestDescribeImageTagsPaginateTypeDef definition

class DescribeImageTagsRequestDescribeImageTagsPaginateTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeImagesRequestDescribeImagesPaginateTypeDef#

# DescribeImagesRequestDescribeImagesPaginateTypeDef definition

class DescribeImagesRequestDescribeImagesPaginateTypeDef(TypedDict):
    repositoryName: str,
    registryId: NotRequired[str],
    imageIds: NotRequired[Sequence[ImageIdentifierTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ImageIdentifierTypeDef
  2. See PaginatorConfigTypeDef

DescribeRegistriesRequestDescribeRegistriesPaginateTypeDef#

# DescribeRegistriesRequestDescribeRegistriesPaginateTypeDef definition

class DescribeRegistriesRequestDescribeRegistriesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeRepositoriesRequestDescribeRepositoriesPaginateTypeDef#

# DescribeRepositoriesRequestDescribeRepositoriesPaginateTypeDef definition

class DescribeRepositoriesRequestDescribeRepositoriesPaginateTypeDef(TypedDict):
    registryId: NotRequired[str],
    repositoryNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeImagesResponseTypeDef#

# DescribeImagesResponseTypeDef definition

class DescribeImagesResponseTypeDef(TypedDict):
    imageDetails: List[ImageDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageDetailTypeDef
  2. See ResponseMetadataTypeDef

GetRegistryCatalogDataResponseTypeDef#

# GetRegistryCatalogDataResponseTypeDef definition

class GetRegistryCatalogDataResponseTypeDef(TypedDict):
    registryCatalogData: RegistryCatalogDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegistryCatalogDataTypeDef
  2. See ResponseMetadataTypeDef

PutRegistryCatalogDataResponseTypeDef#

# PutRegistryCatalogDataResponseTypeDef definition

class PutRegistryCatalogDataResponseTypeDef(TypedDict):
    registryCatalogData: RegistryCatalogDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegistryCatalogDataTypeDef
  2. See ResponseMetadataTypeDef

ImageTagDetailTypeDef#

# ImageTagDetailTypeDef definition

class ImageTagDetailTypeDef(TypedDict):
    imageTag: NotRequired[str],
    createdAt: NotRequired[datetime],
    imageDetail: NotRequired[ReferencedImageDetailTypeDef],  # (1)
  1. See ReferencedImageDetailTypeDef

RegistryTypeDef#

# RegistryTypeDef definition

class RegistryTypeDef(TypedDict):
    registryId: str,
    registryArn: str,
    registryUri: str,
    verified: bool,
    aliases: List[RegistryAliasTypeDef],  # (1)
  1. See RegistryAliasTypeDef

BatchDeleteImageResponseTypeDef#

# BatchDeleteImageResponseTypeDef definition

class BatchDeleteImageResponseTypeDef(TypedDict):
    imageIds: List[ImageIdentifierTypeDef],  # (1)
    failures: List[ImageFailureTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageIdentifierTypeDef
  2. See ImageFailureTypeDef
  3. See ResponseMetadataTypeDef

PutImageResponseTypeDef#

# PutImageResponseTypeDef definition

class PutImageResponseTypeDef(TypedDict):
    image: ImageTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageTypeDef
  2. See ResponseMetadataTypeDef

CreateRepositoryRequestRequestTypeDef#

# CreateRepositoryRequestRequestTypeDef definition

class CreateRepositoryRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    catalogData: NotRequired[RepositoryCatalogDataInputTypeDef],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See RepositoryCatalogDataInputTypeDef
  2. See TagTypeDef

PutRepositoryCatalogDataRequestRequestTypeDef#

# PutRepositoryCatalogDataRequestRequestTypeDef definition

class PutRepositoryCatalogDataRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    catalogData: RepositoryCatalogDataInputTypeDef,  # (1)
    registryId: NotRequired[str],
  1. See RepositoryCatalogDataInputTypeDef

DescribeImageTagsResponseTypeDef#

# DescribeImageTagsResponseTypeDef definition

class DescribeImageTagsResponseTypeDef(TypedDict):
    imageTagDetails: List[ImageTagDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageTagDetailTypeDef
  2. See ResponseMetadataTypeDef

DescribeRegistriesResponseTypeDef#

# DescribeRegistriesResponseTypeDef definition

class DescribeRegistriesResponseTypeDef(TypedDict):
    registries: List[RegistryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegistryTypeDef
  2. See ResponseMetadataTypeDef