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 values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder 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 send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_image_creation()
    .image_build_version_arn("example")
    .send()
    .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>):
    required: true
    

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

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

    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 client token that uniquely identifies the request.

  • image_build_version_arn(Option<String>):

    The ARN of the image whose creation this request canceled.

• On failure, responds with SdkError<CancelImageCreationError>

impl Client

pub fn cancel_lifecycle_execution( &self, ) -> CancelLifecycleExecutionFluentBuilder

Constructs a fluent builder for the CancelLifecycleExecution operation.

• The fluent builder is configurable:
  • lifecycle_execution_id(impl Into<String>) / set_lifecycle_execution_id(Option<String>):
    required: true
    

    Identifies the specific runtime instance of the image lifecycle to cancel.

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

    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 CancelLifecycleExecutionOutput with field(s):
  • lifecycle_execution_id(Option<String>):

    The unique identifier for the image lifecycle runtime instance that was canceled.

• On failure, responds with SdkError<CancelLifecycleExecutionError>

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>):
    required: true
    

    The name of the component.

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

    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>):
    required: false
    

    Describes the contents of the component.

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

    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 the component.

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

    The operating system platform of the component.

    
    
  • supported_os_versions(impl Into<String>) / set_supported_os_versions(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags that apply to the component.

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

    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 CreateComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • component_build_version_arn(Option<String>):

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

• 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>):
    required: true
    

    The type of container to create.

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

    The name of the container recipe.

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

    The description of the container recipe.

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

    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(ComponentConfiguration) / set_components(Option<Vec::<ComponentConfiguration>>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

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

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

    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>):
    required: false
    

    Specifies the operating system version for the base image.

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

    The base image for the container recipe.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags that are attached to the container recipe.

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

    The working directory for use during build and test workflows.

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

    The destination repository for the container image.

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

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

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

    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 CreateContainerRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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>):
    required: true
    

    The name of the distribution configuration.

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

    The description of the distribution configuration.

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

    The distributions of the distribution configuration.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the distribution configuration.

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

    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 CreateDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: false
    

    The image tests configuration of the image.

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

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the image.

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

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

    
    
  • image_scanning_configuration(ImageScanningConfiguration) / set_image_scanning_configuration(Option<ImageScanningConfiguration>):
    required: false
    

    Contains settings for vulnerability scans.

    
    
  • workflows(WorkflowConfiguration) / set_workflows(Option<Vec::<WorkflowConfiguration>>):
    required: false
    

    Contains an array of workflow configuration objects.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: false
    

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

    
    
• 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 client token that uniquely identifies the request.

  • image_build_version_arn(Option<String>):

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

• 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>):
    required: true
    

    The name of the image pipeline.

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

    The description of the image pipeline.

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

    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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    The image test configuration of the image pipeline.

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

    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>):
    required: false
    

    The schedule of the image pipeline.

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

    The status of the image pipeline.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the image pipeline.

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

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

    
    
  • image_scanning_configuration(ImageScanningConfiguration) / set_image_scanning_configuration(Option<ImageScanningConfiguration>):
    required: false
    

    Contains settings for vulnerability scans.

    
    
  • workflows(WorkflowConfiguration) / set_workflows(Option<Vec::<WorkflowConfiguration>>):
    required: false
    

    Contains an array of workflow configuration objects.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: false
    

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

    
    
