Skip to content

Type definitions#

Index > ECR > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

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

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

AuthorizationDataTypeDef#

# AuthorizationDataTypeDef definition

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

AwsEcrContainerImageDetailsTypeDef#

# AwsEcrContainerImageDetailsTypeDef definition

class AwsEcrContainerImageDetailsTypeDef(TypedDict):
    architecture: NotRequired[str],
    author: NotRequired[str],
    imageHash: NotRequired[str],
    imageTags: NotRequired[List[str]],
    platform: NotRequired[str],
    pushedAt: NotRequired[datetime],
    registry: NotRequired[str],
    repositoryName: NotRequired[str],

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],

BatchGetRepositoryScanningConfigurationRequestRequestTypeDef#

# BatchGetRepositoryScanningConfigurationRequestRequestTypeDef definition

class BatchGetRepositoryScanningConfigurationRequestRequestTypeDef(TypedDict):
    repositoryNames: Sequence[str],

RepositoryScanningConfigurationFailureTypeDef#

# RepositoryScanningConfigurationFailureTypeDef definition

class RepositoryScanningConfigurationFailureTypeDef(TypedDict):
    repositoryName: NotRequired[str],
    failureCode: NotRequired[ScanningConfigurationFailureCodeType],  # (1)
    failureReason: NotRequired[str],
  1. See ScanningConfigurationFailureCodeType

CompleteLayerUploadRequestRequestTypeDef#

# CompleteLayerUploadRequestRequestTypeDef definition

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

CreatePullThroughCacheRuleRequestRequestTypeDef#

# CreatePullThroughCacheRuleRequestRequestTypeDef definition

class CreatePullThroughCacheRuleRequestRequestTypeDef(TypedDict):
    ecrRepositoryPrefix: str,
    upstreamRegistryUrl: str,
    registryId: NotRequired[str],
    upstreamRegistry: NotRequired[UpstreamRegistryType],  # (1)
    credentialArn: NotRequired[str],
  1. See UpstreamRegistryType

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKey: NotRequired[str],
  1. See EncryptionTypeType

ImageScanningConfigurationTypeDef#

# ImageScanningConfigurationTypeDef definition

class ImageScanningConfigurationTypeDef(TypedDict):
    scanOnPush: NotRequired[bool],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CvssScoreAdjustmentTypeDef#

# CvssScoreAdjustmentTypeDef definition

class CvssScoreAdjustmentTypeDef(TypedDict):
    metric: NotRequired[str],
    reason: NotRequired[str],

CvssScoreTypeDef#

# CvssScoreTypeDef definition

class CvssScoreTypeDef(TypedDict):
    baseScore: NotRequired[float],
    scoringVector: NotRequired[str],
    source: NotRequired[str],
    version: NotRequired[str],

DeleteLifecyclePolicyRequestRequestTypeDef#

# DeleteLifecyclePolicyRequestRequestTypeDef definition

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

DeletePullThroughCacheRuleRequestRequestTypeDef#

# DeletePullThroughCacheRuleRequestRequestTypeDef definition

class DeletePullThroughCacheRuleRequestRequestTypeDef(TypedDict):
    ecrRepositoryPrefix: str,
    registryId: NotRequired[str],

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],

ImageReplicationStatusTypeDef#

# ImageReplicationStatusTypeDef definition

class ImageReplicationStatusTypeDef(TypedDict):
    region: NotRequired[str],
    registryId: NotRequired[str],
    status: NotRequired[ReplicationStatusType],  # (1)
    failureCode: NotRequired[str],
  1. See ReplicationStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

ImageScanStatusTypeDef#

# ImageScanStatusTypeDef definition

class ImageScanStatusTypeDef(TypedDict):
    status: NotRequired[ScanStatusType],  # (1)
    description: NotRequired[str],
  1. See ScanStatusType

DescribeImagesFilterTypeDef#

# DescribeImagesFilterTypeDef definition

