Struct aws_sdk_imagebuilder::Client

pub struct Client { /* private fields */ }

Client for EC2 Image Builder

Client for invoking operations on EC2 Image Builder. Each operation on EC2 Image Builder is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_imagebuilder::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_imagebuilder::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelImageCreation operation has a Client::cancel_image_creation, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_image_creation()
    .image_build_version_arn("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_image_creation(&self) -> CancelImageCreationFluentBuilder

Constructs a fluent builder for the CancelImageCreation operation.

• The fluent builder is configurable:
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

• On success, responds with CancelImageCreationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token that was used for this request.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

• On failure, responds with SdkError<CancelImageCreationError>

impl Client

pub fn create_component(&self) -> CreateComponentFluentBuilder

Constructs a fluent builder for the CreateComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the component.

  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):

    The semantic version of the component. This version follows the semantic version syntax.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • description(impl Into<String>) / set_description(Option<String>):

    Describes the contents of the component.

  • change_description(impl Into<String>) / set_change_description(Option<String>):

    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.

  • platform(Platform) / set_platform(Option<Platform>):

    The operating system platform of the component.

  • supported_os_versions(Vec<String>) / set_supported_os_versions(Option<Vec<String>>):

    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

  • data(impl Into<String>) / set_data(Option<String>):

    Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

  • uri(impl Into<String>) / set_uri(Option<String>):

    The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

    Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

    The ID of the KMS key that is used to encrypt this component.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags that apply to the component.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token of the component.

• On success, responds with CreateComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • component_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component that was created by this request.

• On failure, responds with SdkError<CreateComponentError>

impl Client

pub fn create_container_recipe(&self) -> CreateContainerRecipeFluentBuilder

Constructs a fluent builder for the CreateContainerRecipe operation.

• The fluent builder is configurable:
  • container_type(ContainerType) / set_container_type(Option<ContainerType>):

    The type of container to create.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the container recipe.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the container recipe.

  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):

    The semantic version of the container recipe. This version follows the semantic version syntax.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • components(Vec<ComponentConfiguration>) / set_components(Option<Vec<ComponentConfiguration>>):

    Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

  • instance_configuration(InstanceConfiguration) / set_instance_configuration(Option<InstanceConfiguration>):

    A group of options that can be used to configure an instance for building and testing container images.

  • dockerfile_template_data(impl Into<String>) / set_dockerfile_template_data(Option<String>):

    The Dockerfile template used to build your image as an inline data blob.

  • dockerfile_template_uri(impl Into<String>) / set_dockerfile_template_uri(Option<String>):

    The Amazon S3 URI for the Dockerfile that will be used to build your container image.

  • platform_override(Platform) / set_platform_override(Option<Platform>):

    Specifies the operating system platform when you use a custom base image.

  • image_os_version_override(impl Into<String>) / set_image_os_version_override(Option<String>):

    Specifies the operating system version for the base image.

  • parent_image(impl Into<String>) / set_parent_image(Option<String>):

    The base image for the container recipe.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Tags that are attached to the container recipe.

  • working_directory(impl Into<String>) / set_working_directory(Option<String>):

    The working directory for use during build and test workflows.

  • target_repository(TargetContainerRepository) / set_target_repository(Option<TargetContainerRepository>):

    The destination repository for the container image.

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

    Identifies which KMS key is used to encrypt the container image.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The client token used to make this request idempotent.

• On success, responds with CreateContainerRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token used to make this request idempotent.

  • container_recipe_arn(Option<String>):

    Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

• On failure, responds with SdkError<CreateContainerRecipeError>

impl Client

pub fn create_distribution_configuration( &self ) -> CreateDistributionConfigurationFluentBuilder

Constructs a fluent builder for the CreateDistributionConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the distribution configuration.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the distribution configuration.

  • distributions(Vec<Distribution>) / set_distributions(Option<Vec<Distribution>>):

    The distributions of the distribution configuration.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the distribution configuration.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token of the distribution configuration.

