imagebuilderClient
Index > imagebuilder > imagebuilderClient
Auto-generated documentation for imagebuilder type annotations stubs module mypy-boto3-imagebuilder.
imagebuilderClient
Type annotations and code completion for boto3.client("imagebuilder")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_imagebuilder.client import imagebuilderClient
def get_imagebuilder_client() -> imagebuilderClient:
return Session().client("imagebuilder")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("imagebuilder").exceptions
structure.
client = boto3.client("imagebuilder")
try:
do_something(client)
except (
client.CallRateLimitExceededException,
client.ClientError,
client.ClientException,
client.ForbiddenException,
client.IdempotentParameterMismatchException,
client.InvalidPaginationTokenException,
client.InvalidParameterCombinationException,
client.InvalidParameterException,
client.InvalidParameterValueException,
client.InvalidRequestException,
client.InvalidVersionNumberException,
client.ResourceAlreadyExistsException,
client.ResourceDependencyException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ServiceException,
client.ServiceQuotaExceededException,
client.ServiceUnavailableException,
) as e:
print(e)
from mypy_boto3_imagebuilder.client import Exceptions
def handle_error(exc: Exceptions.CallRateLimitExceededException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("imagebuilder").can_paginate
method.
boto3 documentation
cancel_image_creation
CancelImageCreation cancels the creation of Image.
Type annotations and code completion for boto3.client("imagebuilder").cancel_image_creation
method.
boto3 documentation
def cancel_image_creation(
self,
*,
imageBuildVersionArn: str,
clientToken: str,
) -> CancelImageCreationResponseTypeDef: # (1)
...
kwargs: CancelImageCreationRequestRequestTypeDef = { # (1)
"imageBuildVersionArn": ...,
"clientToken": ...,
}
parent.cancel_image_creation(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("imagebuilder").close
method.
boto3 documentation
create_component
Creates a new component that can be used to build, validate, test, and assess your image.
Type annotations and code completion for boto3.client("imagebuilder").create_component
method.
boto3 documentation
def create_component(
self,
*,
name: str,
semanticVersion: str,
platform: PlatformType, # (1)
clientToken: str,
description: str = ...,
changeDescription: str = ...,
supportedOsVersions: Sequence[str] = ...,
data: str = ...,
uri: str = ...,
kmsKeyId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateComponentResponseTypeDef: # (2)
...
kwargs: CreateComponentRequestRequestTypeDef = { # (1)
"name": ...,
"semanticVersion": ...,
"platform": ...,
"clientToken": ...,
}
parent.create_component(**kwargs)
create_container_recipe
Creates a new container recipe.
Type annotations and code completion for boto3.client("imagebuilder").create_container_recipe
method.
boto3 documentation
def create_container_recipe(
self,
*,
containerType: ContainerTypeType, # (1)
name: str,
semanticVersion: str,
components: Sequence[ComponentConfigurationTypeDef], # (2)
parentImage: str,
targetRepository: TargetContainerRepositoryTypeDef, # (3)
clientToken: str,
description: str = ...,
instanceConfiguration: InstanceConfigurationTypeDef = ..., # (4)
dockerfileTemplateData: str = ...,
dockerfileTemplateUri: str = ...,
platformOverride: PlatformType = ..., # (5)
imageOsVersionOverride: str = ...,
tags: Mapping[str, str] = ...,
workingDirectory: str = ...,
kmsKeyId: str = ...,
) -> CreateContainerRecipeResponseTypeDef: # (6)
...
- See ContainerTypeType
- See ComponentConfigurationTypeDef
- See TargetContainerRepositoryTypeDef
- See InstanceConfigurationTypeDef
- See PlatformType
- See CreateContainerRecipeResponseTypeDef
kwargs: CreateContainerRecipeRequestRequestTypeDef = { # (1)
"containerType": ...,
"name": ...,
"semanticVersion": ...,
"components": ...,
"parentImage": ...,
"targetRepository": ...,
"clientToken": ...,
}
parent.create_container_recipe(**kwargs)
create_distribution_configuration
Creates a new distribution configuration.
Type annotations and code completion for boto3.client("imagebuilder").create_distribution_configuration
method.
boto3 documentation
def create_distribution_configuration(
self,
*,
name: str,
distributions: Sequence[DistributionTypeDef], # (1)
clientToken: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateDistributionConfigurationResponseTypeDef: # (2)
...
kwargs: CreateDistributionConfigurationRequestRequestTypeDef = { # (1)
"name": ...,
"distributions": ...,
"clientToken": ...,
}
parent.create_distribution_configuration(**kwargs)
create_image
Creates a new image.
Type annotations and code completion for boto3.client("imagebuilder").create_image
method.
boto3 documentation
def create_image(
self,
*,
infrastructureConfigurationArn: str,
clientToken: str,
imageRecipeArn: str = ...,
containerRecipeArn: str = ...,
distributionConfigurationArn: str = ...,
imageTestsConfiguration: ImageTestsConfigurationTypeDef = ..., # (1)
enhancedImageMetadataEnabled: bool = ...,
tags: Mapping[str, str] = ...,
) -> CreateImageResponseTypeDef: # (2)
...
kwargs: CreateImageRequestRequestTypeDef = { # (1)
"infrastructureConfigurationArn": ...,
"clientToken": ...,
}
parent.create_image(**kwargs)
create_image_pipeline
Creates a new image pipeline.
Type annotations and code completion for boto3.client("imagebuilder").create_image_pipeline
method.
boto3 documentation
def create_image_pipeline(
self,
*,
name: str,
infrastructureConfigurationArn: str,
clientToken: str,
description: str = ...,
imageRecipeArn: str = ...,
containerRecipeArn: str = ...,
distributionConfigurationArn: str = ...,
imageTestsConfiguration: ImageTestsConfigurationTypeDef = ..., # (1)
enhancedImageMetadataEnabled: bool = ...,
schedule: ScheduleTypeDef = ..., # (2)
status: PipelineStatusType = ..., # (3)
tags: Mapping[str, str] = ...,
) -> CreateImagePipelineResponseTypeDef: # (4)
...
- See ImageTestsConfigurationTypeDef
- See ScheduleTypeDef
- See PipelineStatusType
- See CreateImagePipelineResponseTypeDef
kwargs: CreateImagePipelineRequestRequestTypeDef = { # (1)
"name": ...,
"infrastructureConfigurationArn": ...,
"clientToken": ...,
}
parent.create_image_pipeline(**kwargs)
create_image_recipe
Creates a new image recipe.
Type annotations and code completion for boto3.client("imagebuilder").create_image_recipe
method.
boto3 documentation
def create_image_recipe(
self,
*,
name: str,
semanticVersion: str,
components: Sequence[ComponentConfigurationTypeDef], # (1)
parentImage: str,
clientToken: str,
description: str = ...,
blockDeviceMappings: Sequence[InstanceBlockDeviceMappingTypeDef] = ..., # (2)
tags: Mapping[str, str] = ...,
workingDirectory: str = ...,
additionalInstanceConfiguration: AdditionalInstanceConfigurationTypeDef = ..., # (3)
) -> CreateImageRecipeResponseTypeDef: # (4)
...
- See ComponentConfigurationTypeDef
- See InstanceBlockDeviceMappingTypeDef
- See AdditionalInstanceConfigurationTypeDef
- See CreateImageRecipeResponseTypeDef
kwargs: CreateImageRecipeRequestRequestTypeDef = { # (1)
"name": ...,
"semanticVersion": ...,
"components": ...,
"parentImage": ...,
"clientToken": ...,
}
parent.create_image_recipe(**kwargs)
create_infrastructure_configuration
Creates a new infrastructure configuration.
Type annotations and code completion for boto3.client("imagebuilder").create_infrastructure_configuration
method.
boto3 documentation
def create_infrastructure_configuration(
self,
*,
name: str,
instanceProfileName: str,
clientToken: str,
description: str = ...,
instanceTypes: Sequence[str] = ...,
securityGroupIds: Sequence[str] = ...,
subnetId: str = ...,
logging: LoggingTypeDef = ..., # (1)
keyPair: str = ...,
terminateInstanceOnFailure: bool = ...,
snsTopicArn: str = ...,
resourceTags: Mapping[str, str] = ...,
instanceMetadataOptions: InstanceMetadataOptionsTypeDef = ..., # (2)
tags: Mapping[str, str] = ...,
) -> CreateInfrastructureConfigurationResponseTypeDef: # (3)
...
- See LoggingTypeDef
- See InstanceMetadataOptionsTypeDef
- See CreateInfrastructureConfigurationResponseTypeDef
kwargs: CreateInfrastructureConfigurationRequestRequestTypeDef = { # (1)
"name": ...,
"instanceProfileName": ...,
"clientToken": ...,
}
parent.create_infrastructure_configuration(**kwargs)
delete_component
Deletes a component build version.
Type annotations and code completion for boto3.client("imagebuilder").delete_component
method.
boto3 documentation
def delete_component(
self,
*,
componentBuildVersionArn: str,
) -> DeleteComponentResponseTypeDef: # (1)
...
kwargs: DeleteComponentRequestRequestTypeDef = { # (1)
"componentBuildVersionArn": ...,
}
parent.delete_component(**kwargs)
delete_container_recipe
Deletes a container recipe.
Type annotations and code completion for boto3.client("imagebuilder").delete_container_recipe
method.
boto3 documentation
def delete_container_recipe(
self,
*,
containerRecipeArn: str,
) -> DeleteContainerRecipeResponseTypeDef: # (1)
...
kwargs: DeleteContainerRecipeRequestRequestTypeDef = { # (1)
"containerRecipeArn": ...,
}
parent.delete_container_recipe(**kwargs)
delete_distribution_configuration
Deletes a distribution configuration.
Type annotations and code completion for boto3.client("imagebuilder").delete_distribution_configuration
method.
boto3 documentation
def delete_distribution_configuration(
self,
*,
distributionConfigurationArn: str,
) -> DeleteDistributionConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteDistributionConfigurationRequestRequestTypeDef = { # (1)
"distributionConfigurationArn": ...,
}
parent.delete_distribution_configuration(**kwargs)
delete_image
Deletes an Image Builder image resource.
Type annotations and code completion for boto3.client("imagebuilder").delete_image
method.
boto3 documentation
def delete_image(
self,
*,
imageBuildVersionArn: str,
) -> DeleteImageResponseTypeDef: # (1)
...
kwargs: DeleteImageRequestRequestTypeDef = { # (1)
"imageBuildVersionArn": ...,
}
parent.delete_image(**kwargs)
delete_image_pipeline
Deletes an image pipeline.
Type annotations and code completion for boto3.client("imagebuilder").delete_image_pipeline
method.
boto3 documentation
def delete_image_pipeline(
self,
*,
imagePipelineArn: str,
) -> DeleteImagePipelineResponseTypeDef: # (1)
...
kwargs: DeleteImagePipelineRequestRequestTypeDef = { # (1)
"imagePipelineArn": ...,
}
parent.delete_image_pipeline(**kwargs)
delete_image_recipe
Deletes an image recipe.
Type annotations and code completion for boto3.client("imagebuilder").delete_image_recipe
method.
boto3 documentation
def delete_image_recipe(
self,
*,
imageRecipeArn: str,
) -> DeleteImageRecipeResponseTypeDef: # (1)
...
kwargs: DeleteImageRecipeRequestRequestTypeDef = { # (1)
"imageRecipeArn": ...,
}
parent.delete_image_recipe(**kwargs)
delete_infrastructure_configuration
Deletes an infrastructure configuration.
Type annotations and code completion for boto3.client("imagebuilder").delete_infrastructure_configuration
method.
boto3 documentation
def delete_infrastructure_configuration(
self,
*,
infrastructureConfigurationArn: str,
) -> DeleteInfrastructureConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteInfrastructureConfigurationRequestRequestTypeDef = { # (1)
"infrastructureConfigurationArn": ...,
}
parent.delete_infrastructure_configuration(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("imagebuilder").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_component
Gets a component object.
Type annotations and code completion for boto3.client("imagebuilder").get_component
method.
boto3 documentation
def get_component(
self,
*,
componentBuildVersionArn: str,
) -> GetComponentResponseTypeDef: # (1)
...
kwargs: GetComponentRequestRequestTypeDef = { # (1)
"componentBuildVersionArn": ...,
}
parent.get_component(**kwargs)
get_component_policy
Gets a component policy.
Type annotations and code completion for boto3.client("imagebuilder").get_component_policy
method.
boto3 documentation
def get_component_policy(
self,
*,
componentArn: str,
) -> GetComponentPolicyResponseTypeDef: # (1)
...
kwargs: GetComponentPolicyRequestRequestTypeDef = { # (1)
"componentArn": ...,
}
parent.get_component_policy(**kwargs)
get_container_recipe
Retrieves a container recipe.
Type annotations and code completion for boto3.client("imagebuilder").get_container_recipe
method.
boto3 documentation
def get_container_recipe(
self,
*,
containerRecipeArn: str,
) -> GetContainerRecipeResponseTypeDef: # (1)
...
kwargs: GetContainerRecipeRequestRequestTypeDef = { # (1)
"containerRecipeArn": ...,
}
parent.get_container_recipe(**kwargs)
get_container_recipe_policy
Retrieves the policy for a container recipe.
Type annotations and code completion for boto3.client("imagebuilder").get_container_recipe_policy
method.
boto3 documentation
def get_container_recipe_policy(
self,
*,
containerRecipeArn: str,
) -> GetContainerRecipePolicyResponseTypeDef: # (1)
...
kwargs: GetContainerRecipePolicyRequestRequestTypeDef = { # (1)
"containerRecipeArn": ...,
}
parent.get_container_recipe_policy(**kwargs)
get_distribution_configuration
Gets a distribution configuration.
Type annotations and code completion for boto3.client("imagebuilder").get_distribution_configuration
method.
boto3 documentation
def get_distribution_configuration(
self,
*,
distributionConfigurationArn: str,
) -> GetDistributionConfigurationResponseTypeDef: # (1)
...
kwargs: GetDistributionConfigurationRequestRequestTypeDef = { # (1)
"distributionConfigurationArn": ...,
}
parent.get_distribution_configuration(**kwargs)
get_image
Gets an image.
Type annotations and code completion for boto3.client("imagebuilder").get_image
method.
boto3 documentation
def get_image(
self,
*,
imageBuildVersionArn: str,
) -> GetImageResponseTypeDef: # (1)
...
kwargs: GetImageRequestRequestTypeDef = { # (1)
"imageBuildVersionArn": ...,
}
parent.get_image(**kwargs)
get_image_pipeline
Gets an image pipeline.
Type annotations and code completion for boto3.client("imagebuilder").get_image_pipeline
method.
boto3 documentation
def get_image_pipeline(
self,
*,
imagePipelineArn: str,
) -> GetImagePipelineResponseTypeDef: # (1)
...
kwargs: GetImagePipelineRequestRequestTypeDef = { # (1)
"imagePipelineArn": ...,
}
parent.get_image_pipeline(**kwargs)
get_image_policy
Gets an image policy.
Type annotations and code completion for boto3.client("imagebuilder").get_image_policy
method.
boto3 documentation
def get_image_policy(
self,
*,
imageArn: str,
) -> GetImagePolicyResponseTypeDef: # (1)
...
kwargs: GetImagePolicyRequestRequestTypeDef = { # (1)
"imageArn": ...,
}
parent.get_image_policy(**kwargs)
get_image_recipe
Gets an image recipe.
Type annotations and code completion for boto3.client("imagebuilder").get_image_recipe
method.
boto3 documentation
def get_image_recipe(
self,
*,
imageRecipeArn: str,
) -> GetImageRecipeResponseTypeDef: # (1)
...
kwargs: GetImageRecipeRequestRequestTypeDef = { # (1)
"imageRecipeArn": ...,
}
parent.get_image_recipe(**kwargs)
get_image_recipe_policy
Gets an image recipe policy.
Type annotations and code completion for boto3.client("imagebuilder").get_image_recipe_policy
method.
boto3 documentation
def get_image_recipe_policy(
self,
*,
imageRecipeArn: str,
) -> GetImageRecipePolicyResponseTypeDef: # (1)
...
kwargs: GetImageRecipePolicyRequestRequestTypeDef = { # (1)
"imageRecipeArn": ...,
}
parent.get_image_recipe_policy(**kwargs)
get_infrastructure_configuration
Gets an infrastructure configuration.
Type annotations and code completion for boto3.client("imagebuilder").get_infrastructure_configuration
method.
boto3 documentation
def get_infrastructure_configuration(
self,
*,
infrastructureConfigurationArn: str,
) -> GetInfrastructureConfigurationResponseTypeDef: # (1)
...
kwargs: GetInfrastructureConfigurationRequestRequestTypeDef = { # (1)
"infrastructureConfigurationArn": ...,
}
parent.get_infrastructure_configuration(**kwargs)
import_component
Imports a component and transforms its data into a component document.
Type annotations and code completion for boto3.client("imagebuilder").import_component
method.
boto3 documentation
def import_component(
self,
*,
name: str,
semanticVersion: str,
type: ComponentTypeType, # (1)
format: ComponentFormatType, # (2)
platform: PlatformType, # (3)
clientToken: str,
description: str = ...,
changeDescription: str = ...,
data: str = ...,
uri: str = ...,
kmsKeyId: str = ...,
tags: Mapping[str, str] = ...,
) -> ImportComponentResponseTypeDef: # (4)
...
kwargs: ImportComponentRequestRequestTypeDef = { # (1)
"name": ...,
"semanticVersion": ...,
"type": ...,
"format": ...,
"platform": ...,
"clientToken": ...,
}
parent.import_component(**kwargs)
import_vm_image
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data.
Type annotations and code completion for boto3.client("imagebuilder").import_vm_image
method.
boto3 documentation
def import_vm_image(
self,
*,
name: str,
semanticVersion: str,
platform: PlatformType, # (1)
vmImportTaskId: str,
clientToken: str,
description: str = ...,
osVersion: str = ...,
tags: Mapping[str, str] = ...,
) -> ImportVmImageResponseTypeDef: # (2)
...
kwargs: ImportVmImageRequestRequestTypeDef = { # (1)
"name": ...,
"semanticVersion": ...,
"platform": ...,
"vmImportTaskId": ...,
"clientToken": ...,
}
parent.import_vm_image(**kwargs)
list_component_build_versions
Returns the list of component build versions for the specified semantic version.
Type annotations and code completion for boto3.client("imagebuilder").list_component_build_versions
method.
boto3 documentation
def list_component_build_versions(
self,
*,
componentVersionArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListComponentBuildVersionsResponseTypeDef: # (1)
...
kwargs: ListComponentBuildVersionsRequestRequestTypeDef = { # (1)
"componentVersionArn": ...,
}
parent.list_component_build_versions(**kwargs)
list_components
Returns the list of components that can be filtered by name, or by using the
listed filters
to streamline results.
Type annotations and code completion for boto3.client("imagebuilder").list_components
method.
boto3 documentation
def list_components(
self,
*,
owner: OwnershipType = ..., # (1)
filters: Sequence[FilterTypeDef] = ..., # (2)
byName: bool = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListComponentsResponseTypeDef: # (3)
...
- See OwnershipType
- See FilterTypeDef
- See ListComponentsResponseTypeDef
kwargs: ListComponentsRequestRequestTypeDef = { # (1)
"owner": ...,
}
parent.list_components(**kwargs)
list_container_recipes
Returns a list of container recipes.
Type annotations and code completion for boto3.client("imagebuilder").list_container_recipes
method.
boto3 documentation
def list_container_recipes(
self,
*,
owner: OwnershipType = ..., # (1)
filters: Sequence[FilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListContainerRecipesResponseTypeDef: # (3)
...
kwargs: ListContainerRecipesRequestRequestTypeDef = { # (1)
"owner": ...,
}
parent.list_container_recipes(**kwargs)
list_distribution_configurations
Returns a list of distribution configurations.
Type annotations and code completion for boto3.client("imagebuilder").list_distribution_configurations
method.
boto3 documentation
def list_distribution_configurations(
self,
*,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListDistributionConfigurationsResponseTypeDef: # (2)
...
kwargs: ListDistributionConfigurationsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_distribution_configurations(**kwargs)
list_image_build_versions
Returns a list of image build versions.
Type annotations and code completion for boto3.client("imagebuilder").list_image_build_versions
method.
boto3 documentation
def list_image_build_versions(
self,
*,
imageVersionArn: str,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListImageBuildVersionsResponseTypeDef: # (2)
...
kwargs: ListImageBuildVersionsRequestRequestTypeDef = { # (1)
"imageVersionArn": ...,
}
parent.list_image_build_versions(**kwargs)
list_image_packages
List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
Type annotations and code completion for boto3.client("imagebuilder").list_image_packages
method.
boto3 documentation
def list_image_packages(
self,
*,
imageBuildVersionArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListImagePackagesResponseTypeDef: # (1)
...
kwargs: ListImagePackagesRequestRequestTypeDef = { # (1)
"imageBuildVersionArn": ...,
}
parent.list_image_packages(**kwargs)
list_image_pipeline_images
Returns a list of images created by the specified pipeline.
Type annotations and code completion for boto3.client("imagebuilder").list_image_pipeline_images
method.
boto3 documentation
def list_image_pipeline_images(
self,
*,
imagePipelineArn: str,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListImagePipelineImagesResponseTypeDef: # (2)
...
kwargs: ListImagePipelineImagesRequestRequestTypeDef = { # (1)
"imagePipelineArn": ...,
}
parent.list_image_pipeline_images(**kwargs)
list_image_pipelines
Returns a list of image pipelines.
Type annotations and code completion for boto3.client("imagebuilder").list_image_pipelines
method.
boto3 documentation
def list_image_pipelines(
self,
*,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListImagePipelinesResponseTypeDef: # (2)
...
kwargs: ListImagePipelinesRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_image_pipelines(**kwargs)
list_image_recipes
Returns a list of image recipes.
Type annotations and code completion for boto3.client("imagebuilder").list_image_recipes
method.
boto3 documentation
def list_image_recipes(
self,
*,
owner: OwnershipType = ..., # (1)
filters: Sequence[FilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListImageRecipesResponseTypeDef: # (3)
...
kwargs: ListImageRecipesRequestRequestTypeDef = { # (1)
"owner": ...,
}
parent.list_image_recipes(**kwargs)
list_images
Returns the list of images that you have access to.
Type annotations and code completion for boto3.client("imagebuilder").list_images
method.
boto3 documentation
def list_images(
self,
*,
owner: OwnershipType = ..., # (1)
filters: Sequence[FilterTypeDef] = ..., # (2)
byName: bool = ...,
maxResults: int = ...,
nextToken: str = ...,
includeDeprecated: bool = ...,
) -> ListImagesResponseTypeDef: # (3)
...
- See OwnershipType
- See FilterTypeDef
- See ListImagesResponseTypeDef
kwargs: ListImagesRequestRequestTypeDef = { # (1)
"owner": ...,
}
parent.list_images(**kwargs)
list_infrastructure_configurations
Returns a list of infrastructure configurations.
Type annotations and code completion for boto3.client("imagebuilder").list_infrastructure_configurations
method.
boto3 documentation
def list_infrastructure_configurations(
self,
*,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListInfrastructureConfigurationsResponseTypeDef: # (2)
...
kwargs: ListInfrastructureConfigurationsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_infrastructure_configurations(**kwargs)
list_tags_for_resource
Returns the list of tags for the specified resource.
Type annotations and code completion for boto3.client("imagebuilder").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_component_policy
Applies a policy to a component.
Type annotations and code completion for boto3.client("imagebuilder").put_component_policy
method.
boto3 documentation
def put_component_policy(
self,
*,
componentArn: str,
policy: str,
) -> PutComponentPolicyResponseTypeDef: # (1)
...
kwargs: PutComponentPolicyRequestRequestTypeDef = { # (1)
"componentArn": ...,
"policy": ...,
}
parent.put_component_policy(**kwargs)
put_container_recipe_policy
Applies a policy to a container image.
Type annotations and code completion for boto3.client("imagebuilder").put_container_recipe_policy
method.
boto3 documentation
def put_container_recipe_policy(
self,
*,
containerRecipeArn: str,
policy: str,
) -> PutContainerRecipePolicyResponseTypeDef: # (1)
...
kwargs: PutContainerRecipePolicyRequestRequestTypeDef = { # (1)
"containerRecipeArn": ...,
"policy": ...,
}
parent.put_container_recipe_policy(**kwargs)
put_image_policy
Applies a policy to an image.
Type annotations and code completion for boto3.client("imagebuilder").put_image_policy
method.
boto3 documentation
def put_image_policy(
self,
*,
imageArn: str,
policy: str,
) -> PutImagePolicyResponseTypeDef: # (1)
...
kwargs: PutImagePolicyRequestRequestTypeDef = { # (1)
"imageArn": ...,
"policy": ...,
}
parent.put_image_policy(**kwargs)
put_image_recipe_policy
Applies a policy to an image recipe.
Type annotations and code completion for boto3.client("imagebuilder").put_image_recipe_policy
method.
boto3 documentation
def put_image_recipe_policy(
self,
*,
imageRecipeArn: str,
policy: str,
) -> PutImageRecipePolicyResponseTypeDef: # (1)
...
kwargs: PutImageRecipePolicyRequestRequestTypeDef = { # (1)
"imageRecipeArn": ...,
"policy": ...,
}
parent.put_image_recipe_policy(**kwargs)
start_image_pipeline_execution
Manually triggers a pipeline to create an image.
Type annotations and code completion for boto3.client("imagebuilder").start_image_pipeline_execution
method.
boto3 documentation
def start_image_pipeline_execution(
self,
*,
imagePipelineArn: str,
clientToken: str,
) -> StartImagePipelineExecutionResponseTypeDef: # (1)
...
kwargs: StartImagePipelineExecutionRequestRequestTypeDef = { # (1)
"imagePipelineArn": ...,
"clientToken": ...,
}
parent.start_image_pipeline_execution(**kwargs)
tag_resource
Adds a tag to a resource.
Type annotations and code completion for boto3.client("imagebuilder").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from a resource.
Type annotations and code completion for boto3.client("imagebuilder").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_distribution_configuration
Updates a new distribution configuration.
Type annotations and code completion for boto3.client("imagebuilder").update_distribution_configuration
method.
boto3 documentation
def update_distribution_configuration(
self,
*,
distributionConfigurationArn: str,
distributions: Sequence[DistributionTypeDef], # (1)
clientToken: str,
description: str = ...,
) -> UpdateDistributionConfigurationResponseTypeDef: # (2)
...
kwargs: UpdateDistributionConfigurationRequestRequestTypeDef = { # (1)
"distributionConfigurationArn": ...,
"distributions": ...,
"clientToken": ...,
}
parent.update_distribution_configuration(**kwargs)
update_image_pipeline
Updates an image pipeline.
Type annotations and code completion for boto3.client("imagebuilder").update_image_pipeline
method.
boto3 documentation
def update_image_pipeline(
self,
*,
imagePipelineArn: str,
infrastructureConfigurationArn: str,
clientToken: str,
description: str = ...,
imageRecipeArn: str = ...,
containerRecipeArn: str = ...,
distributionConfigurationArn: str = ...,
imageTestsConfiguration: ImageTestsConfigurationTypeDef = ..., # (1)
enhancedImageMetadataEnabled: bool = ...,
schedule: ScheduleTypeDef = ..., # (2)
status: PipelineStatusType = ..., # (3)
) -> UpdateImagePipelineResponseTypeDef: # (4)
...
- See ImageTestsConfigurationTypeDef
- See ScheduleTypeDef
- See PipelineStatusType
- See UpdateImagePipelineResponseTypeDef
kwargs: UpdateImagePipelineRequestRequestTypeDef = { # (1)
"imagePipelineArn": ...,
"infrastructureConfigurationArn": ...,
"clientToken": ...,
}
parent.update_image_pipeline(**kwargs)
update_infrastructure_configuration
Updates a new infrastructure configuration.
Type annotations and code completion for boto3.client("imagebuilder").update_infrastructure_configuration
method.
boto3 documentation
def update_infrastructure_configuration(
self,
*,
infrastructureConfigurationArn: str,
instanceProfileName: str,
clientToken: str,
description: str = ...,
instanceTypes: Sequence[str] = ...,
securityGroupIds: Sequence[str] = ...,
subnetId: str = ...,
logging: LoggingTypeDef = ..., # (1)
keyPair: str = ...,
terminateInstanceOnFailure: bool = ...,
snsTopicArn: str = ...,
resourceTags: Mapping[str, str] = ...,
instanceMetadataOptions: InstanceMetadataOptionsTypeDef = ..., # (2)
) -> UpdateInfrastructureConfigurationResponseTypeDef: # (3)
...