Imagebuilder module#
Index > Imagebuilder
Auto-generated documentation for Imagebuilder type annotations stubs module mypy-boto3-imagebuilder.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
Imagebuilder
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Imagebuilder
.
From PyPI with pip#
Install boto3-stubs
for Imagebuilder
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[imagebuilder]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[imagebuilder]'
# standalone installation
python -m pip install mypy-boto3-imagebuilder
How to uninstall#
python -m pip uninstall -y mypy-boto3-imagebuilder
Usage#
Code samples can be found in Examples.
ImagebuilderClient#
Type annotations and code completion for boto3.client("imagebuilder")
as ImagebuilderClient
boto3 documentation
# ImagebuilderClient usage example
from boto3.session import Session
from mypy_boto3_imagebuilder.client import ImagebuilderClient
def get_client() -> ImagebuilderClient:
return Session().client("imagebuilder")
Literals#
Type annotations for literals used in methods and schema.
# BuildTypeType usage example
from mypy_boto3_imagebuilder.literals import BuildTypeType
def get_value() -> BuildTypeType:
return "IMPORT"
- BuildTypeType
- ComponentFormatType
- ComponentStatusType
- ComponentTypeType
- ContainerRepositoryServiceType
- ContainerTypeType
- DiskImageFormatType
- EbsVolumeTypeType
- ImageScanStatusType
- ImageSourceType
- ImageStatusType
- ImageTypeType
- LifecycleExecutionResourceActionNameType
- LifecycleExecutionResourceStatusType
- LifecycleExecutionStatusType
- LifecyclePolicyDetailActionTypeType
- LifecyclePolicyDetailFilterTypeType
- LifecyclePolicyResourceTypeType
- LifecyclePolicyStatusType
- LifecyclePolicyTimeUnitType
- MarketplaceResourceTypeType
- OnWorkflowFailureType
- OwnershipType
- PipelineExecutionStartConditionType
- PipelineStatusType
- PlatformType
- ProductCodeTypeType
- ResourceStatusType
- TenancyTypeType
- WorkflowExecutionStatusType
- WorkflowStatusType
- WorkflowStepActionTypeType
- WorkflowStepExecutionRollbackStatusType
- WorkflowStepExecutionStatusType
- WorkflowTypeType
- ImagebuilderServiceName
- ServiceName
- ResourceServiceName
Type definitions#
Type annotations for type definitions used in methods and schema.
- SeverityCountsTypeDef
- SystemsManagerAgentTypeDef
- LaunchPermissionConfigurationOutputTypeDef
- ImageStateTypeDef
- CancelImageCreationRequestTypeDef
- ResponseMetadataTypeDef
- CancelLifecycleExecutionRequestTypeDef
- ComponentParameterOutputTypeDef
- ComponentParameterDetailTypeDef
- ComponentParameterTypeDef
- ComponentStateTypeDef
- ProductCodeListItemTypeDef
- TargetContainerRepositoryTypeDef
- ContainerRecipeSummaryTypeDef
- ContainerTypeDef
- CreateComponentRequestTypeDef
- ImageTestsConfigurationTypeDef
- ScheduleTypeDef
- InstanceMetadataOptionsTypeDef
- PlacementTypeDef
- CreateWorkflowRequestTypeDef
- CvssScoreAdjustmentTypeDef
- CvssScoreTypeDef
- DeleteComponentRequestTypeDef
- DeleteContainerRecipeRequestTypeDef
- DeleteDistributionConfigurationRequestTypeDef
- DeleteImagePipelineRequestTypeDef
- DeleteImageRecipeRequestTypeDef
- DeleteImageRequestTypeDef
- DeleteInfrastructureConfigurationRequestTypeDef
- DeleteLifecyclePolicyRequestTypeDef
- DeleteWorkflowRequestTypeDef
- DistributionConfigurationSummaryTypeDef
- LaunchTemplateConfigurationTypeDef
- S3ExportConfigurationTypeDef
- EbsInstanceBlockDeviceSpecificationTypeDef
- EcrConfigurationOutputTypeDef
- EcrConfigurationTypeDef
- FastLaunchLaunchTemplateSpecificationTypeDef
- FastLaunchSnapshotConfigurationTypeDef
- FilterTypeDef
- GetComponentPolicyRequestTypeDef
- GetComponentRequestTypeDef
- GetContainerRecipePolicyRequestTypeDef
- GetContainerRecipeRequestTypeDef
- GetDistributionConfigurationRequestTypeDef
- GetImagePipelineRequestTypeDef
- GetImagePolicyRequestTypeDef
- GetImageRecipePolicyRequestTypeDef
- GetImageRecipeRequestTypeDef
- GetImageRequestTypeDef
- GetInfrastructureConfigurationRequestTypeDef
- GetLifecycleExecutionRequestTypeDef
- GetLifecyclePolicyRequestTypeDef
- GetMarketplaceResourceRequestTypeDef
- GetWorkflowExecutionRequestTypeDef
- GetWorkflowRequestTypeDef
- GetWorkflowStepExecutionRequestTypeDef
- ImagePackageTypeDef
- ImageRecipeSummaryTypeDef
- ImageScanFindingsFilterTypeDef
- ImageScanStateTypeDef
- ImageVersionTypeDef
- ImportComponentRequestTypeDef
- ImportDiskImageRequestTypeDef
- ImportVmImageRequestTypeDef
- LaunchPermissionConfigurationTypeDef
- LifecycleExecutionResourceActionTypeDef
- LifecycleExecutionResourceStateTypeDef
- LifecycleExecutionResourcesImpactedSummaryTypeDef
- LifecycleExecutionStateTypeDef
- LifecyclePolicyDetailActionIncludeResourcesTypeDef
- LifecyclePolicyDetailExclusionRulesAmisLastLaunchedTypeDef
- LifecyclePolicyDetailFilterTypeDef
- LifecyclePolicyResourceSelectionRecipeTypeDef
- LifecyclePolicySummaryTypeDef
- ListComponentBuildVersionsRequestTypeDef
- ListImagePackagesRequestTypeDef
- ListLifecycleExecutionResourcesRequestTypeDef
- ListLifecycleExecutionsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- ListWaitingWorkflowStepsRequestTypeDef
- WorkflowStepExecutionTypeDef
- ListWorkflowBuildVersionsRequestTypeDef
- ListWorkflowExecutionsRequestTypeDef
- WorkflowExecutionMetadataTypeDef
- ListWorkflowStepExecutionsRequestTypeDef
- WorkflowStepMetadataTypeDef
- WorkflowVersionTypeDef
- S3LogsTypeDef
- VulnerablePackageTypeDef
- PutComponentPolicyRequestTypeDef
- PutContainerRecipePolicyRequestTypeDef
- PutImagePolicyRequestTypeDef
- PutImageRecipePolicyRequestTypeDef
- RemediationRecommendationTypeDef
- ResourceStateTypeDef
- ResourceStateUpdateIncludeResourcesTypeDef
- SendWorkflowStepActionRequestTypeDef
- StartImagePipelineExecutionRequestTypeDef
- TimestampTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- WorkflowParameterOutputTypeDef
- WorkflowParameterDetailTypeDef
- WorkflowParameterTypeDef
- WorkflowStateTypeDef
- AccountAggregationTypeDef
- ImageAggregationTypeDef
- ImagePipelineAggregationTypeDef
- VulnerabilityIdAggregationTypeDef
- AdditionalInstanceConfigurationTypeDef
- AmiDistributionConfigurationOutputTypeDef
- AmiTypeDef
- CancelImageCreationResponseTypeDef
- CancelLifecycleExecutionResponseTypeDef
- CreateComponentResponseTypeDef
- CreateContainerRecipeResponseTypeDef
- CreateDistributionConfigurationResponseTypeDef
- CreateImagePipelineResponseTypeDef
- CreateImageRecipeResponseTypeDef
- CreateImageResponseTypeDef
- CreateInfrastructureConfigurationResponseTypeDef
- CreateLifecyclePolicyResponseTypeDef
- CreateWorkflowResponseTypeDef
- DeleteComponentResponseTypeDef
- DeleteContainerRecipeResponseTypeDef
- DeleteDistributionConfigurationResponseTypeDef
- DeleteImagePipelineResponseTypeDef
- DeleteImageRecipeResponseTypeDef
- DeleteImageResponseTypeDef
- DeleteInfrastructureConfigurationResponseTypeDef
- DeleteLifecyclePolicyResponseTypeDef
- DeleteWorkflowResponseTypeDef
- GetComponentPolicyResponseTypeDef
- GetContainerRecipePolicyResponseTypeDef
- GetImagePolicyResponseTypeDef
- GetImageRecipePolicyResponseTypeDef
- GetMarketplaceResourceResponseTypeDef
- GetWorkflowExecutionResponseTypeDef
- GetWorkflowStepExecutionResponseTypeDef
- ImportComponentResponseTypeDef
- ImportDiskImageResponseTypeDef
- ImportVmImageResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutComponentPolicyResponseTypeDef
- PutContainerRecipePolicyResponseTypeDef
- PutImagePolicyResponseTypeDef
- PutImageRecipePolicyResponseTypeDef
- SendWorkflowStepActionResponseTypeDef
- StartImagePipelineExecutionResponseTypeDef
- StartResourceStateUpdateResponseTypeDef
- UpdateDistributionConfigurationResponseTypeDef
- UpdateImagePipelineResponseTypeDef
- UpdateInfrastructureConfigurationResponseTypeDef
- UpdateLifecyclePolicyResponseTypeDef
- ComponentConfigurationOutputTypeDef
- ComponentParameterUnionTypeDef
- ComponentSummaryTypeDef
- ComponentTypeDef
- ComponentVersionTypeDef
- ContainerDistributionConfigurationOutputTypeDef
- ContainerDistributionConfigurationTypeDef
- ListContainerRecipesResponseTypeDef
- InfrastructureConfigurationSummaryTypeDef
- CvssScoreDetailsTypeDef
- ListDistributionConfigurationsResponseTypeDef
- InstanceBlockDeviceMappingTypeDef
- ImageScanningConfigurationOutputTypeDef
- ImageScanningConfigurationTypeDef
- FastLaunchConfigurationTypeDef
- ListComponentsRequestTypeDef
- ListContainerRecipesRequestTypeDef
- ListDistributionConfigurationsRequestTypeDef
- ListImageBuildVersionsRequestTypeDef
- ListImagePipelineImagesRequestTypeDef
- ListImagePipelinesRequestTypeDef
- ListImageRecipesRequestTypeDef
- ListImageScanFindingAggregationsRequestTypeDef
- ListImagesRequestTypeDef
- ListInfrastructureConfigurationsRequestTypeDef
- ListLifecyclePoliciesRequestTypeDef
- ListWorkflowsRequestTypeDef
- ListImagePackagesResponseTypeDef
- ListImageRecipesResponseTypeDef
- ListImageScanFindingsRequestTypeDef
- ListImagesResponseTypeDef
- LaunchPermissionConfigurationUnionTypeDef
- LifecycleExecutionSnapshotResourceTypeDef
- LifecycleExecutionTypeDef
- LifecyclePolicyDetailActionTypeDef
- LifecyclePolicyDetailExclusionRulesAmisOutputTypeDef
- LifecyclePolicyDetailExclusionRulesAmisTypeDef
- LifecyclePolicyResourceSelectionOutputTypeDef
- LifecyclePolicyResourceSelectionTypeDef
- ListLifecyclePoliciesResponseTypeDef
- ListWaitingWorkflowStepsResponseTypeDef
- ListWorkflowExecutionsResponseTypeDef
- ListWorkflowStepExecutionsResponseTypeDef
- ListWorkflowsResponseTypeDef
- LoggingTypeDef
- PackageVulnerabilityDetailsTypeDef
- RemediationTypeDef
- WorkflowConfigurationOutputTypeDef
- WorkflowParameterUnionTypeDef
- WorkflowSummaryTypeDef
- WorkflowTypeDef
- ImageScanFindingAggregationTypeDef
- OutputResourcesTypeDef
- ComponentConfigurationTypeDef
- ListComponentBuildVersionsResponseTypeDef
- GetComponentResponseTypeDef
- ListComponentsResponseTypeDef
- ContainerDistributionConfigurationUnionTypeDef
- ListInfrastructureConfigurationsResponseTypeDef
- InspectorScoreDetailsTypeDef
- ImageRecipeTypeDef
- InstanceConfigurationOutputTypeDef
- InstanceConfigurationTypeDef
- ImageScanningConfigurationUnionTypeDef
- DistributionOutputTypeDef
- AmiDistributionConfigurationTypeDef
- LifecycleExecutionResourceTypeDef
- GetLifecycleExecutionResponseTypeDef
- ListLifecycleExecutionsResponseTypeDef
- LifecyclePolicyDetailExclusionRulesOutputTypeDef
- LifecyclePolicyDetailExclusionRulesAmisUnionTypeDef
- LifecyclePolicyResourceSelectionUnionTypeDef
- CreateInfrastructureConfigurationRequestTypeDef
- InfrastructureConfigurationTypeDef
- UpdateInfrastructureConfigurationRequestTypeDef
- ImagePipelineTypeDef
- WorkflowConfigurationTypeDef
- ListWorkflowBuildVersionsResponseTypeDef
- GetWorkflowResponseTypeDef
- ListImageScanFindingAggregationsResponseTypeDef
- ImageSummaryTypeDef
- ComponentConfigurationUnionTypeDef
- ImageScanFindingTypeDef
- GetImageRecipeResponseTypeDef
- ContainerRecipeTypeDef
- InstanceConfigurationUnionTypeDef
- DistributionConfigurationTypeDef
- AmiDistributionConfigurationUnionTypeDef
- ListLifecycleExecutionResourcesResponseTypeDef
- LifecyclePolicyDetailOutputTypeDef
- LifecyclePolicyDetailExclusionRulesTypeDef
- ResourceStateUpdateExclusionRulesTypeDef
- GetInfrastructureConfigurationResponseTypeDef
- GetImagePipelineResponseTypeDef
- ListImagePipelinesResponseTypeDef
- WorkflowConfigurationUnionTypeDef
- ListImageBuildVersionsResponseTypeDef
- ListImagePipelineImagesResponseTypeDef
- CreateImageRecipeRequestTypeDef
- ListImageScanFindingsResponseTypeDef
- GetContainerRecipeResponseTypeDef
- CreateContainerRecipeRequestTypeDef
- GetDistributionConfigurationResponseTypeDef
- ImageTypeDef
- DistributionTypeDef
- LifecyclePolicyTypeDef
- LifecyclePolicyDetailExclusionRulesUnionTypeDef
- StartResourceStateUpdateRequestTypeDef
- CreateImagePipelineRequestTypeDef
- CreateImageRequestTypeDef
- UpdateImagePipelineRequestTypeDef
- GetImageResponseTypeDef
- DistributionUnionTypeDef
- GetLifecyclePolicyResponseTypeDef
- LifecyclePolicyDetailTypeDef
- CreateDistributionConfigurationRequestTypeDef
- UpdateDistributionConfigurationRequestTypeDef
- LifecyclePolicyDetailUnionTypeDef
- CreateLifecyclePolicyRequestTypeDef
- UpdateLifecyclePolicyRequestTypeDef