• On success, responds with CreateDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

• On failure, responds with SdkError<CreateDistributionConfigurationError>

impl Client

pub fn create_image(&self) -> CreateImageFluentBuilder

Constructs a fluent builder for the CreateImage operation.

• The fluent builder is configurable:
  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

  • image_tests_configuration(ImageTestsConfiguration) / set_image_tests_configuration(Option<ImageTestsConfiguration>):

    The image tests configuration of the image.

  • enhanced_image_metadata_enabled(bool) / set_enhanced_image_metadata_enabled(Option<bool>):

    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.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the image.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with CreateImageOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image that was created by this request.

• On failure, responds with SdkError<CreateImageError>

impl Client

pub fn create_image_pipeline(&self) -> CreateImagePipelineFluentBuilder

Constructs a fluent builder for the CreateImagePipeline operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the image pipeline.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the image pipeline.

  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

  • image_tests_configuration(ImageTestsConfiguration) / set_image_tests_configuration(Option<ImageTestsConfiguration>):

    The image test configuration of the image pipeline.

  • enhanced_image_metadata_enabled(bool) / set_enhanced_image_metadata_enabled(Option<bool>):

    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.

  • schedule(Schedule) / set_schedule(Option<Schedule>):

    The schedule of the image pipeline.

  • status(PipelineStatus) / set_status(Option<PipelineStatus>):

    The status of the image pipeline.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the image pipeline.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with CreateImagePipelineOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

• On failure, responds with SdkError<CreateImagePipelineError>

impl Client

pub fn create_image_recipe(&self) -> CreateImageRecipeFluentBuilder

Constructs a fluent builder for the CreateImageRecipe operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the image recipe.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the image recipe.

  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):

    The semantic version of the image recipe. This version follows the semantic version syntax.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • components(Vec<ComponentConfiguration>) / set_components(Option<Vec<ComponentConfiguration>>):

    The components included in the image recipe.

  • parent_image(impl Into<String>) / set_parent_image(Option<String>):

    The base image of the image recipe. The value of the string can be the ARN of the base 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.

  • block_device_mappings(Vec<InstanceBlockDeviceMapping>) / set_block_device_mappings(Option<Vec<InstanceBlockDeviceMapping>>):

    The block device mappings of the image recipe.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the image recipe.

  • working_directory(impl Into<String>) / set_working_directory(Option<String>):

    The working directory used during build and test workflows.

  • additional_instance_configuration(AdditionalInstanceConfiguration) / set_additional_instance_configuration(Option<AdditionalInstanceConfiguration>):

    Specify additional settings and launch scripts for your build instances.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with CreateImageRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that was created by this request.

• On failure, responds with SdkError<CreateImageRecipeError>

impl Client

pub fn create_infrastructure_configuration( &self ) -> CreateInfrastructureConfigurationFluentBuilder

Constructs a fluent builder for the CreateInfrastructureConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the infrastructure configuration.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the infrastructure configuration.

  • instance_types(Vec<String>) / set_instance_types(Option<Vec<String>>):

    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.

  • instance_profile_name(impl Into<String>) / set_instance_profile_name(Option<String>):

    The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

  • security_group_ids(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

    The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

  • subnet_id(impl Into<String>) / set_subnet_id(Option<String>):

    The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

  • logging(Logging) / set_logging(Option<Logging>):

    The logging configuration of the infrastructure configuration.

  • key_pair(impl Into<String>) / set_key_pair(Option<String>):

    The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

  • terminate_instance_on_failure(bool) / set_terminate_instance_on_failure(Option<bool>):

    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.

  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):

    The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

    EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

  • resource_tags(HashMap<String, String>) / set_resource_tags(Option<HashMap<String, String>>):

    The tags attached to the resource created by Image Builder.

  • instance_metadata_options(InstanceMetadataOptions) / set_instance_metadata_options(Option<InstanceMetadataOptions>):

    The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the infrastructure configuration.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with CreateInfrastructureConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

