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#

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:
    ...

generate_presigned_url#

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:
    ...

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: CancelImageCreationRequestTypeDef = {  # (1)
    "imageBuildVersionArn": ...,
    "clientToken": ...,
}

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

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: CancelLifecycleExecutionRequestTypeDef = {  # (1)
    "lifecycleExecutionId": ...,
    "clientToken": ...,
}

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

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: CreateComponentRequestTypeDef = {  # (1)
    "name": ...,
    "semanticVersion": ...,
    "platform": ...,
    "clientToken": ...,
}

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

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[ComponentConfigurationUnionTypeDef],  # (2)
    parentImage: str,
    targetRepository: TargetContainerRepositoryTypeDef,  # (3)
    clientToken: str,
    description: str = ...,
    instanceConfiguration: InstanceConfigurationUnionTypeDef = ...,  # (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: CreateContainerRecipeRequestTypeDef = {  # (1)
    "containerType": ...,
    "name": ...,
    "semanticVersion": ...,
    "components": ...,
    "parentImage": ...,
    "targetRepository": ...,
    "clientToken": ...,
}

parent.create_container_recipe(**kwargs)
  1. See CreateContainerRecipeRequestTypeDef

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[DistributionUnionTypeDef],  # (1)
    clientToken: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDistributionConfigurationResponseTypeDef:  # (2)
    ...
  1. See DistributionTypeDef DistributionOutputTypeDef
  2. See CreateDistributionConfigurationResponseTypeDef 
# create_distribution_configuration method usage example with argument unpacking

kwargs: CreateDistributionConfigurationRequestTypeDef = {  # (1)
    "name": ...,
    "distributions": ...,
    "clientToken": ...,
}

parent.create_distribution_configuration(**kwargs)
  1. See CreateDistributionConfigurationRequestTypeDef

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: ImageScanningConfigurationUnionTypeDef = ...,  # (2)
    workflows: Sequence[WorkflowConfigurationUnionTypeDef] = ...,  # (3)
    executionRole: str = ...,
) -> CreateImageResponseTypeDef:  # (4)
    ...
  1. See ImageTestsConfigurationTypeDef
  2. See ImageScanningConfigurationTypeDef ImageScanningConfigurationOutputTypeDef
  3. See WorkflowConfigurationTypeDef WorkflowConfigurationOutputTypeDef
  4. See CreateImageResponseTypeDef 
# create_image method usage example with argument unpacking

kwargs: CreateImageRequestTypeDef = {  # (1)
    "infrastructureConfigurationArn": ...,
    "clientToken": ...,
}

parent.create_image(**kwargs)
  1. See CreateImageRequestTypeDef

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: ImageScanningConfigurationUnionTypeDef = ...,  # (4)
    workflows: Sequence[WorkflowConfigurationUnionTypeDef] = ...,  # (5)
    executionRole: str = ...,
) -> CreateImagePipelineResponseTypeDef:  # (6)
    ...
  1. See ImageTestsConfigurationTypeDef
  2. See ScheduleTypeDef
  3. See PipelineStatusType
  4. See ImageScanningConfigurationTypeDef ImageScanningConfigurationOutputTypeDef
  5. See WorkflowConfigurationTypeDef WorkflowConfigurationOutputTypeDef
  6. See CreateImagePipelineResponseTypeDef 
# create_image_pipeline method usage example with argument unpacking

kwargs: CreateImagePipelineRequestTypeDef = {  # (1)
    "name": ...,
    "infrastructureConfigurationArn": ...,
    "clientToken": ...,
}

parent.create_image_pipeline(**kwargs)
  1. See CreateImagePipelineRequestTypeDef

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[ComponentConfigurationUnionTypeDef],  # (1)
    parentImage: str,
    clientToken: str,
    description: str = ...,
    blockDeviceMappings: Sequence[InstanceBlockDeviceMappingTypeDef] = ...,  # (2)
    tags: Mapping[str, str] = ...,
    workingDirectory: str = ...,
    additionalInstanceConfiguration: AdditionalInstanceConfigurationTypeDef = ...,  # (3)
) -> CreateImageRecipeResponseTypeDef:  # (4)
    ...
  1. See ComponentConfigurationTypeDef ComponentConfigurationOutputTypeDef
  2. See InstanceBlockDeviceMappingTypeDef
  3. See AdditionalInstanceConfigurationTypeDef
  4. See CreateImageRecipeResponseTypeDef 
# create_image_recipe method usage example with argument unpacking

kwargs: CreateImageRecipeRequestTypeDef = {  # (1)
    "name": ...,
    "semanticVersion": ...,
    "components": ...,
    "parentImage": ...,
    "clientToken": ...,
}

