aws_imagebuilder
EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
Summary
Functions
-
cancel_image_creation(Client, Input)
CancelImageCreation cancels the creation of Image.
- cancel_image_creation(Client, Input0, Options0)
-
create_component(Client, Input)
Creates a new component that can be used to build, validate, test, and assess your image.
- create_component(Client, Input0, Options0)
-
create_container_recipe(Client, Input)
Creates a new container recipe.
- create_container_recipe(Client, Input0, Options0)
-
create_distribution_configuration(Client, Input)
Creates a new distribution configuration.
- create_distribution_configuration(Client, Input0, Options0)
-
create_image(Client, Input)
Creates a new image.
- create_image(Client, Input0, Options0)
-
create_image_pipeline(Client, Input)
Creates a new image pipeline.
- create_image_pipeline(Client, Input0, Options0)
-
create_image_recipe(Client, Input)
Creates a new image recipe.
- create_image_recipe(Client, Input0, Options0)
-
create_infrastructure_configuration(Client, Input)
Creates a new infrastructure configuration.
- create_infrastructure_configuration(Client, Input0, Options0)
-
delete_component(Client, Input)
Deletes a component build version.
- delete_component(Client, Input0, Options0)
-
delete_container_recipe(Client, Input)
Deletes a container recipe.
- delete_container_recipe(Client, Input0, Options0)
-
delete_distribution_configuration(Client, Input)
Deletes a distribution configuration.
- delete_distribution_configuration(Client, Input0, Options0)
-
delete_image(Client, Input)
Deletes an image.
- delete_image(Client, Input0, Options0)
-
delete_image_pipeline(Client, Input)
Deletes an image pipeline.
- delete_image_pipeline(Client, Input0, Options0)
-
delete_image_recipe(Client, Input)
Deletes an image recipe.
- delete_image_recipe(Client, Input0, Options0)
-
delete_infrastructure_configuration(Client, Input)
Deletes an infrastructure configuration.
- delete_infrastructure_configuration(Client, Input0, Options0)
-
get_component(Client, ComponentBuildVersionArn)
Gets a component object.
- get_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap)
- get_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap, Options0)
-
get_component_policy(Client, ComponentArn)
Gets a component policy.
- get_component_policy(Client, ComponentArn, QueryMap, HeadersMap)
- get_component_policy(Client, ComponentArn, QueryMap, HeadersMap, Options0)
-
get_container_recipe(Client, ContainerRecipeArn)
Retrieves a container recipe.
- get_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap)
- get_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
-
get_container_recipe_policy(Client, ContainerRecipeArn)
Retrieves the policy for a container recipe.
- get_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap)
- get_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
-
get_distribution_configuration(Client, DistributionConfigurationArn)
Gets a distribution configuration.
- get_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap)
- get_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap, Options0)
-
get_image(Client, ImageBuildVersionArn)
Gets an image.
- get_image(Client, ImageBuildVersionArn, QueryMap, HeadersMap)
- get_image(Client, ImageBuildVersionArn, QueryMap, HeadersMap, Options0)
-
get_image_pipeline(Client, ImagePipelineArn)
Gets an image pipeline.
- get_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap)
- get_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap, Options0)
-
get_image_policy(Client, ImageArn)
Gets an image policy.
- get_image_policy(Client, ImageArn, QueryMap, HeadersMap)
- get_image_policy(Client, ImageArn, QueryMap, HeadersMap, Options0)
-
get_image_recipe(Client, ImageRecipeArn)
Gets an image recipe.
- get_image_recipe(Client, ImageRecipeArn, QueryMap, HeadersMap)
- get_image_recipe(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
-
get_image_recipe_policy(Client, ImageRecipeArn)
Gets an image recipe policy.
- get_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap)
- get_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
-
get_infrastructure_configuration(Client, InfrastructureConfigurationArn)
Gets an infrastructure configuration.
- get_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap)
- get_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap, Options0)
-
import_component(Client, Input)
Imports a component and transforms its data into a component document.
- import_component(Client, Input0, Options0)
-
list_component_build_versions(Client, Input)
Returns the list of component build versions for the specified semantic version.
- list_component_build_versions(Client, Input0, Options0)
-
list_components(Client, Input)
Returns the list of component build versions for the specified semantic version.
- list_components(Client, Input0, Options0)
-
list_container_recipes(Client, Input)
Returns a list of container recipes.
- list_container_recipes(Client, Input0, Options0)
-
list_distribution_configurations(Client, Input)
Returns a list of distribution configurations.
- list_distribution_configurations(Client, Input0, Options0)
-
list_image_build_versions(Client, Input)
Returns a list of image build versions.
- list_image_build_versions(Client, Input0, Options0)
-
list_image_packages(Client, Input)
List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.
- list_image_packages(Client, Input0, Options0)
-
list_image_pipeline_images(Client, Input)
Returns a list of images created by the specified pipeline.
- list_image_pipeline_images(Client, Input0, Options0)
-
list_image_pipelines(Client, Input)
Returns a list of image pipelines.
- list_image_pipelines(Client, Input0, Options0)
-
list_image_recipes(Client, Input)
Returns a list of image recipes.
- list_image_recipes(Client, Input0, Options0)
-
list_images(Client, Input)
Returns the list of images that you have access to.
- list_images(Client, Input0, Options0)
-
list_infrastructure_configurations(Client, Input)
Returns a list of infrastructure configurations.
- list_infrastructure_configurations(Client, Input0, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Returns the list of tags for the specified resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
put_component_policy(Client, Input)
Applies a policy to a component.
- put_component_policy(Client, Input0, Options0)
-
put_container_recipe_policy(Client, Input)
Applies a policy to a container image.
- put_container_recipe_policy(Client, Input0, Options0)
-
put_image_policy(Client, Input)
Applies a policy to an image.
- put_image_policy(Client, Input0, Options0)
-
put_image_recipe_policy(Client, Input)
Applies a policy to an image recipe.
- put_image_recipe_policy(Client, Input0, Options0)
-
start_image_pipeline_execution(Client, Input)
Manually triggers a pipeline to create an image.
- start_image_pipeline_execution(Client, Input0, Options0)
-
tag_resource(Client, ResourceArn, Input)
Adds a tag to a resource.
- tag_resource(Client, ResourceArn, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Removes a tag from a resource.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_distribution_configuration(Client, Input)
Updates a new distribution configuration.
- update_distribution_configuration(Client, Input0, Options0)
-
update_image_pipeline(Client, Input)
Updates a new image pipeline.
- update_image_pipeline(Client, Input0, Options0)
-
update_infrastructure_configuration(Client, Input)
Updates a new infrastructure configuration.
- update_infrastructure_configuration(Client, Input0, Options0)
Functions
cancel_image_creation(Client, Input)
CancelImageCreation cancels the creation of Image.
This operation can only be used on images in a non-terminal state.cancel_image_creation(Client, Input0, Options0)
create_component(Client, Input)
Creates a new component that can be used to build, validate, test, and assess your image.
create_component(Client, Input0, Options0)
create_container_recipe(Client, Input)
Creates a new container recipe.
Container recipes define how images are configured, tested, and assessed.create_container_recipe(Client, Input0, Options0)
create_distribution_configuration(Client, Input)
Creates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.create_distribution_configuration(Client, Input0, Options0)
create_image(Client, Input)
Creates a new image.
This request will create a new image along with all of the configured output resources defined in the distribution configuration.create_image(Client, Input0, Options0)
create_image_pipeline(Client, Input)
Creates a new image pipeline.
Image pipelines enable you to automate the creation and distribution of images.create_image_pipeline(Client, Input0, Options0)
create_image_recipe(Client, Input)
Creates a new image recipe.
Image recipes define how images are configured, tested, and assessed.create_image_recipe(Client, Input0, Options0)
create_infrastructure_configuration(Client, Input)
Creates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.create_infrastructure_configuration(Client, Input0, Options0)
delete_component(Client, Input)
Deletes a component build version.
delete_component(Client, Input0, Options0)
delete_container_recipe(Client, Input)
Deletes a container recipe.
delete_container_recipe(Client, Input0, Options0)
delete_distribution_configuration(Client, Input)
Deletes a distribution configuration.
delete_distribution_configuration(Client, Input0, Options0)
delete_image(Client, Input)
Deletes an image.
delete_image(Client, Input0, Options0)
delete_image_pipeline(Client, Input)
Deletes an image pipeline.
delete_image_pipeline(Client, Input0, Options0)
delete_image_recipe(Client, Input)
Deletes an image recipe.
delete_image_recipe(Client, Input0, Options0)
delete_infrastructure_configuration(Client, Input)
Deletes an infrastructure configuration.
delete_infrastructure_configuration(Client, Input0, Options0)
get_component(Client, ComponentBuildVersionArn)
Gets a component object.
get_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap)
get_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap, Options0)
get_component_policy(Client, ComponentArn)
Gets a component policy.
get_component_policy(Client, ComponentArn, QueryMap, HeadersMap)
get_component_policy(Client, ComponentArn, QueryMap, HeadersMap, Options0)
get_container_recipe(Client, ContainerRecipeArn)
Retrieves a container recipe.
get_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap)
get_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
get_container_recipe_policy(Client, ContainerRecipeArn)
Retrieves the policy for a container recipe.
get_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap)
get_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
get_distribution_configuration(Client, DistributionConfigurationArn)
Gets a distribution configuration.
get_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap)
get_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap, Options0)
get_image(Client, ImageBuildVersionArn)
Gets an image.
get_image(Client, ImageBuildVersionArn, QueryMap, HeadersMap)
get_image(Client, ImageBuildVersionArn, QueryMap, HeadersMap, Options0)
get_image_pipeline(Client, ImagePipelineArn)
Gets an image pipeline.
get_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap)
get_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap, Options0)
get_image_policy(Client, ImageArn)
Gets an image policy.
get_image_policy(Client, ImageArn, QueryMap, HeadersMap)
get_image_policy(Client, ImageArn, QueryMap, HeadersMap, Options0)
get_image_recipe(Client, ImageRecipeArn)
Gets an image recipe.
get_image_recipe(Client, ImageRecipeArn, QueryMap, HeadersMap)
get_image_recipe(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
get_image_recipe_policy(Client, ImageRecipeArn)
Gets an image recipe policy.
get_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap)
get_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
get_infrastructure_configuration(Client, InfrastructureConfigurationArn)
Gets an infrastructure configuration.
get_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap)
get_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap, Options0)
import_component(Client, Input)
Imports a component and transforms its data into a component document.
import_component(Client, Input0, Options0)
list_component_build_versions(Client, Input)
Returns the list of component build versions for the specified semantic version.
list_component_build_versions(Client, Input0, Options0)
list_components(Client, Input)
Returns the list of component build versions for the specified semantic version.
list_components(Client, Input0, Options0)
list_container_recipes(Client, Input)
Returns a list of container recipes.
list_container_recipes(Client, Input0, Options0)
list_distribution_configurations(Client, Input)
Returns a list of distribution configurations.
list_distribution_configurations(Client, Input0, Options0)
list_image_build_versions(Client, Input)
Returns a list of image build versions.
list_image_build_versions(Client, Input0, Options0)
list_image_packages(Client, Input)
List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.
list_image_packages(Client, Input0, Options0)
list_image_pipeline_images(Client, Input)
Returns a list of images created by the specified pipeline.
list_image_pipeline_images(Client, Input0, Options0)
list_image_pipelines(Client, Input)
Returns a list of image pipelines.
list_image_pipelines(Client, Input0, Options0)
list_image_recipes(Client, Input)
Returns a list of image recipes.
list_image_recipes(Client, Input0, Options0)
list_images(Client, Input)
Returns the list of images that you have access to.
list_images(Client, Input0, Options0)
list_infrastructure_configurations(Client, Input)
Returns a list of infrastructure configurations.
list_infrastructure_configurations(Client, Input0, Options0)
list_tags_for_resource(Client, ResourceArn)
Returns the list of tags for the specified resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
put_component_policy(Client, Input)
Applies a policy to a component.
We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder APIPutComponentPolicy
, you
must also call the RAM API PromoteResourceShareCreatedFromPolicy in order
for the resource to be visible to all principals with whom the resource is
shared.
put_component_policy(Client, Input0, Options0)
put_container_recipe_policy(Client, Input)
Applies a policy to a container image.
We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder APIPutContainerImagePolicy
, you must also call the RAM API
PromoteResourceShareCreatedFromPolicy
(https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html)
in order for the resource to be visible to all principals with whom the
resource is shared.
put_container_recipe_policy(Client, Input0, Options0)
put_image_policy(Client, Input)
Applies a policy to an image.
We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder APIPutImagePolicy
, you must
also call the RAM API PromoteResourceShareCreatedFromPolicy in order for
the resource to be visible to all principals with whom the resource is
shared.
put_image_policy(Client, Input0, Options0)
put_image_recipe_policy(Client, Input)
Applies a policy to an image recipe.
We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder APIPutImageRecipePolicy
, you
must also call the RAM API PromoteResourceShareCreatedFromPolicy in order
for the resource to be visible to all principals with whom the resource is
shared.
put_image_recipe_policy(Client, Input0, Options0)
start_image_pipeline_execution(Client, Input)
Manually triggers a pipeline to create an image.
start_image_pipeline_execution(Client, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
Adds a tag to a resource.
tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Removes a tag from a resource.
untag_resource(Client, ResourceArn, Input0, Options0)
update_distribution_configuration(Client, Input)
Updates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.update_distribution_configuration(Client, Input0, Options0)
update_image_pipeline(Client, Input)
Updates a new image pipeline.
Image pipelines enable you to automate the creation and distribution of images.update_image_pipeline(Client, Input0, Options0)
update_infrastructure_configuration(Client, Input)
Updates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.