Skip to content

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)
    ...
  1. See CancelImageCreationResponseTypeDef
# cancel_image_creation method usage example with argument unpacking

kwargs: CancelImageCreationRequestRequestTypeDef = {  # (1)
    "imageBuildVersionArn": ...,
    "clientToken": ...,
}

parent.cancel_image_creation(**kwargs)
  1. See CancelImageCreationRequestRequestTypeDef

cancel_lifecycle_execution#

Cancel a specific image lifecycle policy runtime instance.

Type annotations and code completion for boto3.client("imagebuilder").cancel_lifecycle_execution method. boto3 documentation

# cancel_lifecycle_execution method definition

def cancel_lifecycle_execution(
    self,
    *,
    lifecycleExecutionId: str,
    clientToken: str,
) -> CancelLifecycleExecutionResponseTypeDef:  # (1)
    ...
  1. See CancelLifecycleExecutionResponseTypeDef
# cancel_lifecycle_execution method usage example with argument unpacking

kwargs: CancelLifecycleExecutionRequestRequestTypeDef = {  # (1)
    "lifecycleExecutionId": ...,
    "clientToken": ...,
}

parent.cancel_lifecycle_execution(**kwargs)
  1. See CancelLifecycleExecutionRequestRequestTypeDef

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)
    ...
  1. See PlatformType
  2. See CreateComponentResponseTypeDef
# create_component method usage example with argument unpacking

kwargs: CreateComponentRequestRequestTypeDef = {  # (1)
    "name": ...,
    "semanticVersion": ...,
    "platform": ...,
    "clientToken": ...,
}

parent.create_component(**kwargs)
  1. See CreateComponentRequestRequestTypeDef

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[Union[ComponentConfigurationTypeDef, ComponentConfigurationOutputTypeDef]],  # (2)
    parentImage: str,
    targetRepository: TargetContainerRepositoryTypeDef,  # (3)
    clientToken: str,
    description: str = ...,
    instanceConfiguration: Union[InstanceConfigurationTypeDef, InstanceConfigurationOutputTypeDef] = ...,  # (4)
    dockerfileTemplateData: str = ...,
    dockerfileTemplateUri: str = ...,
    platformOverride: PlatformType = ...,  # (5)
    imageOsVersionOverride: str = ...,
    tags: Mapping[str, str] = ...,
    workingDirectory: str = ...,
    kmsKeyId: str = ...,
) -> CreateContainerRecipeResponseTypeDef:  # (6)
    ...
  1. See ContainerTypeType
  2. See ComponentConfigurationTypeDef ComponentConfigurationOutputTypeDef
  3. See TargetContainerRepositoryTypeDef
  4. See InstanceConfigurationTypeDef InstanceConfigurationOutputTypeDef
  5. See PlatformType
  6. 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)
  1. See CreateContainerRecipeRequestRequestTypeDef

create_distribution_configuration#

Creates a new distribution configuration.

Type annotations and code completion for boto3.client("imagebuilder").create_distribution_configuration method.