class DescribeImagesFilterTypeDef(TypedDict):
    tagStatus: NotRequired[TagStatusType],  # (1)
  1. See TagStatusType

DescribePullThroughCacheRulesRequestRequestTypeDef#

# DescribePullThroughCacheRulesRequestRequestTypeDef definition

class DescribePullThroughCacheRulesRequestRequestTypeDef(TypedDict):
    registryId: NotRequired[str],
    ecrRepositoryPrefixes: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PullThroughCacheRuleTypeDef#

# PullThroughCacheRuleTypeDef definition

class PullThroughCacheRuleTypeDef(TypedDict):
    ecrRepositoryPrefix: NotRequired[str],
    upstreamRegistryUrl: NotRequired[str],
    createdAt: NotRequired[datetime],
    registryId: NotRequired[str],
    credentialArn: NotRequired[str],
    upstreamRegistry: NotRequired[UpstreamRegistryType],  # (1)
    updatedAt: NotRequired[datetime],
  1. See UpstreamRegistryType

DescribeRepositoriesRequestRequestTypeDef#

# DescribeRepositoriesRequestRequestTypeDef definition

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

GetAuthorizationTokenRequestRequestTypeDef#

# GetAuthorizationTokenRequestRequestTypeDef definition

class GetAuthorizationTokenRequestRequestTypeDef(TypedDict):
    registryIds: NotRequired[Sequence[str]],

GetDownloadUrlForLayerRequestRequestTypeDef#

# GetDownloadUrlForLayerRequestRequestTypeDef definition

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

LifecyclePolicyPreviewFilterTypeDef#

# LifecyclePolicyPreviewFilterTypeDef definition

class LifecyclePolicyPreviewFilterTypeDef(TypedDict):
    tagStatus: NotRequired[TagStatusType],  # (1)
  1. See TagStatusType

LifecyclePolicyPreviewSummaryTypeDef#

# LifecyclePolicyPreviewSummaryTypeDef definition

class LifecyclePolicyPreviewSummaryTypeDef(TypedDict):
    expiringImageTotalCount: NotRequired[int],

GetLifecyclePolicyRequestRequestTypeDef#

# GetLifecyclePolicyRequestRequestTypeDef definition

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

GetRepositoryPolicyRequestRequestTypeDef#

# GetRepositoryPolicyRequestRequestTypeDef definition

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

ImageScanFindingsSummaryTypeDef#

# ImageScanFindingsSummaryTypeDef definition

class ImageScanFindingsSummaryTypeDef(TypedDict):
    imageScanCompletedAt: NotRequired[datetime],
    vulnerabilitySourceUpdatedAt: NotRequired[datetime],
    findingSeverityCounts: NotRequired[Dict[FindingSeverityType, int]],  # (1)
  1. See FindingSeverityType

InitiateLayerUploadRequestRequestTypeDef#

# InitiateLayerUploadRequestRequestTypeDef definition

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

LifecyclePolicyRuleActionTypeDef#

# LifecyclePolicyRuleActionTypeDef definition

class LifecyclePolicyRuleActionTypeDef(TypedDict):
    type: NotRequired[ImageActionTypeType],  # (1)
  1. See ImageActionTypeType

ListImagesFilterTypeDef#

# ListImagesFilterTypeDef definition

class ListImagesFilterTypeDef(TypedDict):
    tagStatus: NotRequired[TagStatusType],  # (1)
  1. See TagStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

VulnerablePackageTypeDef#

# VulnerablePackageTypeDef definition

class VulnerablePackageTypeDef(TypedDict):
    arch: NotRequired[str],
    epoch: NotRequired[int],
    filePath: NotRequired[str],
    name: NotRequired[str],
    packageManager: NotRequired[str],
    release: NotRequired[str],
    sourceLayerHash: NotRequired[str],
    version: NotRequired[str],

PutImageRequestRequestTypeDef#

# PutImageRequestRequestTypeDef definition

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

PutImageTagMutabilityRequestRequestTypeDef#