parent.create_image_recipe(**kwargs)
  1. See CreateImageRecipeRequestTypeDef

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] = ...,
    placement: PlacementTypeDef = ...,  # (3)
) -> CreateInfrastructureConfigurationResponseTypeDef:  # (4)
    ...
  1. See LoggingTypeDef
  2. See InstanceMetadataOptionsTypeDef
  3. See PlacementTypeDef
  4. See CreateInfrastructureConfigurationResponseTypeDef 
# create_infrastructure_configuration method usage example with argument unpacking

kwargs: CreateInfrastructureConfigurationRequestTypeDef = {  # (1)
    "name": ...,
    "instanceProfileName": ...,
    "clientToken": ...,
}

parent.create_infrastructure_configuration(**kwargs)
  1. See CreateInfrastructureConfigurationRequestTypeDef

create_lifecycle_policy#

Create a lifecycle policy resource.

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

# create_lifecycle_policy method definition

def create_lifecycle_policy(
    self,
    *,
    name: str,
    executionRole: str,
    resourceType: LifecyclePolicyResourceTypeType,  # (1)
    policyDetails: Sequence[LifecyclePolicyDetailUnionTypeDef],  # (2)
    resourceSelection: LifecyclePolicyResourceSelectionUnionTypeDef,  # (3)
    clientToken: str,
    description: str = ...,
    status: LifecyclePolicyStatusType = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateLifecyclePolicyResponseTypeDef:  # (5)
    ...
  1. See LifecyclePolicyResourceTypeType
  2. See LifecyclePolicyDetailTypeDef LifecyclePolicyDetailOutputTypeDef
  3. See LifecyclePolicyResourceSelectionTypeDef LifecyclePolicyResourceSelectionOutputTypeDef
  4. See LifecyclePolicyStatusType
  5. See CreateLifecyclePolicyResponseTypeDef 
# create_lifecycle_policy method usage example with argument unpacking

kwargs: CreateLifecyclePolicyRequestTypeDef = {  # (1)
    "name": ...,
    "executionRole": ...,
    "resourceType": ...,
    "policyDetails": ...,
    "resourceSelection": ...,
    "clientToken": ...,
}

parent.create_lifecycle_policy(**kwargs)
  1. See CreateLifecyclePolicyRequestTypeDef

create_workflow#

Create a new workflow or a new version of an existing workflow.

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

# create_workflow method definition

def create_workflow(
    self,
    *,
    name: str,
    semanticVersion: str,
    clientToken: str,
    type: WorkflowTypeType,  # (1)
    description: str = ...,
    changeDescription: str = ...,
    data: str = ...,
    uri: str = ...,
    kmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkflowResponseTypeDef:  # (2)
    ...
  1. See WorkflowTypeType
  2. See CreateWorkflowResponseTypeDef 
# create_workflow method usage example with argument unpacking

kwargs: CreateWorkflowRequestTypeDef = {  # (1)
    "name": ...,
    "semanticVersion": ...,
    "clientToken": ...,
    "type": ...,
}

parent.create_workflow(**kwargs)
  1. See CreateWorkflowRequestTypeDef

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

kwargs: DeleteComponentRequestTypeDef = {  # (1)
    "componentBuildVersionArn": ...,
}

parent.delete_component(**kwargs)
  1. See DeleteComponentRequestTypeDef

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

kwargs: DeleteContainerRecipeRequestTypeDef = {  # (1)
    "containerRecipeArn": ...,
}

parent.delete_container_recipe(**kwargs)
  1. See DeleteContainerRecipeRequestTypeDef

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

kwargs: DeleteDistributionConfigurationRequestTypeDef = {  # (1)
    "distributionConfigurationArn": ...,
}

parent.delete_distribution_configuration(**kwargs)
  1. See DeleteDistributionConfigurationRequestTypeDef

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

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

parent.delete_image(**kwargs)
  1. See DeleteImageRequestTypeDef

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

kwargs: DeleteImagePipelineRequestTypeDef = {  # (1)
    "imagePipelineArn": ...,
}

parent.delete_image_pipeline(**kwargs)
  1. See DeleteImagePipelineRequestTypeDef

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

kwargs: DeleteImageRecipeRequestTypeDef = {  # (1)
    "imageRecipeArn": ...,
}

parent.delete_image_recipe(**kwargs)
  1. See DeleteImageRecipeRequestTypeDef

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

kwargs: DeleteInfrastructureConfigurationRequestTypeDef = {  # (1)
    "infrastructureConfigurationArn": ...,
}

parent.delete_infrastructure_configuration(**kwargs)
  1. See DeleteInfrastructureConfigurationRequestTypeDef

delete_lifecycle_policy#

Delete the specified lifecycle policy resource.

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

# delete_lifecycle_policy method definition

def delete_lifecycle_policy(
    self,
    *,
    lifecyclePolicyArn: str,
) -> DeleteLifecyclePolicyResponseTypeDef:  # (1)
    ...
  1. See DeleteLifecyclePolicyResponseTypeDef 
# delete_lifecycle_policy method usage example with argument unpacking

kwargs: DeleteLifecyclePolicyRequestTypeDef = {  # (1)
    "lifecyclePolicyArn": ...,
}

parent.delete_lifecycle_policy(**kwargs)
  1. See DeleteLifecyclePolicyRequestTypeDef

delete_workflow#

Deletes a specific workflow resource.

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

# delete_workflow method definition

def delete_workflow(
    self,
    *,
    workflowBuildVersionArn: str,
) -> DeleteWorkflowResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkflowResponseTypeDef 
# delete_workflow method usage example with argument unpacking

kwargs: DeleteWorkflowRequestTypeDef = {  # (1)
    "workflowBuildVersionArn": ...,
}

parent.delete_workflow(**kwargs)
  1. See DeleteWorkflowRequestTypeDef

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

kwargs: GetComponentRequestTypeDef = {  # (1)
    "componentBuildVersionArn": ...,
}

parent.get_component(**kwargs)
  1. See GetComponentRequestTypeDef

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

kwargs: GetComponentPolicyRequestTypeDef = {  # (1)
    "componentArn": ...,
}

parent.get_component_policy(**kwargs)
  1. See GetComponentPolicyRequestTypeDef

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

kwargs: GetContainerRecipeRequestTypeDef = {  # (1)
    "containerRecipeArn": ...,
}

parent.get_container_recipe(**kwargs)
  1. See GetContainerRecipeRequestTypeDef

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

kwargs: GetContainerRecipePolicyRequestTypeDef = {  # (1)
    "containerRecipeArn": ...,
}

parent.get_container_recipe_policy(**kwargs)
  1. See GetContainerRecipePolicyRequestTypeDef

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

kwargs: GetDistributionConfigurationRequestTypeDef = {  # (1)
    "distributionConfigurationArn": ...,
}

parent.get_distribution_configuration(**kwargs)
  1. See GetDistributionConfigurationRequestTypeDef

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

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

parent.get_image(**kwargs)
  1. See GetImageRequestTypeDef

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

kwargs: GetImagePipelineRequestTypeDef = {  # (1)
    "imagePipelineArn": ...,
}

parent.get_image_pipeline(**kwargs)
  1. See GetImagePipelineRequestTypeDef

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

kwargs: GetImagePolicyRequestTypeDef = {  # (1)
    "imageArn": ...,
}

parent.get_image_policy(**kwargs)
  1. See GetImagePolicyRequestTypeDef

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

kwargs: GetImageRecipeRequestTypeDef = {  # (1)
    "imageRecipeArn": ...,
}

parent.get_image_recipe(**kwargs)
  1. See GetImageRecipeRequestTypeDef

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

# get_image_recipe_policy method definition

def get_image_recipe_policy(
    self,
    *,
    imageRecipeArn: str,
) -> GetImageRecipePolicyResponseTypeDef:  # (1)
    ...
  1. See GetImageRecipePolicyResponseTypeDef 
# get_image_recipe_policy method usage example with argument unpacking

kwargs: GetImageRecipePolicyRequestTypeDef = {  # (1)
    "imageRecipeArn": ...,
}

parent.get_image_recipe_policy(**kwargs)
  1. See GetImageRecipePolicyRequestTypeDef

get_infrastructure_configuration#

Gets an infrastructure configuration.

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

# get_infrastructure_configuration method definition

def get_infrastructure_configuration(
    self,
    *,
    infrastructureConfigurationArn: str,
) -> GetInfrastructureConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetInfrastructureConfigurationResponseTypeDef 
# get_infrastructure_configuration method usage example with argument unpacking

kwargs: GetInfrastructureConfigurationRequestTypeDef = {  # (1)
    "infrastructureConfigurationArn": ...,
}

parent.get_infrastructure_configuration(**kwargs)
  1. See GetInfrastructureConfigurationRequestTypeDef

get_lifecycle_execution#

Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.

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

# get_lifecycle_execution method definition

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

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

parent.get_lifecycle_execution(**kwargs)
  1. See GetLifecycleExecutionRequestTypeDef

get_lifecycle_policy#

Get details for the specified image lifecycle policy.

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

# get_lifecycle_policy method definition

def get_lifecycle_policy(
    self,
    *,
    lifecyclePolicyArn: str,
) -> GetLifecyclePolicyResponseTypeDef:  # (1)
    ...
  1. See GetLifecyclePolicyResponseTypeDef 
# get_lifecycle_policy method usage example with argument unpacking

kwargs: GetLifecyclePolicyRequestTypeDef = {  # (1)
    "lifecyclePolicyArn": ...,
}

parent.get_lifecycle_policy(**kwargs)
  1. See GetLifecyclePolicyRequestTypeDef

get_marketplace_resource#

Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource.

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

# get_marketplace_resource method definition

def get_marketplace_resource(
    self,
    *,
    resourceType: MarketplaceResourceTypeType,  # (1)
    resourceArn: str,
    resourceLocation: str = ...,
) -> GetMarketplaceResourceResponseTypeDef:  # (2)
    ...
  1. See MarketplaceResourceTypeType
  2. See GetMarketplaceResourceResponseTypeDef 
# get_marketplace_resource method usage example with argument unpacking

kwargs: GetMarketplaceResourceRequestTypeDef = {  # (1)
    "resourceType": ...,
    "resourceArn": ...,
}

parent.get_marketplace_resource(**kwargs)
  1. See GetMarketplaceResourceRequestTypeDef

get_workflow#

Get a workflow resource object.

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

# get_workflow method definition

def get_workflow(
    self,
    *,
    workflowBuildVersionArn: str,
) -> GetWorkflowResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowResponseTypeDef 
# get_workflow method usage example with argument unpacking

kwargs: GetWorkflowRequestTypeDef = {  # (1)
    "workflowBuildVersionArn": ...,
}

parent.get_workflow(**kwargs)
  1. See GetWorkflowRequestTypeDef

get_workflow_execution#

Get the runtime information that was logged for a specific runtime instance of the workflow.

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

# get_workflow_execution method definition

def get_workflow_execution(
    self,
    *,
    workflowExecutionId: str,
) -> GetWorkflowExecutionResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowExecutionResponseTypeDef 
# get_workflow_execution method usage example with argument unpacking

kwargs: GetWorkflowExecutionRequestTypeDef = {  # (1)
    "workflowExecutionId": ...,
}

parent.get_workflow_execution(**kwargs)
  1. See GetWorkflowExecutionRequestTypeDef

get_workflow_step_execution#

Get the runtime information that was logged for a specific runtime instance of the workflow step.

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

# get_workflow_step_execution method definition

def get_workflow_step_execution(
    self,
    *,
    stepExecutionId: str,
) -> GetWorkflowStepExecutionResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowStepExecutionResponseTypeDef 
# get_workflow_step_execution method usage example with argument unpacking

kwargs: GetWorkflowStepExecutionRequestTypeDef = {  # (1)
    "stepExecutionId": ...,
}

parent.get_workflow_step_execution(**kwargs)
  1. See GetWorkflowStepExecutionRequestTypeDef

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

# import_component method definition

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)
    ...
  1. See ComponentTypeType
  2. See ComponentFormatType
  3. See PlatformType
  4. See ImportComponentResponseTypeDef 
# import_component method usage example with argument unpacking

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

parent.import_component(**kwargs)
  1. See ImportComponentRequestTypeDef

import_disk_image#

Import a Windows operating system image from a verified Microsoft ISO disk file.

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

# import_disk_image method definition

def import_disk_image(
    self,
    *,
    name: str,
    semanticVersion: str,
    platform: str,
    osVersion: str,
    infrastructureConfigurationArn: str,
    uri: str,
    clientToken: str,
    description: str = ...,
    executionRole: str = ...,
    tags: Mapping[str, str] = ...,
) -> ImportDiskImageResponseTypeDef:  # (1)
    ...
  1. See ImportDiskImageResponseTypeDef 
# import_disk_image method usage example with argument unpacking

kwargs: ImportDiskImageRequestTypeDef = {  # (1)
    "name": ...,
    "semanticVersion": ...,
    "platform": ...,
    "osVersion": ...,
    "infrastructureConfigurationArn": ...,
    "uri": ...,
    "clientToken": ...,
}

parent.import_disk_image(**kwargs)
  1. See ImportDiskImageRequestTypeDef

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

# import_vm_image method definition

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

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

parent.import_vm_image(**kwargs)
  1. See ImportVmImageRequestTypeDef

list_component_build_versions#

Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).

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