• On failure, responds with SdkError<CreateInfrastructureConfigurationError>

impl Client

pub fn delete_component(&self) -> DeleteComponentFluentBuilder

Constructs a fluent builder for the DeleteComponent operation.

• The fluent builder is configurable:
  • component_build_version_arn(impl Into<String>) / set_component_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component build version to delete.

• On success, responds with DeleteComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • component_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component build version that was deleted.

• On failure, responds with SdkError<DeleteComponentError>

impl Client

pub fn delete_container_recipe(&self) -> DeleteContainerRecipeFluentBuilder

Constructs a fluent builder for the DeleteContainerRecipe operation.

• The fluent builder is configurable:
  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe to delete.

• On success, responds with DeleteContainerRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe that was deleted.

• On failure, responds with SdkError<DeleteContainerRecipeError>

impl Client

pub fn delete_distribution_configuration( &self ) -> DeleteDistributionConfigurationFluentBuilder

Constructs a fluent builder for the DeleteDistributionConfiguration operation.

• The fluent builder is configurable:
  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration to delete.

• On success, responds with DeleteDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that was deleted.

• On failure, responds with SdkError<DeleteDistributionConfigurationError>

impl Client

pub fn delete_image(&self) -> DeleteImageFluentBuilder

Constructs a fluent builder for the DeleteImage operation.

• The fluent builder is configurable:
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

• On success, responds with DeleteImageOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Image Builder image resource that was deleted.

• On failure, responds with SdkError<DeleteImageError>

impl Client

pub fn delete_image_pipeline(&self) -> DeleteImagePipelineFluentBuilder

Constructs a fluent builder for the DeleteImagePipeline operation.

• The fluent builder is configurable:
  • image_pipeline_arn(impl Into<String>) / set_image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline to delete.

• On success, responds with DeleteImagePipelineOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that was deleted.

• On failure, responds with SdkError<DeleteImagePipelineError>

impl Client

pub fn delete_image_recipe(&self) -> DeleteImageRecipeFluentBuilder

Constructs a fluent builder for the DeleteImageRecipe operation.

• The fluent builder is configurable:
  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe to delete.

• On success, responds with DeleteImageRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that was deleted.

• On failure, responds with SdkError<DeleteImageRecipeError>

impl Client

pub fn delete_infrastructure_configuration( &self ) -> DeleteInfrastructureConfigurationFluentBuilder

Constructs a fluent builder for the DeleteInfrastructureConfiguration operation.

• The fluent builder is configurable:
  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

• On success, responds with DeleteInfrastructureConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

• On failure, responds with SdkError<DeleteInfrastructureConfigurationError>

impl Client

pub fn get_component(&self) -> GetComponentFluentBuilder

Constructs a fluent builder for the GetComponent operation.

• The fluent builder is configurable:
  • component_build_version_arn(impl Into<String>) / set_component_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires “/\d+$” suffix.

• On success, responds with GetComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • component(Option<Component>):

    The component object associated with the specified ARN.

• On failure, responds with SdkError<GetComponentError>

impl Client

pub fn get_component_policy(&self) -> GetComponentPolicyFluentBuilder

Constructs a fluent builder for the GetComponentPolicy operation.

• The fluent builder is configurable:
  • component_arn(impl Into<String>) / set_component_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

• On success, responds with GetComponentPolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • policy(Option<String>):

    The component policy.

• On failure, responds with SdkError<GetComponentPolicyError>

impl Client

pub fn get_container_recipe(&self) -> GetContainerRecipeFluentBuilder

Constructs a fluent builder for the GetContainerRecipe operation.

• The fluent builder is configurable:
  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe to retrieve.

• On success, responds with GetContainerRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • container_recipe(Option<ContainerRecipe>):

    The container recipe object that is returned.

• On failure, responds with SdkError<GetContainerRecipeError>

impl Client

pub fn get_container_recipe_policy( &self ) -> GetContainerRecipePolicyFluentBuilder

