Imagebuilder
This page documents function available when using the Imagebuilder
module, created with @service Imagebuilder
.
Index
Main.Imagebuilder.cancel_image_creation
Main.Imagebuilder.create_component
Main.Imagebuilder.create_container_recipe
Main.Imagebuilder.create_distribution_configuration
Main.Imagebuilder.create_image
Main.Imagebuilder.create_image_pipeline
Main.Imagebuilder.create_image_recipe
Main.Imagebuilder.create_infrastructure_configuration
Main.Imagebuilder.delete_component
Main.Imagebuilder.delete_container_recipe
Main.Imagebuilder.delete_distribution_configuration
Main.Imagebuilder.delete_image
Main.Imagebuilder.delete_image_pipeline
Main.Imagebuilder.delete_image_recipe
Main.Imagebuilder.delete_infrastructure_configuration
Main.Imagebuilder.get_component
Main.Imagebuilder.get_component_policy
Main.Imagebuilder.get_container_recipe
Main.Imagebuilder.get_container_recipe_policy
Main.Imagebuilder.get_distribution_configuration
Main.Imagebuilder.get_image
Main.Imagebuilder.get_image_pipeline
Main.Imagebuilder.get_image_policy
Main.Imagebuilder.get_image_recipe
Main.Imagebuilder.get_image_recipe_policy
Main.Imagebuilder.get_infrastructure_configuration
Main.Imagebuilder.import_component
Main.Imagebuilder.list_component_build_versions
Main.Imagebuilder.list_components
Main.Imagebuilder.list_container_recipes
Main.Imagebuilder.list_distribution_configurations
Main.Imagebuilder.list_image_build_versions
Main.Imagebuilder.list_image_packages
Main.Imagebuilder.list_image_pipeline_images
Main.Imagebuilder.list_image_pipelines
Main.Imagebuilder.list_image_recipes
Main.Imagebuilder.list_images
Main.Imagebuilder.list_infrastructure_configurations
Main.Imagebuilder.list_tags_for_resource
Main.Imagebuilder.put_component_policy
Main.Imagebuilder.put_container_recipe_policy
Main.Imagebuilder.put_image_policy
Main.Imagebuilder.put_image_recipe_policy
Main.Imagebuilder.start_image_pipeline_execution
Main.Imagebuilder.tag_resource
Main.Imagebuilder.untag_resource
Main.Imagebuilder.update_distribution_configuration
Main.Imagebuilder.update_image_pipeline
Main.Imagebuilder.update_infrastructure_configuration
Documentation
Main.Imagebuilder.cancel_image_creation
— Methodcancel_image_creation(client_token, image_build_version_arn)
cancel_image_creation(client_token, image_build_version_arn, params::Dict{String,<:Any})
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
Arguments
client_token
: The idempotency token used to make this request idempotent.image_build_version_arn
: The Amazon Resource Name (ARN) of the image whose creation you want to cancel.
Main.Imagebuilder.create_component
— Methodcreate_component(client_token, name, platform, semantic_version)
create_component(client_token, name, platform, semantic_version, params::Dict{String,<:Any})
Creates a new component that can be used to build, validate, test, and assess your image.
Arguments
client_token
: The idempotency token of the component.name
: The name of the component.platform
: The platform of the component.semantic_version
: The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"changeDescription"
: The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component."data"
: The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component."description"
: The description of the component. Describes the contents of the component."kmsKeyId"
: The ID of the KMS key that should be used to encrypt this component."supportedOsVersions"
: The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation."tags"
: The tags of the component."uri"
: The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
Main.Imagebuilder.create_container_recipe
— Methodcreate_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository)
create_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository, params::Dict{String,<:Any})
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
Arguments
client_token
: The client token used to make this request idempotent.components
: Components for build and test that are included in the container recipe.container_type
: The type of container to create.name
: The name of the container recipe.parent_image
: The source image for the container recipe.semantic_version
: The semantic version of the container recipe (<major>.<minor>.<patch>).target_repository
: The destination repository for the container image.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: The description of the container recipe."dockerfileTemplateData"
: The Dockerfile template used to build your image as an inline data blob."dockerfileTemplateUri"
: The S3 URI for the Dockerfile that will be used to build your container image."imageOsVersionOverride"
: Specifies the operating system version for the source image."instanceConfiguration"
: A group of options that can be used to configure an instance for building and testing container images."kmsKeyId"
: Identifies which KMS key is used to encrypt the container image."platformOverride"
: Specifies the operating system platform when you use a custom source image."tags"
: Tags that are attached to the container recipe."workingDirectory"
: The working directory for use during build and test workflows.
Main.Imagebuilder.create_distribution_configuration
— Methodcreate_distribution_configuration(client_token, distributions, name)
create_distribution_configuration(client_token, distributions, name, params::Dict{String,<:Any})
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
Arguments
client_token
: The idempotency token of the distribution configuration.distributions
: The distributions of the distribution configuration.name
: The name of the distribution configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: The description of the distribution configuration."tags"
: The tags of the distribution configuration.
Main.Imagebuilder.create_image
— Methodcreate_image(client_token, infrastructure_configuration_arn)
create_image(client_token, infrastructure_configuration_arn, params::Dict{String,<:Any})
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
Arguments
client_token
: The idempotency token used to make this request idempotent.infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"containerRecipeArn"
: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested."distributionConfigurationArn"
: The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline."enhancedImageMetadataEnabled"
: Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default."imageRecipeArn"
: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed."imageTestsConfiguration"
: The image tests configuration of the image."tags"
: The tags of the image.
Main.Imagebuilder.create_image_pipeline
— Methodcreate_image_pipeline(client_token, infrastructure_configuration_arn, name)
create_image_pipeline(client_token, infrastructure_configuration_arn, name, params::Dict{String,<:Any})
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
Arguments
client_token
: The idempotency token used to make this request idempotent.infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.name
: The name of the image pipeline.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"containerRecipeArn"
: The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline."description"
: The description of the image pipeline."distributionConfigurationArn"
: The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline."enhancedImageMetadataEnabled"
: Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default."imageRecipeArn"
: The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline."imageTestsConfiguration"
: The image test configuration of the image pipeline."schedule"
: The schedule of the image pipeline."status"
: The status of the image pipeline."tags"
: The tags of the image pipeline.
Main.Imagebuilder.create_image_recipe
— Methodcreate_image_recipe(client_token, components, name, parent_image, semantic_version)
create_image_recipe(client_token, components, name, parent_image, semantic_version, params::Dict{String,<:Any})
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
Arguments
client_token
: The idempotency token used to make this request idempotent.components
: The components of the image recipe.name
: The name of the image recipe.parent_image
: The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.semantic_version
: The semantic version of the image recipe.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"blockDeviceMappings"
: The block device mappings of the image recipe."description"
: The description of the image recipe."tags"
: The tags of the image recipe."workingDirectory"
: The working directory to be used during build and test workflows.
Main.Imagebuilder.create_infrastructure_configuration
— Methodcreate_infrastructure_configuration(client_token, instance_profile_name, name)
create_infrastructure_configuration(client_token, instance_profile_name, name, params::Dict{String,<:Any})
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
Arguments
client_token
: The idempotency token used to make this request idempotent.instance_profile_name
: The instance profile to associate with the instance used to customize your EC2 AMI.name
: The name of the infrastructure configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: The description of the infrastructure configuration."instanceTypes"
: The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability."keyPair"
: The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image."logging"
: The logging configuration of the infrastructure configuration."resourceTags"
: The tags attached to the resource created by Image Builder."securityGroupIds"
: The security group IDs to associate with the instance used to customize your EC2 AMI."snsTopicArn"
: The SNS topic on which to send image build events."subnetId"
: The subnet ID in which to place the instance used to customize your EC2 AMI."tags"
: The tags of the infrastructure configuration."terminateInstanceOnFailure"
: The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
Main.Imagebuilder.delete_component
— Methoddelete_component(component_build_version_arn)
delete_component(component_build_version_arn, params::Dict{String,<:Any})
Deletes a component build version.
Arguments
component_build_version_arn
: The Amazon Resource Name (ARN) of the component build version to delete.
Main.Imagebuilder.delete_container_recipe
— Methoddelete_container_recipe(container_recipe_arn)
delete_container_recipe(container_recipe_arn, params::Dict{String,<:Any})
Deletes a container recipe.
Arguments
container_recipe_arn
: The Amazon Resource Name (ARN) of the container recipe to delete.
Main.Imagebuilder.delete_distribution_configuration
— Methoddelete_distribution_configuration(distribution_configuration_arn)
delete_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})
Deletes a distribution configuration.
Arguments
distribution_configuration_arn
: The Amazon Resource Name (ARN) of the distribution configuration to delete.
Main.Imagebuilder.delete_image
— Methoddelete_image(image_build_version_arn)
delete_image(image_build_version_arn, params::Dict{String,<:Any})
Deletes an image.
Arguments
image_build_version_arn
: The Amazon Resource Name (ARN) of the image to delete.
Main.Imagebuilder.delete_image_pipeline
— Methoddelete_image_pipeline(image_pipeline_arn)
delete_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})
Deletes an image pipeline.
Arguments
image_pipeline_arn
: The Amazon Resource Name (ARN) of the image pipeline to delete.
Main.Imagebuilder.delete_image_recipe
— Methoddelete_image_recipe(image_recipe_arn)
delete_image_recipe(image_recipe_arn, params::Dict{String,<:Any})
Deletes an image recipe.
Arguments
image_recipe_arn
: The Amazon Resource Name (ARN) of the image recipe to delete.
Main.Imagebuilder.delete_infrastructure_configuration
— Methoddelete_infrastructure_configuration(infrastructure_configuration_arn)
delete_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})
Deletes an infrastructure configuration.
Arguments
infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
Main.Imagebuilder.get_component
— Methodget_component(component_build_version_arn)
get_component(component_build_version_arn, params::Dict{String,<:Any})
Gets a component object.
Arguments
component_build_version_arn
: The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/d+" suffix.
Main.Imagebuilder.get_component_policy
— Methodget_component_policy(component_arn)
get_component_policy(component_arn, params::Dict{String,<:Any})
Gets a component policy.
Arguments
component_arn
: The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
Main.Imagebuilder.get_container_recipe
— Methodget_container_recipe(container_recipe_arn)
get_container_recipe(container_recipe_arn, params::Dict{String,<:Any})
Retrieves a container recipe.
Arguments
container_recipe_arn
: The Amazon Resource Name (ARN) of the container recipe to retrieve.
Main.Imagebuilder.get_container_recipe_policy
— Methodget_container_recipe_policy(container_recipe_arn)
get_container_recipe_policy(container_recipe_arn, params::Dict{String,<:Any})
Retrieves the policy for a container recipe.
Arguments
container_recipe_arn
: The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
Main.Imagebuilder.get_distribution_configuration
— Methodget_distribution_configuration(distribution_configuration_arn)
get_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})
Gets a distribution configuration.
Arguments
distribution_configuration_arn
: The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
Main.Imagebuilder.get_image
— Methodget_image(image_build_version_arn)
get_image(image_build_version_arn, params::Dict{String,<:Any})
Gets an image.
Arguments
image_build_version_arn
: The Amazon Resource Name (ARN) of the image that you want to retrieve.
Main.Imagebuilder.get_image_pipeline
— Methodget_image_pipeline(image_pipeline_arn)
get_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})
Gets an image pipeline.
Arguments
image_pipeline_arn
: The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
Main.Imagebuilder.get_image_policy
— Methodget_image_policy(image_arn)
get_image_policy(image_arn, params::Dict{String,<:Any})
Gets an image policy.
Arguments
image_arn
: The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
Main.Imagebuilder.get_image_recipe
— Methodget_image_recipe(image_recipe_arn)
get_image_recipe(image_recipe_arn, params::Dict{String,<:Any})
Gets an image recipe.
Arguments
image_recipe_arn
: The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
Main.Imagebuilder.get_image_recipe_policy
— Methodget_image_recipe_policy(image_recipe_arn)
get_image_recipe_policy(image_recipe_arn, params::Dict{String,<:Any})
Gets an image recipe policy.
Arguments
image_recipe_arn
: The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
Main.Imagebuilder.get_infrastructure_configuration
— Methodget_infrastructure_configuration(infrastructure_configuration_arn)
get_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})
Gets an infrastructure configuration.
Arguments
infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
Main.Imagebuilder.import_component
— Methodimport_component(client_token, format, name, platform, semantic_version, type)
import_component(client_token, format, name, platform, semantic_version, type, params::Dict{String,<:Any})
Imports a component and transforms its data into a component document.
Arguments
client_token
: The idempotency token of the component.format
: The format of the resource that you want to import as a component.name
: The name of the component.platform
: The platform of the component.semantic_version
: The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).type
: The type of the component denotes whether the component is used to build the image or only to test it.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"changeDescription"
: The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component."data"
: The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component."description"
: The description of the component. Describes the contents of the component."kmsKeyId"
: The ID of the KMS key that should be used to encrypt this component."tags"
: The tags of the component."uri"
: The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
Main.Imagebuilder.list_component_build_versions
— Methodlist_component_build_versions(component_version_arn)
list_component_build_versions(component_version_arn, params::Dict{String,<:Any})
Returns the list of component build versions for the specified semantic version.
Arguments
component_version_arn
: The component version Amazon Resource Name (ARN) whose versions you want to list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_components
— Methodlist_components()
list_components(params::Dict{String,<:Any})
Returns the list of component build versions for the specified semantic version.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"byName"
: Returns the list of component build versions for the specified semantic version."filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response."owner"
: The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.
Main.Imagebuilder.list_container_recipes
— Methodlist_container_recipes()
list_container_recipes(params::Dict{String,<:Any})
Returns a list of container recipes.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: Request filters that are used to narrow the list of container images that are returned."maxResults"
: The maximum number of results to return in the list."nextToken"
: Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request."owner"
: Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.
Main.Imagebuilder.list_distribution_configurations
— Methodlist_distribution_configurations()
list_distribution_configurations(params::Dict{String,<:Any})
Returns a list of distribution configurations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters. name - The name of this distribution configuration."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_build_versions
— Methodlist_image_build_versions(image_version_arn)
list_image_build_versions(image_version_arn, params::Dict{String,<:Any})
Returns a list of image build versions.
Arguments
image_version_arn
: The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_packages
— Methodlist_image_packages(image_build_version_arn)
list_image_packages(image_build_version_arn, params::Dict{String,<:Any})
List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.
Arguments
image_build_version_arn
: Filter results for the ListImagePackages request by the Image Build Version ARN
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maxiumum number of results to return from the ListImagePackages request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_pipeline_images
— Methodlist_image_pipeline_images(image_pipeline_arn)
list_image_pipeline_images(image_pipeline_arn, params::Dict{String,<:Any})
Returns a list of images created by the specified pipeline.
Arguments
image_pipeline_arn
: The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_pipelines
— Methodlist_image_pipelines()
list_image_pipelines(params::Dict{String,<:Any})
Returns a list of image pipelines.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_recipes
— Methodlist_image_recipes()
list_image_recipes(params::Dict{String,<:Any})
Returns a list of image recipes.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response."owner"
: The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
Main.Imagebuilder.list_images
— Methodlist_images()
list_images(params::Dict{String,<:Any})
Returns the list of images that you have access to.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"byName"
: Requests a list of images with a specific recipe name."filters"
: The filters."includeDeprecated"
: Includes deprecated images in the response list."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response."owner"
: The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
Main.Imagebuilder.list_infrastructure_configurations
— Methodlist_infrastructure_configurations()
list_infrastructure_configurations(params::Dict{String,<:Any})
Returns a list of infrastructure configurations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filters"
: The filters."maxResults"
: The maximum items to return in a request."nextToken"
: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_tags_for_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns the list of tags for the specified resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
Main.Imagebuilder.put_component_policy
— Methodput_component_policy(component_arn, policy)
put_component_policy(component_arn, policy, params::Dict{String,<:Any})
Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, 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.
Arguments
component_arn
: The Amazon Resource Name (ARN) of the component that this policy should be applied to.policy
: The policy to apply.
Main.Imagebuilder.put_container_recipe_policy
— Methodput_container_recipe_policy(container_recipe_arn, policy)
put_container_recipe_policy(container_recipe_arn, policy, params::Dict{String,<:Any})
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/APICreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/APIPromoteResourceShareCreatedFromPoli cy.html) in order for the resource to be visible to all principals with whom the resource is shared.
Arguments
container_recipe_arn
: The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.policy
: The policy to apply to the container recipe.
Main.Imagebuilder.put_image_policy
— Methodput_image_policy(image_arn, policy)
put_image_policy(image_arn, policy, params::Dict{String,<:Any})
Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, 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.
Arguments
image_arn
: The Amazon Resource Name (ARN) of the image that this policy should be applied to.policy
: The policy to apply.
Main.Imagebuilder.put_image_recipe_policy
— Methodput_image_recipe_policy(image_recipe_arn, policy)
put_image_recipe_policy(image_recipe_arn, policy, params::Dict{String,<:Any})
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 API PutImageRecipePolicy, 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.
Arguments
image_recipe_arn
: The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.policy
: The policy to apply.
Main.Imagebuilder.start_image_pipeline_execution
— Methodstart_image_pipeline_execution(client_token, image_pipeline_arn)
start_image_pipeline_execution(client_token, image_pipeline_arn, params::Dict{String,<:Any})
Manually triggers a pipeline to create an image.
Arguments
client_token
: The idempotency token used to make this request idempotent.image_pipeline_arn
: The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
Main.Imagebuilder.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds a tag to a resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource that you want to tag.tags
: The tags to apply to the resource.
Main.Imagebuilder.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from a resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource that you want to untag.tag_keys
: The tag keys to remove from the resource.
Main.Imagebuilder.update_distribution_configuration
— Methodupdate_distribution_configuration(client_token, distribution_configuration_arn, distributions)
update_distribution_configuration(client_token, distribution_configuration_arn, distributions, params::Dict{String,<:Any})
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
Arguments
client_token
: The idempotency token of the distribution configuration.distribution_configuration_arn
: The Amazon Resource Name (ARN) of the distribution configuration that you want to update.distributions
: The distributions of the distribution configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: The description of the distribution configuration.
Main.Imagebuilder.update_image_pipeline
— Methodupdate_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn)
update_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn, params::Dict{String,<:Any})
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.
Arguments
client_token
: The idempotency token used to make this request idempotent.image_pipeline_arn
: The Amazon Resource Name (ARN) of the image pipeline that you want to update.infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"containerRecipeArn"
: The Amazon Resource Name (ARN) of the container pipeline to update."description"
: The description of the image pipeline."distributionConfigurationArn"
: The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline."enhancedImageMetadataEnabled"
: Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default."imageRecipeArn"
: The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline."imageTestsConfiguration"
: The image test configuration of the image pipeline."schedule"
: The schedule of the image pipeline."status"
: The status of the image pipeline.
Main.Imagebuilder.update_infrastructure_configuration
— Methodupdate_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name)
update_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name, params::Dict{String,<:Any})
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
Arguments
client_token
: The idempotency token used to make this request idempotent.infrastructure_configuration_arn
: The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.instance_profile_name
: The instance profile to associate with the instance used to customize your EC2 AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: The description of the infrastructure configuration."instanceTypes"
: The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability."keyPair"
: The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image."logging"
: The logging configuration of the infrastructure configuration."resourceTags"
: The tags attached to the resource created by Image Builder."securityGroupIds"
: The security group IDs to associate with the instance used to customize your EC2 AMI."snsTopicArn"
: The SNS topic on which to send image build events."subnetId"
: The subnet ID to place the instance used to customize your EC2 AMI in."terminateInstanceOnFailure"
: The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.