• 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 client token that uniquely identifies the request.

  • 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>):
    required: true
    

    The name of the image recipe.

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

    The description of the image recipe.

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

    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(ComponentConfiguration) / set_components(Option<Vec::<ComponentConfiguration>>):
    required: true
    

    The components included in the image recipe.

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

    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(InstanceBlockDeviceMapping) / set_block_device_mappings(Option<Vec::<InstanceBlockDeviceMapping>>):
    required: false
    

    The block device mappings of the image recipe.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the image recipe.

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

    The working directory used during build and test workflows.

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

    Specify additional settings and launch scripts for your build instances.

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

    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 CreateImageRecipeOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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>):
    required: true
    

    The name of the infrastructure configuration.

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

    The description of the infrastructure configuration.

    
    
  • instance_types(impl Into<String>) / set_instance_types(Option<Vec::<String>>):
    required: false
    

    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>):
    required: true
    

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

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

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

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

    The logging configuration of the infrastructure configuration.

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

    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>):
    required: false
    

    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>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_resource_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags attached to the resource created by Image Builder.

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the infrastructure configuration.

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

    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 CreateInfrastructureConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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 create_lifecycle_policy(&self) -> CreateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the CreateLifecyclePolicy operation.

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

    The name of the lifecycle policy to create.

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

    Optional description for the lifecycle policy.

    
    
  • status(LifecyclePolicyStatus) / set_status(Option<LifecyclePolicyStatus>):
    required: false
    

    Indicates whether the lifecycle policy resource is enabled.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

    
    
  • resource_type(LifecyclePolicyResourceType) / set_resource_type(Option<LifecyclePolicyResourceType>):
    required: true
    

    The type of Image Builder resource that the lifecycle policy applies to.

    
    
  • policy_details(LifecyclePolicyDetail) / set_policy_details(Option<Vec::<LifecyclePolicyDetail>>):
    required: true
    

    Configuration details for the lifecycle policy rules.

    
    
  • resource_selection(LifecyclePolicyResourceSelection) / set_resource_selection(Option<LifecyclePolicyResourceSelection>):
    required: true
    

    Selection criteria for the resources that the lifecycle policy applies to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags to apply to the lifecycle policy resource.

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

    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 CreateLifecyclePolicyOutput with field(s):
  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • lifecycle_policy_arn(Option<String>):

    The Amazon Resource Name (ARN) of the lifecycle policy that the request created.

• On failure, responds with SdkError<CreateLifecyclePolicyError>

impl Client

pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder

Constructs a fluent builder for the CreateWorkflow operation.

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

    The name of the workflow to create.

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

    The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

    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>):
    required: false
    

    Describes the workflow.

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

    Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

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

    Contains the UTF-8 encoded YAML document content for the workflow. 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>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags that apply to the workflow resource.

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

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

    
    
  • r#type(WorkflowType) / set_type(Option<WorkflowType>):
    required: true
    

    The phase in the image build process for which the workflow resource is responsible.

    
    
• On success, responds with CreateWorkflowOutput with field(s):
  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • workflow_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the workflow resource that the request created.

• On failure, responds with SdkError<CreateWorkflowError>

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>):
    required: true
    

    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 ARN of the component build version that this request 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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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 ARN of the Image Builder image resource that this request 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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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 delete_lifecycle_policy(&self) -> DeleteLifecyclePolicyFluentBuilder

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

• The fluent builder is configurable:
  • lifecycle_policy_arn(impl Into<String>) / set_lifecycle_policy_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.

    
    
• On success, responds with DeleteLifecyclePolicyOutput with field(s):
  • lifecycle_policy_arn(Option<String>):

    The ARN of the lifecycle policy that was deleted.

• On failure, responds with SdkError<DeleteLifecyclePolicyError>

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

Constructs a fluent builder for the DeleteWorkflow operation.

• The fluent builder is configurable:
  • workflow_build_version_arn(impl Into<String>) / set_workflow_build_version_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the workflow resource to delete.

    
    
• On success, responds with DeleteWorkflowOutput with field(s):
  • workflow_build_version_arn(Option<String>):

    The ARN of the workflow resource that this request deleted.

• On failure, responds with SdkError<DeleteWorkflowError>

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>):
    required: true
    

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

    
    
• 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 specified in the request.

• 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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

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

    
    
• 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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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 get_lifecycle_execution(&self) -> GetLifecycleExecutionFluentBuilder

Constructs a fluent builder for the GetLifecycleExecution operation.

• The fluent builder is configurable:
  • lifecycle_execution_id(impl Into<String>) / set_lifecycle_execution_id(Option<String>):
    required: true
    

    Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

    
    
• On success, responds with GetLifecycleExecutionOutput with field(s):
  • lifecycle_execution(Option<LifecycleExecution>):

    Runtime details for the specified runtime instance of the lifecycle policy.

• On failure, responds with SdkError<GetLifecycleExecutionError>

impl Client

pub fn get_lifecycle_policy(&self) -> GetLifecyclePolicyFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicy operation.

• The fluent builder is configurable:
  • lifecycle_policy_arn(impl Into<String>) / set_lifecycle_policy_arn(Option<String>):
    required: true
    

    Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

    
    
• On success, responds with GetLifecyclePolicyOutput with field(s):
  • lifecycle_policy(Option<LifecyclePolicy>):

    The ARN of the image lifecycle policy resource that was returned.