Constructs a fluent builder for the GetContainerRecipePolicy operation.

• The fluent builder is configurable:
  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe for the policy being requested.

• On success, responds with GetContainerRecipePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • policy(Option<String>):

    The container recipe policy object that is returned.

• On failure, responds with SdkError<GetContainerRecipePolicyError>

impl Client

pub fn get_distribution_configuration( &self ) -> GetDistributionConfigurationFluentBuilder

Constructs a fluent builder for the GetDistributionConfiguration operation.

• The fluent builder is configurable:
  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

• On success, responds with GetDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • distribution_configuration(Option<DistributionConfiguration>):

    The distribution configuration object.

• On failure, responds with SdkError<GetDistributionConfigurationError>

impl Client

pub fn get_image(&self) -> GetImageFluentBuilder

Constructs a fluent builder for the GetImage operation.

• The fluent builder is configurable:
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image that you want to retrieve.

• On success, responds with GetImageOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image(Option<Image>):

    The image object.

• On failure, responds with SdkError<GetImageError>

impl Client

pub fn get_image_pipeline(&self) -> GetImagePipelineFluentBuilder

Constructs a fluent builder for the GetImagePipeline operation.

• The fluent builder is configurable:
  • image_pipeline_arn(impl Into<String>) / set_image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

• On success, responds with GetImagePipelineOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_pipeline(Option<ImagePipeline>):

    The image pipeline object.

• On failure, responds with SdkError<GetImagePipelineError>

impl Client

pub fn get_image_policy(&self) -> GetImagePolicyFluentBuilder

Constructs a fluent builder for the GetImagePolicy operation.

• The fluent builder is configurable:
  • image_arn(impl Into<String>) / set_image_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

• On success, responds with GetImagePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • policy(Option<String>):

    The image policy object.

• On failure, responds with SdkError<GetImagePolicyError>

impl Client

pub fn get_image_recipe(&self) -> GetImageRecipeFluentBuilder

Constructs a fluent builder for the GetImageRecipe operation.

• The fluent builder is configurable:
  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

• On success, responds with GetImageRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_recipe(Option<ImageRecipe>):

    The image recipe object.

• On failure, responds with SdkError<GetImageRecipeError>

impl Client

pub fn get_image_recipe_policy(&self) -> GetImageRecipePolicyFluentBuilder

Constructs a fluent builder for the GetImageRecipePolicy operation.

• The fluent builder is configurable:
  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.

• On success, responds with GetImageRecipePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • policy(Option<String>):

    The image recipe policy object.

• On failure, responds with SdkError<GetImageRecipePolicyError>

impl Client

pub fn get_infrastructure_configuration( &self ) -> GetInfrastructureConfigurationFluentBuilder

Constructs a fluent builder for the GetInfrastructureConfiguration operation.

• The fluent builder is configurable:
  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

• On success, responds with GetInfrastructureConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • infrastructure_configuration(Option<InfrastructureConfiguration>):

    The infrastructure configuration object.

• On failure, responds with SdkError<GetInfrastructureConfigurationError>

impl Client

pub fn import_component(&self) -> ImportComponentFluentBuilder

Constructs a fluent builder for the ImportComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the component.

  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):

    The semantic version of the component. This version follows the semantic version syntax.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the component. Describes the contents of the component.

  • change_description(impl Into<String>) / set_change_description(Option<String>):

    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.

  • r#type(ComponentType) / set_type(Option<ComponentType>):

    The type of the component denotes whether the component is used to build the image, or only to test it.

  • format(ComponentFormat) / set_format(Option<ComponentFormat>):

    The format of the resource that you want to import as a component.

  • platform(Platform) / set_platform(Option<Platform>):

    The platform of the component.

  • data(impl Into<String>) / set_data(Option<String>):

    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.

  • uri(impl Into<String>) / set_uri(Option<String>):

    The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon 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.

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

    The ID of the KMS key that should be used to encrypt this component.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags of the component.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token of the component.