# PutImageTagMutabilityRequestRequestTypeDef definition

class PutImageTagMutabilityRequestRequestTypeDef(TypedDict):
    repositoryName: str,
    imageTagMutability: ImageTagMutabilityType,  # (1)
    registryId: NotRequired[str],
  1. See ImageTagMutabilityType

PutLifecyclePolicyRequestRequestTypeDef#

# PutLifecyclePolicyRequestRequestTypeDef definition

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

PutRegistryPolicyRequestRequestTypeDef#

# PutRegistryPolicyRequestRequestTypeDef definition

class PutRegistryPolicyRequestRequestTypeDef(TypedDict):
    policyText: str,

RecommendationTypeDef#

# RecommendationTypeDef definition

class RecommendationTypeDef(TypedDict):
    url: NotRequired[str],
    text: NotRequired[str],

ScanningRepositoryFilterTypeDef#

# ScanningRepositoryFilterTypeDef definition

class ScanningRepositoryFilterTypeDef(TypedDict):
    filter: str,
    filterType: ScanningRepositoryFilterTypeType,  # (1)
  1. See ScanningRepositoryFilterTypeType

ReplicationDestinationTypeDef#

# ReplicationDestinationTypeDef definition

class ReplicationDestinationTypeDef(TypedDict):
    region: str,
    registryId: str,

RepositoryFilterTypeDef#

# RepositoryFilterTypeDef definition

class RepositoryFilterTypeDef(TypedDict):
    filter: str,
    filterType: RepositoryFilterTypeType,  # (1)
  1. See RepositoryFilterTypeType

SetRepositoryPolicyRequestRequestTypeDef#

# SetRepositoryPolicyRequestRequestTypeDef definition

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

StartLifecyclePolicyPreviewRequestRequestTypeDef#

# StartLifecyclePolicyPreviewRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdatePullThroughCacheRuleRequestRequestTypeDef#

# UpdatePullThroughCacheRuleRequestRequestTypeDef definition

class UpdatePullThroughCacheRuleRequestRequestTypeDef(TypedDict):
    ecrRepositoryPrefix: str,
    credentialArn: str,
    registryId: NotRequired[str],

ValidatePullThroughCacheRuleRequestRequestTypeDef#

# ValidatePullThroughCacheRuleRequestRequestTypeDef definition

class ValidatePullThroughCacheRuleRequestRequestTypeDef(TypedDict):
    ecrRepositoryPrefix: str,
    registryId: NotRequired[str],

ImageScanFindingTypeDef#

# ImageScanFindingTypeDef definition

class ImageScanFindingTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    uri: NotRequired[str],
    severity: NotRequired[FindingSeverityType],  # (1)
    attributes: NotRequired[List[AttributeTypeDef]],  # (2)
  1. See FindingSeverityType
  2. See AttributeTypeDef

ResourceDetailsTypeDef#

# ResourceDetailsTypeDef definition

class ResourceDetailsTypeDef(TypedDict):
    awsEcrContainerImage: NotRequired[AwsEcrContainerImageDetailsTypeDef],  # (1)
  1. See AwsEcrContainerImageDetailsTypeDef

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

CreatePullThroughCacheRuleResponseTypeDef#

# CreatePullThroughCacheRuleResponseTypeDef definition

class CreatePullThroughCacheRuleResponseTypeDef(TypedDict):
    ecrRepositoryPrefix: str,
    upstreamRegistryUrl: str,
    createdAt: datetime,
    registryId: str,
    upstreamRegistry: UpstreamRegistryType,  # (1)
    credentialArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpstreamRegistryType
  2. See ResponseMetadataTypeDef

DeleteLifecyclePolicyResponseTypeDef#

# DeleteLifecyclePolicyResponseTypeDef definition

class DeleteLifecyclePolicyResponseTypeDef(TypedDict):
    registryId: str,
    repositoryName: str,
    lifecyclePolicyText: str,
    lastEvaluatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See