• On failure, responds with SdkError<GetLifecyclePolicyError>

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

Constructs a fluent builder for the GetWorkflow operation.

• The fluent builder is configurable:
  • workflow_build_version_arn(impl Into<String>) / set_workflow_build_version_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with GetWorkflowOutput with field(s):
  • workflow(Option<Workflow>):

    The workflow resource specified in the request.

• On failure, responds with SdkError<GetWorkflowError>

impl Client

pub fn get_workflow_execution(&self) -> GetWorkflowExecutionFluentBuilder

Constructs a fluent builder for the GetWorkflowExecution operation.

• The fluent builder is configurable:
  • workflow_execution_id(impl Into<String>) / set_workflow_execution_id(Option<String>):
    required: true
    

    Use the unique identifier for a runtime instance of the workflow to get runtime details.

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

    The request ID that uniquely identifies this request.

  • workflow_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

  • workflow_execution_id(Option<String>):

    The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

  • r#type(Option<WorkflowType>):

    The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

  • status(Option<WorkflowExecutionStatus>):

    The current runtime status for the specified runtime instance of the workflow.

  • message(Option<String>):

    The output message from the specified runtime instance of the workflow, if applicable.

  • total_step_count(i32):

    The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

  • total_steps_succeeded(i32):

    A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.

  • total_steps_failed(i32):

    A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

  • total_steps_skipped(i32):

    A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

  • start_time(Option<String>):

    The timestamp when the specified runtime instance of the workflow started.

  • end_time(Option<String>):

    The timestamp when the specified runtime instance of the workflow finished.

  • parallel_group(Option<String>):

    Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.

• On failure, responds with SdkError<GetWorkflowExecutionError>

impl Client

pub fn get_workflow_step_execution( &self, ) -> GetWorkflowStepExecutionFluentBuilder

Constructs a fluent builder for the GetWorkflowStepExecution operation.

• The fluent builder is configurable:
  • step_execution_id(impl Into<String>) / set_step_execution_id(Option<String>):
    required: true
    

    Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.

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

    The request ID that uniquely identifies this request.

  • step_execution_id(Option<String>):

    The unique identifier for the runtime version of the workflow step that you specified in the request.

  • workflow_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

  • workflow_execution_id(Option<String>):

    The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.

  • name(Option<String>):

    The name of the specified runtime instance of the workflow step.

  • description(Option<String>):

    Describes the specified workflow step.

  • action(Option<String>):

    The name of the action that the specified step performs.

  • status(Option<WorkflowStepExecutionStatus>):

    The current status for the specified runtime version of the workflow step.

  • rollback_status(Option<WorkflowStepExecutionRollbackStatus>):

    Reports on the rollback status of the specified runtime version of the workflow step, if applicable.

  • message(Option<String>):

    The output message from the specified runtime instance of the workflow step, if applicable.

  • inputs(Option<String>):

    Input parameters that Image Builder provided for the specified runtime instance of the workflow step.

  • outputs(Option<String>):

    The file names that the specified runtime version of the workflow step created as output.

  • start_time(Option<String>):

    The timestamp when the specified runtime version of the workflow step started.

  • end_time(Option<String>):

    The timestamp when the specified runtime instance of the workflow step finished.

  • on_failure(Option<String>):

    The action to perform if the workflow step fails.

  • timeout_seconds(Option<i32>):

    The maximum duration in seconds for this step to complete its action.

• On failure, responds with SdkError<GetWorkflowStepExecutionError>

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>):
    required: true
    

    The name of the component.

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

    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>):
    required: false
    

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

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

    The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.

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

    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>):
    required: true
    

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

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

    The platform of the component.

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

    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>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the component.

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

    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 ImportComponentOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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>):
    required: true
    

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

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

    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>):
    required: false
    

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

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

    The operating system platform for the imported VM.

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

    The operating system version for the imported VM.

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

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags that are attached to the import resources.

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

    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 client token that uniquely identifies the 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>):
    required: true
    

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

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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>):
    required: false
    

    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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Use the following filters to streamline results:

    • description

    • name

    • platform

    • supportedOsVersion

    • type

    • version

    
    
  • by_name(bool) / set_by_name(Option<bool>):
    required: false
    

    Returns the list of components for the specified name.

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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>):
    required: false
    

    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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Use the following filters to streamline results:

    • containerType

    • name

    • parentImage

    • platform

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

    The maximum items to return in a request.

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

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

    
    