# list_component_build_versions method definition

def list_component_build_versions(
    self,
    *,
    componentVersionArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComponentBuildVersionsResponseTypeDef:  # (1)
    ...
  1. See ListComponentBuildVersionsResponseTypeDef 
# list_component_build_versions method usage example with argument unpacking

kwargs: ListComponentBuildVersionsRequestTypeDef = {  # (1)
    "componentVersionArn": ...,
}

parent.list_component_build_versions(**kwargs)
  1. See ListComponentBuildVersionsRequestTypeDef

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

# list_components method definition

def list_components(
    self,
    *,
    owner: OwnershipType = ...,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    byName: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComponentsResponseTypeDef:  # (3)
    ...
  1. See OwnershipType
  2. See FilterTypeDef
  3. See ListComponentsResponseTypeDef 
# list_components method usage example with argument unpacking

kwargs: ListComponentsRequestTypeDef = {  # (1)
    "owner": ...,
}

parent.list_components(**kwargs)
  1. See ListComponentsRequestTypeDef

list_container_recipes#

Returns a list of container recipes.

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

# list_container_recipes method definition

def list_container_recipes(
    self,
    *,
    owner: OwnershipType = ...,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListContainerRecipesResponseTypeDef:  # (3)
    ...
  1. See OwnershipType
  2. See FilterTypeDef
  3. See ListContainerRecipesResponseTypeDef 
# list_container_recipes method usage example with argument unpacking

kwargs: ListContainerRecipesRequestTypeDef = {  # (1)
    "owner": ...,
}

parent.list_container_recipes(**kwargs)
  1. See ListContainerRecipesRequestTypeDef

list_distribution_configurations#

Returns a list of distribution configurations.

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

# list_distribution_configurations method definition

def list_distribution_configurations(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDistributionConfigurationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListDistributionConfigurationsResponseTypeDef 
# list_distribution_configurations method usage example with argument unpacking

kwargs: ListDistributionConfigurationsRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_distribution_configurations(**kwargs)
  1. See ListDistributionConfigurationsRequestTypeDef

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

# list_image_build_versions method definition

def list_image_build_versions(
    self,
    *,
    imageVersionArn: str,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImageBuildVersionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListImageBuildVersionsResponseTypeDef 
# list_image_build_versions method usage example with argument unpacking

kwargs: ListImageBuildVersionsRequestTypeDef = {  # (1)
    "imageVersionArn": ...,
}

parent.list_image_build_versions(**kwargs)
  1. See ListImageBuildVersionsRequestTypeDef

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

# list_image_packages method definition

def list_image_packages(
    self,
    *,
    imageBuildVersionArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImagePackagesResponseTypeDef:  # (1)
    ...
  1. See ListImagePackagesResponseTypeDef 
# list_image_packages method usage example with argument unpacking

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

parent.list_image_packages(**kwargs)
  1. See ListImagePackagesRequestTypeDef

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

# list_image_pipeline_images method definition

def list_image_pipeline_images(
    self,
    *,
    imagePipelineArn: str,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImagePipelineImagesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListImagePipelineImagesResponseTypeDef 
# list_image_pipeline_images method usage example with argument unpacking

kwargs: ListImagePipelineImagesRequestTypeDef = {  # (1)
    "imagePipelineArn": ...,
}

parent.list_image_pipeline_images(**kwargs)
  1. See ListImagePipelineImagesRequestTypeDef

list_image_pipelines#

Returns a list of image pipelines.

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

# list_image_pipelines method definition

def list_image_pipelines(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImagePipelinesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListImagePipelinesResponseTypeDef 
# list_image_pipelines method usage example with argument unpacking

kwargs: ListImagePipelinesRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_image_pipelines(**kwargs)
  1. See ListImagePipelinesRequestTypeDef

list_image_recipes#

Returns a list of image recipes.

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

# list_image_recipes method definition

def list_image_recipes(
    self,
    *,
    owner: OwnershipType = ...,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImageRecipesResponseTypeDef:  # (3)
    ...
  1. See OwnershipType
  2. See FilterTypeDef
  3. See ListImageRecipesResponseTypeDef 
# list_image_recipes method usage example with argument unpacking

kwargs: ListImageRecipesRequestTypeDef = {  # (1)
    "owner": ...,
}

parent.list_image_recipes(**kwargs)
  1. See ListImageRecipesRequestTypeDef

list_image_scan_finding_aggregations#

Returns a list of image scan aggregations for your account.

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

# list_image_scan_finding_aggregations method definition

def list_image_scan_finding_aggregations(
    self,
    *,
    filter: FilterTypeDef = ...,  # (1)
    nextToken: str = ...,
) -> ListImageScanFindingAggregationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListImageScanFindingAggregationsResponseTypeDef 
# list_image_scan_finding_aggregations method usage example with argument unpacking

kwargs: ListImageScanFindingAggregationsRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_image_scan_finding_aggregations(**kwargs)
  1. See ListImageScanFindingAggregationsRequestTypeDef

list_image_scan_findings#

Returns a list of image scan findings for your account.

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

# list_image_scan_findings method definition

def list_image_scan_findings(
    self,
    *,
    filters: Sequence[ImageScanFindingsFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImageScanFindingsResponseTypeDef:  # (2)
    ...
  1. See ImageScanFindingsFilterTypeDef
  2. See ListImageScanFindingsResponseTypeDef 
# list_image_scan_findings method usage example with argument unpacking

kwargs: ListImageScanFindingsRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_image_scan_findings(**kwargs)
  1. See ListImageScanFindingsRequestTypeDef

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

# list_images method definition

def list_images(
    self,
    *,
    owner: OwnershipType = ...,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    byName: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    includeDeprecated: bool = ...,
) -> ListImagesResponseTypeDef:  # (3)
    ...
  1. See OwnershipType
  2. See FilterTypeDef
  3. See ListImagesResponseTypeDef 
# list_images method usage example with argument unpacking

kwargs: ListImagesRequestTypeDef = {  # (1)
    "owner": ...,
}

parent.list_images(**kwargs)
  1. See ListImagesRequestTypeDef

list_infrastructure_configurations#

Returns a list of infrastructure configurations.

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

# list_infrastructure_configurations method definition

def list_infrastructure_configurations(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInfrastructureConfigurationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListInfrastructureConfigurationsResponseTypeDef 
# list_infrastructure_configurations method usage example with argument unpacking

kwargs: ListInfrastructureConfigurationsRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_infrastructure_configurations(**kwargs)
  1. See ListInfrastructureConfigurationsRequestTypeDef

list_lifecycle_execution_resources#

List resources that the runtime instance of the image lifecycle identified for lifecycle actions.

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

# list_lifecycle_execution_resources method definition

def list_lifecycle_execution_resources(
    self,
    *,
    lifecycleExecutionId: str,
    parentResourceId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLifecycleExecutionResourcesResponseTypeDef:  # (1)
    ...
  1. See ListLifecycleExecutionResourcesResponseTypeDef 
# list_lifecycle_execution_resources method usage example with argument unpacking

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

parent.list_lifecycle_execution_resources(**kwargs)
  1. See ListLifecycleExecutionResourcesRequestTypeDef

list_lifecycle_executions#

Get the lifecycle runtime history for the specified resource.

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

# list_lifecycle_executions method definition

def list_lifecycle_executions(
    self,
    *,
    resourceArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLifecycleExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListLifecycleExecutionsResponseTypeDef 
# list_lifecycle_executions method usage example with argument unpacking

kwargs: ListLifecycleExecutionsRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_lifecycle_executions(**kwargs)
  1. See ListLifecycleExecutionsRequestTypeDef

list_lifecycle_policies#

Get a list of lifecycle policies in your Amazon Web Services account.

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

# list_lifecycle_policies method definition

def list_lifecycle_policies(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLifecyclePoliciesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListLifecyclePoliciesResponseTypeDef 
# list_lifecycle_policies method usage example with argument unpacking

kwargs: ListLifecyclePoliciesRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_lifecycle_policies(**kwargs)
  1. See ListLifecyclePoliciesRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_waiting_workflow_steps#

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

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

# list_waiting_workflow_steps method definition

def list_waiting_workflow_steps(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWaitingWorkflowStepsResponseTypeDef:  # (1)
    ...
  1. See ListWaitingWorkflowStepsResponseTypeDef 
# list_waiting_workflow_steps method usage example with argument unpacking

kwargs: ListWaitingWorkflowStepsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_waiting_workflow_steps(**kwargs)
  1. See ListWaitingWorkflowStepsRequestTypeDef

list_workflow_build_versions#

Returns a list of build versions for a specific workflow resource.

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

# list_workflow_build_versions method definition

def list_workflow_build_versions(
    self,
    *,
    workflowVersionArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkflowBuildVersionsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowBuildVersionsResponseTypeDef 
# list_workflow_build_versions method usage example with argument unpacking

kwargs: ListWorkflowBuildVersionsRequestTypeDef = {  # (1)
    "workflowVersionArn": ...,
}

parent.list_workflow_build_versions(**kwargs)
  1. See ListWorkflowBuildVersionsRequestTypeDef

list_workflow_executions#

Returns a list of workflow runtime instance metadata objects for a specific image build version.

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

# list_workflow_executions method definition

def list_workflow_executions(
    self,
    *,
    imageBuildVersionArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkflowExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowExecutionsResponseTypeDef 
# list_workflow_executions method usage example with argument unpacking

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

parent.list_workflow_executions(**kwargs)
  1. See ListWorkflowExecutionsRequestTypeDef

list_workflow_step_executions#

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

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

# list_workflow_step_executions method definition

def list_workflow_step_executions(
    self,
    *,
    workflowExecutionId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkflowStepExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowStepExecutionsResponseTypeDef 
# list_workflow_step_executions method usage example with argument unpacking

kwargs: ListWorkflowStepExecutionsRequestTypeDef = {  # (1)
    "workflowExecutionId": ...,
}

parent.list_workflow_step_executions(**kwargs)
  1. See ListWorkflowStepExecutionsRequestTypeDef

list_workflows#

Lists workflow build versions based on filtering parameters.

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

# list_workflows method definition

def list_workflows(
    self,
    *,
    owner: OwnershipType = ...,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    byName: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkflowsResponseTypeDef:  # (3)
    ...
  1. See OwnershipType
  2. See FilterTypeDef
  3. See ListWorkflowsResponseTypeDef 
# list_workflows method usage example with argument unpacking

kwargs: ListWorkflowsRequestTypeDef = {  # (1)
    "owner": ...,
}

parent.list_workflows(**kwargs)
  1. See ListWorkflowsRequestTypeDef

put_component_policy#

Applies a policy to a component.

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

# put_component_policy method definition

def put_component_policy(
    self,
    *,
    componentArn: str,
    policy: str,
) -> PutComponentPolicyResponseTypeDef:  # (1)
    ...
  1. See PutComponentPolicyResponseTypeDef 
# put_component_policy method usage example with argument unpacking

kwargs: PutComponentPolicyRequestTypeDef = {  # (1)
    "componentArn": ...,
    "policy": ...,
}

parent.put_component_policy(**kwargs)
  1. See PutComponentPolicyRequestTypeDef

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

# put_container_recipe_policy method definition

def put_container_recipe_policy(
    self,
    *,
    containerRecipeArn: str,
    policy: str,
) -> PutContainerRecipePolicyResponseTypeDef:  # (1)
    ...
  1. See PutContainerRecipePolicyResponseTypeDef 
# put_container_recipe_policy method usage example with argument unpacking

kwargs: PutContainerRecipePolicyRequestTypeDef = {  # (1)
    "containerRecipeArn": ...,
    "policy": ...,
}

parent.put_container_recipe_policy(**kwargs)
  1. See PutContainerRecipePolicyRequestTypeDef

put_image_policy#

Applies a policy to an image.

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

# put_image_policy method definition

def put_image_policy(
    self,
    *,
    imageArn: str,
    policy: str,
) -> PutImagePolicyResponseTypeDef:  # (1)
    ...
  1. See PutImagePolicyResponseTypeDef 
# put_image_policy method usage example with argument unpacking

kwargs: PutImagePolicyRequestTypeDef = {  # (1)
    "imageArn": ...,
    "policy": ...,
}

parent.put_image_policy(**kwargs)
  1. See PutImagePolicyRequestTypeDef

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

# put_image_recipe_policy method definition

def put_image_recipe_policy(
    self,
    *,
    imageRecipeArn: str,
    policy: str,
) -> PutImageRecipePolicyResponseTypeDef:  # (1)
    ...
  1. See PutImageRecipePolicyResponseTypeDef 
# put_image_recipe_policy method usage example with argument unpacking

kwargs: PutImageRecipePolicyRequestTypeDef = {  # (1)
    "imageRecipeArn": ...,
    "policy": ...,
}

parent.put_image_recipe_policy(**kwargs)
  1. See PutImageRecipePolicyRequestTypeDef

send_workflow_step_action#

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

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

# send_workflow_step_action method definition

def send_workflow_step_action(
    self,
    *,
    stepExecutionId: str,
    imageBuildVersionArn: str,
    action: WorkflowStepActionTypeType,  # (1)
    clientToken: str,
    reason: str = ...,
) -> SendWorkflowStepActionResponseTypeDef:  # (2)
    ...
  1. See WorkflowStepActionTypeType
  2. See SendWorkflowStepActionResponseTypeDef 
# send_workflow_step_action method usage example with argument unpacking

kwargs: SendWorkflowStepActionRequestTypeDef = {  # (1)
    "stepExecutionId": ...,
    "imageBuildVersionArn": ...,
    "action": ...,
    "clientToken": ...,
}

parent.send_workflow_step_action(**kwargs)
  1. See SendWorkflowStepActionRequestTypeDef

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

# start_image_pipeline_execution method definition

def start_image_pipeline_execution(
    self,
    *,
    imagePipelineArn: str,
    clientToken: str,
) -> StartImagePipelineExecutionResponseTypeDef:  # (1)
    ...
  1. See StartImagePipelineExecutionResponseTypeDef 
# start_image_pipeline_execution method usage example with argument unpacking

kwargs: StartImagePipelineExecutionRequestTypeDef = {  # (1)
    "imagePipelineArn": ...,
    "clientToken": ...,
}

parent.start_image_pipeline_execution(**kwargs)
  1. See StartImagePipelineExecutionRequestTypeDef

start_resource_state_update#

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

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

# start_resource_state_update method definition

def start_resource_state_update(
    self,
    *,
    resourceArn: str,
    state: ResourceStateTypeDef,  # (1)
    clientToken: str,
    executionRole: str = ...,
    includeResources: ResourceStateUpdateIncludeResourcesTypeDef = ...,  # (2)
    exclusionRules: ResourceStateUpdateExclusionRulesTypeDef = ...,  # (3)
    updateAt: TimestampTypeDef = ...,
) -> StartResourceStateUpdateResponseTypeDef:  # (4)
    ...
  1. See ResourceStateTypeDef
  2. See ResourceStateUpdateIncludeResourcesTypeDef
  3. See ResourceStateUpdateExclusionRulesTypeDef
  4. See StartResourceStateUpdateResponseTypeDef 
# start_resource_state_update method usage example with argument unpacking

kwargs: StartResourceStateUpdateRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "state": ...,
    "clientToken": ...,
}

parent.start_resource_state_update(**kwargs)
  1. See StartResourceStateUpdateRequestTypeDef

tag_resource#

Adds a tag to a resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes a tag from a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_distribution_configuration#

Updates a new distribution configuration.

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

# update_distribution_configuration method definition

def update_distribution_configuration(
    self,
    *,
    distributionConfigurationArn: str,
    distributions: Sequence[DistributionUnionTypeDef],  # (1)
    clientToken: str,
    description: str = ...,
) -> UpdateDistributionConfigurationResponseTypeDef:  # (2)
    ...
  1. See DistributionTypeDef DistributionOutputTypeDef
  2. See UpdateDistributionConfigurationResponseTypeDef 
# update_distribution_configuration method usage example with argument unpacking

kwargs: UpdateDistributionConfigurationRequestTypeDef = {  # (1)
    "distributionConfigurationArn": ...,
    "distributions": ...,
    "clientToken": ...,
}

parent.update_distribution_configuration(**kwargs)
  1. See UpdateDistributionConfigurationRequestTypeDef

update_image_pipeline#

Updates an image pipeline.

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

# update_image_pipeline method definition

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)
    imageScanningConfiguration: ImageScanningConfigurationUnionTypeDef = ...,  # (4)
    workflows: Sequence[WorkflowConfigurationUnionTypeDef] = ...,  # (5)
    executionRole: str = ...,
) -> UpdateImagePipelineResponseTypeDef:  # (6)
    ...
  1. See ImageTestsConfigurationTypeDef
  2. See ScheduleTypeDef
  3. See PipelineStatusType
  4. See ImageScanningConfigurationTypeDef ImageScanningConfigurationOutputTypeDef
  5. See WorkflowConfigurationTypeDef WorkflowConfigurationOutputTypeDef
  6. See UpdateImagePipelineResponseTypeDef 
# update_image_pipeline method usage example with argument unpacking

kwargs: UpdateImagePipelineRequestTypeDef = {  # (1)
    "imagePipelineArn": ...,
    "infrastructureConfigurationArn": ...,
    "clientToken": ...,
}

parent.update_image_pipeline(**kwargs)
  1. See UpdateImagePipelineRequestTypeDef

update_infrastructure_configuration#

Updates a new infrastructure configuration.

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

# update_infrastructure_configuration method definition

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)
    placement: PlacementTypeDef = ...,  # (3)
) -> UpdateInfrastructureConfigurationResponseTypeDef:  # (4)
    ...
  1. See LoggingTypeDef
  2. See InstanceMetadataOptionsTypeDef
  3. See PlacementTypeDef
  4. See UpdateInfrastructureConfigurationResponseTypeDef 
# update_infrastructure_configuration method usage example with argument unpacking

kwargs: UpdateInfrastructureConfigurationRequestTypeDef = {  # (1)
    "infrastructureConfigurationArn": ...,
    "instanceProfileName": ...,
    "clientToken": ...,
}

parent.update_infrastructure_configuration(**kwargs)
  1. See UpdateInfrastructureConfigurationRequestTypeDef

update_lifecycle_policy#

Update the specified lifecycle policy.

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

# update_lifecycle_policy method definition

def update_lifecycle_policy(
    self,
    *,
    lifecyclePolicyArn: str,
    executionRole: str,
    resourceType: LifecyclePolicyResourceTypeType,  # (1)
    policyDetails: Sequence[LifecyclePolicyDetailUnionTypeDef],  # (2)
    resourceSelection: LifecyclePolicyResourceSelectionUnionTypeDef,  # (3)
    clientToken: str,
    description: str = ...,
    status: LifecyclePolicyStatusType = ...,  # (4)
) -> UpdateLifecyclePolicyResponseTypeDef:  # (5)
    ...
  1. See LifecyclePolicyResourceTypeType
  2. See LifecyclePolicyDetailTypeDef LifecyclePolicyDetailOutputTypeDef
  3. See LifecyclePolicyResourceSelectionTypeDef LifecyclePolicyResourceSelectionOutputTypeDef
  4. See LifecyclePolicyStatusType
  5. See UpdateLifecyclePolicyResponseTypeDef 
# update_lifecycle_policy method usage example with argument unpacking

kwargs: UpdateLifecyclePolicyRequestTypeDef = {  # (1)
    "lifecyclePolicyArn": ...,
    "executionRole": ...,
    "resourceType": ...,
    "policyDetails": ...,
    "resourceSelection": ...,
    "clientToken": ...,
}

parent.update_lifecycle_policy(**kwargs)
  1. See UpdateLifecyclePolicyRequestTypeDef