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
# imagebuilderClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("imagebuilder")
try:
do_something(client)
except (
client.exceptions.CallRateLimitExceededException,
client.exceptions.ClientError,
client.exceptions.ClientException,
client.exceptions.ForbiddenException,
client.exceptions.IdempotentParameterMismatchException,
client.exceptions.InvalidPaginationTokenException,
client.exceptions.InvalidParameterCombinationException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRequestException,
client.exceptions.InvalidVersionNumberException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceDependencyException,
client.exceptions.ResourceInUseException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ServiceUnavailableException,
) as e:
print(e)
# Exceptions.exceptions type checking example
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_image_creation#
CancelImageCreation cancels the creation of Image.
Type annotations and code completion for boto3.client("imagebuilder").cancel_image_creation
method.
boto3 documentation
# cancel_image_creation method definition
def cancel_image_creation(
self,
*,
imageBuildVersionArn: str,
clientToken: str,
) -> CancelImageCreationResponseTypeDef: # (1)
...
# cancel_image_creation method usage example with argument unpacking
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
# close method definition
def close(
self,
) -> None:
...
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
# create_component method definition
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)
...
# create_component method usage example with argument unpacking
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
# create_container_recipe method definition
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
# create_container_recipe method usage example with argument unpacking
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
# create_distribution_configuration method definition
def create_distribution_configuration(
self,
*,
name: str,
distributions: Sequence[DistributionTypeDef], # (1)
clientToken: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateDistributionConfigurationResponseTypeDef: # (2)
...
# create_distribution_configuration method usage example with argument unpacking
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
# create_image method definition
def create_image(
self,
*,
infrastructureConfigurationArn: str,
clientToken: str,
imageRecipeArn: str = ...,
containerRecipeArn: str = ...,
distributionConfigurationArn: str = ...,
imageTestsConfiguration: ImageTestsConfigurationTypeDef = ..., # (1)
enhancedImageMetadataEnabled: bool = ...,
tags: Mapping[str, str] = ...,
imageScanningConfiguration: ImageScanningConfigurationTypeDef = ..., # (2)
) -> CreateImageResponseTypeDef: # (3)
...
- See ImageTestsConfigurationTypeDef
- See ImageScanningConfigurationTypeDef
- See CreateImageResponseTypeDef
# create_image method usage example with argument unpacking
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
# create_image_pipeline method definition
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] = ...,
imageScanningConfiguration: ImageScanningConfigurationTypeDef = ..., # (4)
) -> CreateImagePipelineResponseTypeDef: # (5)
...
- See ImageTestsConfigurationTypeDef
- See ScheduleTypeDef
- See PipelineStatusType
- See ImageScanningConfigurationTypeDef
- See CreateImagePipelineResponseTypeDef
# create_image_pipeline method usage example with argument unpacking
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
# create_image_recipe method definition
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
# create_image_recipe method usage example with argument unpacking
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
# create_infrastructure_configuration method definition
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
# create_infrastructure_configuration method usage example with argument unpacking
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
# delete_component method definition
def delete_component(
self,
*,
componentBuildVersionArn: str,
) -> DeleteComponentResponseTypeDef: # (1)
...
# delete_component method usage example with argument unpacking
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
# delete_container_recipe method definition
def delete_container_recipe(
self,
*,
containerRecipeArn: str,
) -> DeleteContainerRecipeResponseTypeDef: # (1)
...
# delete_container_recipe method usage example with argument unpacking
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
# delete_distribution_configuration method definition
def delete_distribution_configuration(
self,
*,
distributionConfigurationArn: str,
) -> DeleteDistributionConfigurationResponseTypeDef: # (1)
...
# delete_distribution_configuration method usage example with argument unpacking
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
# delete_image method definition
def delete_image(
self,
*,
imageBuildVersionArn: str,
) -> DeleteImageResponseTypeDef: # (1)
...
# delete_image method usage example with argument unpacking
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
# delete_image_pipeline method definition
def delete_image_pipeline(
self,
*,
imagePipelineArn: str,
) -> DeleteImagePipelineResponseTypeDef: # (1)
...
# delete_image_pipeline method usage example with argument unpacking
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
# delete_image_recipe method definition
def delete_image_recipe(
self,
*,
imageRecipeArn: str,
) -> DeleteImageRecipeResponseTypeDef: # (1)
...
# delete_image_recipe method usage example with argument unpacking
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
# delete_infrastructure_configuration method definition
def delete_infrastructure_configuration(
self,
*,
infrastructureConfigurationArn: str,
) -> DeleteInfrastructureConfigurationResponseTypeDef: # (1)
...
# delete_infrastructure_configuration method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# get_component method definition
def get_component(
self,
*,
componentBuildVersionArn: str,
) -> GetComponentResponseTypeDef: # (1)
...
# get_component method usage example with argument unpacking
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
# get_component_policy method definition
def get_component_policy(
self,
*,
componentArn: str,
) -> GetComponentPolicyResponseTypeDef: # (1)
...
# get_component_policy method usage example with argument unpacking
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
# get_container_recipe method definition
def get_container_recipe(
self,
*,
containerRecipeArn: str,
) -> GetContainerRecipeResponseTypeDef: # (1)
...
# get_container_recipe method usage example with argument unpacking
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
# get_container_recipe_policy method definition
def get_container_recipe_policy(
self,
*,
containerRecipeArn: str,
) -> GetContainerRecipePolicyResponseTypeDef: # (1)
...
# get_container_recipe_policy method usage example with argument unpacking
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
# get_distribution_configuration method definition
def get_distribution_configuration(
self,
*,
distributionConfigurationArn: str,
) -> GetDistributionConfigurationResponseTypeDef: # (1)
...
# get_distribution_configuration method usage example with argument unpacking
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
# get_image method definition
def get_image(
self,
*,
imageBuildVersionArn: str,
) -> GetImageResponseTypeDef: # (1)
...
# get_image method usage example with argument unpacking
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
# get_image_pipeline method definition
def get_image_pipeline(
self,
*,
imagePipelineArn: str,
) -> GetImagePipelineResponseTypeDef: # (1)
...
# get_image_pipeline method usage example with argument unpacking
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
# get_image_policy method definition
def get_image_policy(
self,
*,
imageArn: str,
) -> GetImagePolicyResponseTypeDef: # (1)
...
# get_image_policy method usage example with argument unpacking
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
# get_image_recipe method definition
def get_image_recipe(
self,
*,
imageRecipeArn: str,
) -> GetImageRecipeResponseTypeDef: # (1)
...
# get_image_recipe method usage example with argument unpacking
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.