• 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 used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• 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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can filter on name to streamline results.

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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>):
    required: true
    

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

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

    Use the following filters to streamline results:

    • name

    • osVersion

    • platform

    • type

    • version

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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>):
    required: true
    

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

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

    The maximum items to return in a request.

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

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

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• 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>):
    required: true
    

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

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

    Use the following filters to streamline results:

    • name

    • version

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Use the following filters to streamline results:

    • description

    • distributionConfigurationArn

    • imageRecipeArn

    • infrastructureConfigurationArn

    • name

    • status

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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>):
    required: false
    

    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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Use the following filters to streamline results:

    • name

    • parentImage

    • platform

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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_image_scan_finding_aggregations( &self, ) -> ListImageScanFindingAggregationsFluentBuilder

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

• The fluent builder is configurable:
  • filter(Filter) / set_filter(Option<Filter>):
    required: false
    

    A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

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

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

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

    The request ID that uniquely identifies this request.

  • aggregation_type(Option<String>):

    The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn’t specify a filter in the request, the type defaults to accountId.

    Aggregation types

    • accountId

    • imageBuildVersionArn

    • imagePipelineArn

    • vulnerabilityId

    Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.

  • responses(Option<Vec::<ImageScanFindingAggregation>>):

    An array of image scan finding aggregations that match the filter criteria.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImageScanFindingAggregationsError>

impl Client

pub fn list_image_scan_findings(&self) -> ListImageScanFindingsFluentBuilder

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

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

    An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:

    • imageBuildVersionArn

    • imagePipelineArn

    • vulnerabilityId

    • severity

    If you don’t request a filter, then all findings in your account are listed.

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

    The maximum items to return in a request.

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

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

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

    The request ID that uniquely identifies this request.

  • findings(Option<Vec::<ImageScanFinding>>):

    The image scan findings for your account that meet your request filter criteria.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListImageScanFindingsError>

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>):
    required: false
    

    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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Use the following filters to streamline results:

    • name

    • osVersion

    • platform

    • type

    • version

    
    
  • by_name(bool) / set_by_name(Option<bool>):
    required: false
    

    Requests a list of images with a specific recipe name.

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

    The maximum items to return in a request.

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

    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>):
    required: false
    

    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 field isn’t empty, there are additional elements that the service hasn’t 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(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    You can filter on name to streamline results.

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

    The maximum items to return in a request.

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

    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 field isn’t empty, there are additional elements that the service hasn’t 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_lifecycle_execution_resources( &self, ) -> ListLifecycleExecutionResourcesFluentBuilder

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

• The fluent builder is configurable:
  • lifecycle_execution_id(impl Into<String>) / set_lifecycle_execution_id(Option<String>):
    required: true
    

    Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

    
    
  • parent_resource_id(impl Into<String>) / set_parent_resource_id(Option<String>):
    required: false
    

    You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.

    To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories.

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

    The maximum items to return in a request.

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

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

    
    
• On success, responds with ListLifecycleExecutionResourcesOutput with field(s):
  • lifecycle_execution_id(Option<String>):

    Runtime details for the specified runtime instance of the lifecycle policy.

  • lifecycle_execution_state(Option<LifecycleExecutionState>):

    The current state of the lifecycle runtime instance.

  • resources(Option<Vec::<LifecycleExecutionResource>>):

    A list of resources that were identified for lifecycle actions.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListLifecycleExecutionResourcesError>

impl Client

pub fn list_lifecycle_executions(&self) -> ListLifecycleExecutionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum items to return in a request.

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

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

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.

    
    
• On success, responds with ListLifecycleExecutionsOutput with field(s):
  • lifecycle_executions(Option<Vec::<LifecycleExecution>>):

    A list of lifecycle runtime instances for the specified resource.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListLifecycleExecutionsError>

impl Client

pub fn list_lifecycle_policies(&self) -> ListLifecyclePoliciesFluentBuilder

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

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

    Streamline results based on one of the following values: Name, Status.

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

    The maximum items to return in a request.

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

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

    
    
• On success, responds with ListLifecyclePoliciesOutput with field(s):
  • lifecycle_policy_summary_list(Option<Vec::<LifecyclePolicySummary>>):

    A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListLifecyclePoliciesError>

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>):
    required: true
    

    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 list_waiting_workflow_steps( &self, ) -> ListWaitingWorkflowStepsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum items to return in a request.

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

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

    
    