• On success, responds with ImportComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • component_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the imported component.

• On failure, responds with SdkError<ImportComponentError>

impl Client

pub fn import_vm_image(&self) -> ImportVmImageFluentBuilder

Constructs a fluent builder for the ImportVmImage operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the base image that is created by the import process.

  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):

    The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • description(impl Into<String>) / set_description(Option<String>):

    The description for the base image that is created by the import process.

  • platform(Platform) / set_platform(Option<Platform>):

    The operating system platform for the imported VM.

  • os_version(impl Into<String>) / set_os_version(Option<String>):

    The operating system version for the imported VM.

  • vm_import_task_id(impl Into<String>) / set_vm_import_task_id(Option<String>):

    The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Tags that are attached to the import resources.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

• On success, responds with ImportVmImageOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_arn(Option<String>):

    The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.

  • client_token(Option<String>):

    The idempotency token that was used for this request.

• On failure, responds with SdkError<ImportVmImageError>

impl Client

pub fn list_component_build_versions( &self ) -> ListComponentBuildVersionsFluentBuilder

Constructs a fluent builder for the ListComponentBuildVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • component_version_arn(impl Into<String>) / set_component_version_arn(Option<String>):

    The component version Amazon Resource Name (ARN) whose versions you want to list.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListComponentBuildVersionsOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • component_summary_list(Option<Vec<ComponentSummary>>):

    The list of component summaries for the specified semantic version.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListComponentBuildVersionsError>

impl Client

pub fn list_components(&self) -> ListComponentsFluentBuilder

Constructs a fluent builder for the ListComponents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner(Ownership) / set_owner(Option<Ownership>):

    Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • description

    • name

    • platform

    • supportedOsVersion

    • type

    • version

  • by_name(bool) / set_by_name(bool):

    Returns the list of components for the specified name.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListComponentsOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • component_version_list(Option<Vec<ComponentVersion>>):

    The list of component semantic versions.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListComponentsError>

impl Client

pub fn list_container_recipes(&self) -> ListContainerRecipesFluentBuilder

Constructs a fluent builder for the ListContainerRecipes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner(Ownership) / set_owner(Option<Ownership>):

    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.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • containerType

    • name

    • parentImage

    • platform

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in the list.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with ListContainerRecipesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • container_recipe_summary_list(Option<Vec<ContainerRecipeSummary>>):

    The list of container recipes returned for the request.

  • next_token(Option<String>):

    The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

• On failure, responds with SdkError<ListContainerRecipesError>

impl Client

pub fn list_distribution_configurations( &self ) -> ListDistributionConfigurationsFluentBuilder

Constructs a fluent builder for the ListDistributionConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    You can filter on name to streamline results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListDistributionConfigurationsOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • distribution_configuration_summary_list(Option<Vec<DistributionConfigurationSummary>>):

    The list of distributions.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListDistributionConfigurationsError>

impl Client

pub fn list_image_build_versions(&self) -> ListImageBuildVersionsFluentBuilder

Constructs a fluent builder for the ListImageBuildVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • image_version_arn(impl Into<String>) / set_image_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • name

    • osVersion

    • platform

    • type

    • version

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListImageBuildVersionsOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_summary_list(Option<Vec<ImageSummary>>):

    The list of image build versions.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImageBuildVersionsError>

impl Client

pub fn list_image_packages(&self) -> ListImagePackagesFluentBuilder

Constructs a fluent builder for the ListImagePackages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):

    Filter results for the ListImagePackages request by the Image Build Version ARN

  • max_results(i32) / set_max_results(Option<i32>):

    The maxiumum number of results to return from the ListImagePackages request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListImagePackagesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_package_list(Option<Vec<ImagePackage>>):

    The list of Image Packages returned in the response.

  • next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On failure, responds with SdkError<ListImagePackagesError>

impl Client

pub fn list_image_pipeline_images(&self) -> ListImagePipelineImagesFluentBuilder

