Skip to content

Type definitions#

Index > imagebuilder > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

SeverityCountsTypeDef#

# SeverityCountsTypeDef definition

class SeverityCountsTypeDef(TypedDict):
    all: NotRequired[int],
    critical: NotRequired[int],
    high: NotRequired[int],
    medium: NotRequired[int],

SystemsManagerAgentTypeDef#

# SystemsManagerAgentTypeDef definition

class SystemsManagerAgentTypeDef(TypedDict):
    uninstallAfterBuild: NotRequired[bool],

LaunchPermissionConfigurationTypeDef#

# LaunchPermissionConfigurationTypeDef definition

class LaunchPermissionConfigurationTypeDef(TypedDict):
    userIds: NotRequired[Sequence[str]],
    userGroups: NotRequired[Sequence[str]],
    organizationArns: NotRequired[Sequence[str]],
    organizationalUnitArns: NotRequired[Sequence[str]],

ImageStateTypeDef#

# ImageStateTypeDef definition

class ImageStateTypeDef(TypedDict):
    status: NotRequired[ImageStatusType],  # (1)
    reason: NotRequired[str],
  1. See ImageStatusType

CancelImageCreationRequestRequestTypeDef#

# CancelImageCreationRequestRequestTypeDef definition

class CancelImageCreationRequestRequestTypeDef(TypedDict):
    imageBuildVersionArn: str,
    clientToken: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CancelLifecycleExecutionRequestRequestTypeDef#

# CancelLifecycleExecutionRequestRequestTypeDef definition

class CancelLifecycleExecutionRequestRequestTypeDef(TypedDict):
    lifecycleExecutionId: str,
    clientToken: str,

ComponentParameterTypeDef#

# ComponentParameterTypeDef definition

class ComponentParameterTypeDef(TypedDict):
    name: str,
    value: Sequence[str],

ComponentParameterDetailTypeDef#

# ComponentParameterDetailTypeDef definition

class ComponentParameterDetailTypeDef(TypedDict):
    name: str,
    type: str,
    defaultValue: NotRequired[List[str]],
    description: NotRequired[str],

ComponentStateTypeDef#

# ComponentStateTypeDef definition

class ComponentStateTypeDef(TypedDict):
    status: NotRequired[ComponentStatusType],  # (1)
    reason: NotRequired[str],
  1. See ComponentStatusType

ComponentVersionTypeDef#

# ComponentVersionTypeDef definition

class ComponentVersionTypeDef(TypedDict):
    arn: NotRequired[str],
    name: NotRequired[str],
    version: NotRequired[str],
    description: NotRequired[str],
    platform: NotRequired[PlatformType],  # (1)
    supportedOsVersions: NotRequired[List[str]],
    type: NotRequired[ComponentTypeType],  # (2)
    owner: NotRequired[str],
    dateCreated: NotRequired[str],
  1. See PlatformType
  2. See ComponentTypeType

TargetContainerRepositoryTypeDef#

# TargetContainerRepositoryTypeDef definition

class TargetContainerRepositoryTypeDef(TypedDict):
    service: ContainerRepositoryServiceType,  # (1)
    repositoryName: str,
  1. See ContainerRepositoryServiceType

ContainerRecipeSummaryTypeDef#

# ContainerRecipeSummaryTypeDef definition

class ContainerRecipeSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    containerType: NotRequired[ContainerTypeType],  # (1)
    name: NotRequired[str],
    platform: NotRequired[PlatformType],  # (2)
    owner: NotRequired[str],
    parentImage: NotRequired[str],
    dateCreated: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See ContainerTypeType
  2. See PlatformType

ContainerTypeDef#

# ContainerTypeDef definition

class ContainerTypeDef(TypedDict):
    region: NotRequired[str],
    imageUris: NotRequired[List[str]],

CreateComponentRequestRequestTypeDef#

# CreateComponentRequestRequestTypeDef definition

class CreateComponentRequestRequestTypeDef(TypedDict):
    name: str,
    semanticVersion: str,
    platform: PlatformType,  # (1)
    clientToken: str,
    description: NotRequired[str],
    changeDescription: NotRequired[str],
    supportedOsVersions: NotRequired[Sequence[str]],
    data: NotRequired[str],
    uri: NotRequired[str],
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See PlatformType

ImageTestsConfigurationTypeDef#

# ImageTestsConfigurationTypeDef definition

class ImageTestsConfigurationTypeDef(TypedDict):
    imageTestsEnabled: NotRequired[bool],
    timeoutMinutes: NotRequired[int],

ScheduleTypeDef#

# ScheduleTypeDef definition

class ScheduleTypeDef(TypedDict):
    scheduleExpression: NotRequired[str],
    timezone: NotRequired[str],
    pipelineExecutionStartCondition: NotRequired[PipelineExecutionStartConditionType],  # (1)
  1. See PipelineExecutionStartConditionType

InstanceMetadataOptionsTypeDef#

# InstanceMetadataOptionsTypeDef definition