• On success, responds with ListWaitingWorkflowStepsOutput with field(s):
  • steps(Option<Vec::<WorkflowStepExecution>>):

    An array of the workflow steps that are waiting for action in your Amazon Web Services account.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListWaitingWorkflowStepsError>

impl Client

pub fn list_workflow_build_versions( &self, ) -> ListWorkflowBuildVersionsFluentBuilder

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

• The fluent builder is configurable:
  • workflow_version_arn(impl Into<String>) / set_workflow_version_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

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

    The maximum items to return in a request.

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

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

    
    
• On success, responds with ListWorkflowBuildVersionsOutput with field(s):
  • workflow_summary_list(Option<Vec::<WorkflowSummary>>):

    A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListWorkflowBuildVersionsError>

impl Client

pub fn list_workflow_executions(&self) -> ListWorkflowExecutionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum items to return in a request.

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

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

    
    
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):
    required: true
    

    List all workflow runtime instances for the specified image build version resource ARN.

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

    The request ID that uniquely identifies this request.

  • workflow_executions(Option<Vec::<WorkflowExecutionMetadata>>):

    Contains an array of runtime details that represents each time a workflow ran for the requested image build version.

  • image_build_version_arn(Option<String>):

    The resource ARN of the image build version for which you requested a list of workflow runtime details.

  • message(Option<String>):

    The output message from the list action, if applicable.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListWorkflowExecutionsError>

impl Client

pub fn list_workflow_step_executions( &self, ) -> ListWorkflowStepExecutionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum items to return in a request.

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

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

    
    
  • workflow_execution_id(impl Into<String>) / set_workflow_execution_id(Option<String>):
    required: true
    

    The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

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

    The request ID that uniquely identifies this request.

  • steps(Option<Vec::<WorkflowStepMetadata>>):

    Contains an array of runtime details that represents each step in this runtime instance of the workflow.

  • workflow_build_version_arn(Option<String>):

    The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

  • workflow_execution_id(Option<String>):

    The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

  • image_build_version_arn(Option<String>):

    The image build version resource ARN that’s associated with the specified runtime instance of the workflow.

  • message(Option<String>):

    The output message from the list action, if applicable.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListWorkflowStepExecutionsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

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

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

    Used to get a list of workflow build version filtered by the identity of the creator.

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

    Used to streamline search results.

    
    
  • by_name(bool) / set_by_name(Option<bool>):
    required: false
    

    Specify all or part of the workflow name to streamline results.

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

    The maximum items to return in a request.

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

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

    
    
• On success, responds with ListWorkflowsOutput with field(s):
  • workflow_version_list(Option<Vec::<WorkflowVersion>>):

    A list of workflow build versions that match the request criteria.

  • next_token(Option<String>):

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

• On failure, responds with SdkError<ListWorkflowsError>

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>):
    required: true
    

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

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

    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>):
    required: true
    

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

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

    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>):
    required: true
    

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

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

    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>):
    required: true
    

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

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

    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 send_workflow_step_action(&self) -> SendWorkflowStepActionFluentBuilder

Constructs a fluent builder for the SendWorkflowStepAction operation.

• The fluent builder is configurable:
  • step_execution_id(impl Into<String>) / set_step_execution_id(Option<String>):
    required: true
    

    Uniquely identifies the workflow step that sent the step action.

    
    
  • image_build_version_arn(impl Into<String>) / set_image_build_version_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the image build version to send action for.

    
    
  • action(WorkflowStepActionType) / set_action(Option<WorkflowStepActionType>):
    required: true
    

    The action for the image creation process to take while a workflow WaitForAction step waits for an asynchronous action to complete.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    The reason why this action is sent.

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

    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 SendWorkflowStepActionOutput with field(s):
  • step_execution_id(Option<String>):

    The workflow step that sent the step action.

  • image_build_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the image build version that received the action request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

• On failure, responds with SdkError<SendWorkflowStepActionError>

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>):
    required: true
    

    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>):
    required: true
    

    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 StartImagePipelineExecutionOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • image_build_version_arn(Option<String>):

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

• On failure, responds with SdkError<StartImagePipelineExecutionError>

impl Client