Constructs a fluent builder for the ListImagePipelineImages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • image_pipeline_arn(impl Into<String>) / set_image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • name

    • version

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListImagePipelineImagesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_summary_list(Option<Vec<ImageSummary>>):

    The list of images built by this pipeline.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImagePipelineImagesError>

impl Client

pub fn list_image_pipelines(&self) -> ListImagePipelinesFluentBuilder

Constructs a fluent builder for the ListImagePipelines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • description

    • distributionConfigurationArn

    • imageRecipeArn

    • infrastructureConfigurationArn

    • name

    • status

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListImagePipelinesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_pipeline_list(Option<Vec<ImagePipeline>>):

    The list of image pipelines.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImagePipelinesError>

impl Client

pub fn list_image_recipes(&self) -> ListImageRecipesFluentBuilder

Constructs a fluent builder for the ListImageRecipes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner(Ownership) / set_owner(Option<Ownership>):

    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.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • name

    • parentImage

    • platform

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListImageRecipesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_recipe_summary_list(Option<Vec<ImageRecipeSummary>>):

    The list of image pipelines.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImageRecipesError>

impl Client

pub fn list_images(&self) -> ListImagesFluentBuilder

Constructs a fluent builder for the ListImages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner(Ownership) / set_owner(Option<Ownership>):

    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.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    Use the following filters to streamline results:

    • name

    • osVersion

    • platform

    • type

    • version

  • by_name(bool) / set_by_name(bool):

    Requests a list of images with a specific recipe name.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

  • include_deprecated(bool) / set_include_deprecated(Option<bool>):

    Includes deprecated images in the response list.

• On success, responds with ListImagesOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_version_list(Option<Vec<ImageVersion>>):

    The list of image semantic versions.

    The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImagesError>

impl Client

pub fn list_infrastructure_configurations( &self ) -> ListInfrastructureConfigurationsFluentBuilder

Constructs a fluent builder for the ListInfrastructureConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    You can filter on name to streamline results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum items to return in a request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• On success, responds with ListInfrastructureConfigurationsOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • infrastructure_configuration_summary_list(Option<Vec<InfrastructureConfigurationSummary>>):

    The list of infrastructure configurations.

  • next_token(Option<String>):

    The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListInfrastructureConfigurationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The tags for the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_component_policy(&self) -> PutComponentPolicyFluentBuilder

Constructs a fluent builder for the PutComponentPolicy operation.

• The fluent builder is configurable:
  • component_arn(impl Into<String>) / set_component_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component that this policy should be applied to.

  • policy(impl Into<String>) / set_policy(Option<String>):

    The policy to apply.

• On success, responds with PutComponentPolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • component_arn(Option<String>):

    The Amazon Resource Name (ARN) of the component that this policy was applied to.

• On failure, responds with SdkError<PutComponentPolicyError>

impl Client

pub fn put_container_recipe_policy( &self ) -> PutContainerRecipePolicyFluentBuilder

Constructs a fluent builder for the PutContainerRecipePolicy operation.

• The fluent builder is configurable:
  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

  • policy(impl Into<String>) / set_policy(Option<String>):

    The policy to apply to the container recipe.

• On success, responds with PutContainerRecipePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

• On failure, responds with SdkError<PutContainerRecipePolicyError>

impl Client

pub fn put_image_policy(&self) -> PutImagePolicyFluentBuilder

Constructs a fluent builder for the PutImagePolicy operation.

• The fluent builder is configurable:
  • image_arn(impl Into<String>) / set_image_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image that this policy should be applied to.

  • policy(impl Into<String>) / set_policy(Option<String>):

    The policy to apply.

• On success, responds with PutImagePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image that this policy was applied to.

• On failure, responds with SdkError<PutImagePolicyError>

impl Client

pub fn put_image_recipe_policy(&self) -> PutImageRecipePolicyFluentBuilder