class InstanceMetadataOptionsTypeDef(TypedDict):
    httpTokens: NotRequired[str],
    httpPutResponseHopLimit: NotRequired[int],

CvssScoreAdjustmentTypeDef#

# CvssScoreAdjustmentTypeDef definition

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

CvssScoreTypeDef#

# CvssScoreTypeDef definition

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

DeleteComponentRequestRequestTypeDef#

# DeleteComponentRequestRequestTypeDef definition

class DeleteComponentRequestRequestTypeDef(TypedDict):
    componentBuildVersionArn: str,

DeleteContainerRecipeRequestRequestTypeDef#

# DeleteContainerRecipeRequestRequestTypeDef definition

class DeleteContainerRecipeRequestRequestTypeDef(TypedDict):
    containerRecipeArn: str,

DeleteDistributionConfigurationRequestRequestTypeDef#

# DeleteDistributionConfigurationRequestRequestTypeDef definition

class DeleteDistributionConfigurationRequestRequestTypeDef(TypedDict):
    distributionConfigurationArn: str,

DeleteImagePipelineRequestRequestTypeDef#

# DeleteImagePipelineRequestRequestTypeDef definition

class DeleteImagePipelineRequestRequestTypeDef(TypedDict):
    imagePipelineArn: str,

DeleteImageRecipeRequestRequestTypeDef#

# DeleteImageRecipeRequestRequestTypeDef definition

class DeleteImageRecipeRequestRequestTypeDef(TypedDict):
    imageRecipeArn: str,

DeleteImageRequestRequestTypeDef#

# DeleteImageRequestRequestTypeDef definition

class DeleteImageRequestRequestTypeDef(TypedDict):
    imageBuildVersionArn: str,

DeleteInfrastructureConfigurationRequestRequestTypeDef#

# DeleteInfrastructureConfigurationRequestRequestTypeDef definition

class DeleteInfrastructureConfigurationRequestRequestTypeDef(TypedDict):
    infrastructureConfigurationArn: str,

DeleteLifecyclePolicyRequestRequestTypeDef#

# DeleteLifecyclePolicyRequestRequestTypeDef definition

class DeleteLifecyclePolicyRequestRequestTypeDef(TypedDict):
    lifecyclePolicyArn: str,

DistributionConfigurationSummaryTypeDef#

# DistributionConfigurationSummaryTypeDef definition

class DistributionConfigurationSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    dateCreated: NotRequired[str],
    dateUpdated: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    regions: NotRequired[List[str]],

LaunchTemplateConfigurationTypeDef#

# LaunchTemplateConfigurationTypeDef definition

class LaunchTemplateConfigurationTypeDef(TypedDict):
    launchTemplateId: str,
    accountId: NotRequired[str],
    setDefaultVersion: NotRequired[bool],

S3ExportConfigurationTypeDef#

# S3ExportConfigurationTypeDef definition

class S3ExportConfigurationTypeDef(TypedDict):
    roleName: str,
    diskImageFormat: DiskImageFormatType,  # (1)
    s3Bucket: str,
    s3Prefix: NotRequired[str],
  1. See DiskImageFormatType

EbsInstanceBlockDeviceSpecificationTypeDef#

# EbsInstanceBlockDeviceSpecificationTypeDef definition

class EbsInstanceBlockDeviceSpecificationTypeDef(TypedDict):
    encrypted: NotRequired[bool],
    deleteOnTermination: NotRequired[bool],
    iops: NotRequired[int],
    kmsKeyId: NotRequired[str],
    snapshotId: NotRequired[str],
    volumeSize: NotRequired[int],
    volumeType: NotRequired[EbsVolumeTypeType],  # (1)
    throughput: NotRequired[int],
  1. See EbsVolumeTypeType

EcrConfigurationTypeDef#

# EcrConfigurationTypeDef definition

class EcrConfigurationTypeDef(TypedDict):
    repositoryName: NotRequired[str],
    containerTags: NotRequired[Sequence[str]],

FastLaunchLaunchTemplateSpecificationTypeDef#

# FastLaunchLaunchTemplateSpecificationTypeDef definition

class FastLaunchLaunchTemplateSpecificationTypeDef(TypedDict):
    launchTemplateId: NotRequired[str],
    launchTemplateName: NotRequired[str],
    launchTemplateVersion: NotRequired[str],

FastLaunchSnapshotConfigurationTypeDef#

# FastLaunchSnapshotConfigurationTypeDef definition

class FastLaunchSnapshotConfigurationTypeDef(TypedDict):
    targetResourceCount: NotRequired[int],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[Sequence[str]],

GetComponentPolicyRequestRequestTypeDef#

# GetComponentPolicyRequestRequestTypeDef definition

class GetComponentPolicyRequestRequestTypeDef(TypedDict):
    componentArn: str,

GetComponentRequestRequestTypeDef#

# GetComponentRequestRequestTypeDef definition

class GetComponentRequestRequestTypeDef(TypedDict):
    componentBuildVersionArn: str,

GetContainerRecipePolicyRequestRequestTypeDef#

# GetContainerRecipePolicyRequestRequestTypeDef definition

class GetCont