pub fn start_resource_state_update( &self, ) -> StartResourceStateUpdateFluentBuilder

Constructs a fluent builder for the StartResourceStateUpdate operation.

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

    The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.

    
    
  • state(ResourceState) / set_state(Option<ResourceState>):
    required: true
    

    Indicates the lifecycle action to take for this request.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: false
    

    The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.

    
    
  • include_resources(ResourceStateUpdateIncludeResources) / set_include_resources(Option<ResourceStateUpdateIncludeResources>):
    required: false
    

    A list of image resources to update state for.

    
    
  • exclusion_rules(ResourceStateUpdateExclusionRules) / set_exclusion_rules(Option<ResourceStateUpdateExclusionRules>):
    required: false
    

    Skip action on the image resource and associated resources if specified exclusion rules are met.

    
    
  • update_at(DateTime) / set_update_at(Option<DateTime>):
    required: false
    

    The timestamp that indicates when resources are updated by a lifecycle action.

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

    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 StartResourceStateUpdateOutput with field(s):
  • lifecycle_execution_id(Option<String>):

    Identifies the lifecycle runtime instance that started the resource state update.

  • resource_arn(Option<String>):

    The requested ARN of the Image Builder resource for the asynchronous update.

• On failure, responds with SdkError<StartResourceStateUpdateError>

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>):
    required: true
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    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>):
    required: true
    

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    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>):
    required: true
    

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

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

    The description of the distribution configuration.

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

    The distributions of the distribution configuration.

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

    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 UpdateDistributionConfigurationOutput with field(s):
  • request_id(Option<String>):

    The request ID that uniquely identifies this request.

  • client_token(Option<String>):

    The client token that uniquely identifies the request.

  • 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>):
    required: true
    

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

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

    The description of the image pipeline.

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

    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>):
    required: false
    

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

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

    The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

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

    The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

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

    The image test configuration of the image pipeline.

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

    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>):
    required: false
    

    The schedule of the image pipeline.

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

    The status of the image pipeline.

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

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

    
    
  • image_scanning_configuration(ImageScanningConfiguration) / set_image_scanning_configuration(Option<ImageScanningConfiguration>):
    required: false
    

    Contains settings for vulnerability scans.

    
    
  • workflows(WorkflowConfiguration) / set_workflows(Option<Vec::<WorkflowConfiguration>>):
    required: false
    

    Contains the workflows to run for the pipeline.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: false
    

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

    
    
• 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 client token that uniquely identifies the request.

  • 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>):
    required: true
    

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

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

    The description of the infrastructure configuration.

    
    
  • instance_types(impl Into<String>) / set_instance_types(Option<Vec::<String>>):
    required: false
    

    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>):
    required: true
    

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

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

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

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

    The logging configuration of the infrastructure configuration.

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

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

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

    
    
  • resource_tags(impl Into<String>, impl Into<String>) / set_resource_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags attached to the resource created by Image Builder.

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

    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 client token that uniquely identifies the request.

  • 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 update_lifecycle_policy(&self) -> UpdateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the UpdateLifecyclePolicy operation.

• The fluent builder is configurable:
  • lifecycle_policy_arn(impl Into<String>) / set_lifecycle_policy_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the lifecycle policy resource.

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

    Optional description for the lifecycle policy.

    
    
  • status(LifecyclePolicyStatus) / set_status(Option<LifecyclePolicyStatus>):
    required: false
    

    Indicates whether the lifecycle policy resource is enabled.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.

    
    
  • resource_type(LifecyclePolicyResourceType) / set_resource_type(Option<LifecyclePolicyResourceType>):
    required: true
    

    The type of image resource that the lifecycle policy applies to.

    
    
  • policy_details(LifecyclePolicyDetail) / set_policy_details(Option<Vec::<LifecyclePolicyDetail>>):
    required: true
    

    The configuration details for a lifecycle policy resource.

    
    
  • resource_selection(LifecyclePolicyResourceSelection) / set_resource_selection(Option<LifecyclePolicyResourceSelection>):
    required: true
    

    Selection criteria for resources that the lifecycle policy applies to.

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

    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 UpdateLifecyclePolicyOutput with field(s):
  • lifecycle_policy_arn(Option<String>):

    The ARN of the image lifecycle policy resource that was updated.

• On failure, responds with SdkError<UpdateLifecyclePolicyError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.