Constructs a fluent builder for the PutImageRecipePolicy operation.

• The fluent builder is configurable:
  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

  • policy(impl Into<String>) / set_policy(Option<String>):

    The policy to apply.

• On success, responds with PutImageRecipePolicyOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

• On failure, responds with SdkError<PutImageRecipePolicyError>

impl Client

pub fn start_image_pipeline_execution( &self ) -> StartImagePipelineExecutionFluentBuilder

Constructs a fluent builder for the StartImagePipelineExecution operation.

• The fluent builder is configurable:
  • image_pipeline_arn(impl Into<String>) / set_image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with StartImagePipelineExecutionOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image that was created by this request.

• On failure, responds with SdkError<StartImagePipelineExecutionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags to apply to the resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The tag keys to remove from the resource.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_distribution_configuration( &self ) -> UpdateDistributionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateDistributionConfiguration operation.

• The fluent builder is configurable:
  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the distribution configuration.

  • distributions(Vec<Distribution>) / set_distributions(Option<Vec<Distribution>>):

    The distributions of the distribution configuration.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token of the distribution configuration.

• On success, responds with UpdateDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.

• On failure, responds with SdkError<UpdateDistributionConfigurationError>

impl Client

pub fn update_image_pipeline(&self) -> UpdateImagePipelineFluentBuilder

Constructs a fluent builder for the UpdateImagePipeline operation.

• The fluent builder is configurable:
  • image_pipeline_arn(impl Into<String>) / set_image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that you want to update.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the image pipeline.

  • image_recipe_arn(impl Into<String>) / set_image_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

  • container_recipe_arn(impl Into<String>) / set_container_recipe_arn(Option<String>):

    The Amazon Resource Name (ARN) of the container pipeline to update.

  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

  • distribution_configuration_arn(impl Into<String>) / set_distribution_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

  • image_tests_configuration(ImageTestsConfiguration) / set_image_tests_configuration(Option<ImageTestsConfiguration>):

    The image test configuration of the image pipeline.

  • enhanced_image_metadata_enabled(bool) / set_enhanced_image_metadata_enabled(Option<bool>):

    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.

  • schedule(Schedule) / set_schedule(Option<Schedule>):

    The schedule of the image pipeline.

  • status(PipelineStatus) / set_status(Option<PipelineStatus>):

    The status of the image pipeline.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

• On success, responds with UpdateImagePipelineOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • image_pipeline_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

• On failure, responds with SdkError<UpdateImagePipelineError>

impl Client

pub fn update_infrastructure_configuration( &self ) -> UpdateInfrastructureConfigurationFluentBuilder

Constructs a fluent builder for the UpdateInfrastructureConfiguration operation.

• The fluent builder is configurable:
  • infrastructure_configuration_arn(impl Into<String>) / set_infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the infrastructure configuration.

  • instance_types(Vec<String>) / set_instance_types(Option<Vec<String>>):

    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.

  • instance_profile_name(impl Into<String>) / set_instance_profile_name(Option<String>):

    The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

  • security_group_ids(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

    The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

  • subnet_id(impl Into<String>) / set_subnet_id(Option<String>):

    The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

  • logging(Logging) / set_logging(Option<Logging>):

    The logging configuration of the infrastructure configuration.

  • key_pair(impl Into<String>) / set_key_pair(Option<String>):

    The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

  • terminate_instance_on_failure(bool) / set_terminate_instance_on_failure(Option<bool>):

    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.

  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):

    The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

    EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • resource_tags(HashMap<String, String>) / set_resource_tags(Option<HashMap<String, String>>):

    The tags attached to the resource created by Image Builder.

  • instance_metadata_options(InstanceMetadataOptions) / set_instance_metadata_options(Option<InstanceMetadataOptions>):

    The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

    • Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.

    • Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

• On success, responds with UpdateInfrastructureConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The idempotency token used to make this request idempotent.

  • infrastructure_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

• On failure, responds with SdkError<UpdateInfrastructureConfigurationError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.