aws_sdk_ec2/client/

describe_image_attribute.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeImageAttribute`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`attribute(ImageAttributeName)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::attribute) / [`set_attribute(Option<ImageAttributeName>)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::set_attribute):<br>required: **true**<br><p>The AMI attribute.</p> <p><b>Note</b>: The <code>blockDeviceMapping</code> attribute is deprecated. Using this attribute returns the <code>Client.AuthFailure</code> error. To get information about the block device mappings for an AMI, use the <code>DescribeImages</code> action.</p><br>
    ///   - [`image_id(impl Into<String>)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::image_id) / [`set_image_id(Option<String>)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::set_image_id):<br>required: **true**<br><p>The ID of the AMI.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    /// - On success, responds with [`DescribeImageAttributeOutput`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput) with field(s):
    ///   - [`description(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::description): <p>A description for the AMI.</p>
    ///   - [`kernel_id(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::kernel_id): <p>The kernel ID.</p>
    ///   - [`ramdisk_id(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::ramdisk_id): <p>The RAM disk ID.</p>
    ///   - [`sriov_net_support(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::sriov_net_support): <p>Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>
    ///   - [`boot_mode(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::boot_mode): <p>The boot mode.</p>
    ///   - [`tpm_support(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::tpm_support): <p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>.</p>
    ///   - [`uefi_data(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::uefi_data): <p>Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData">GetInstanceUefiData</a> command. You can inspect and modify the UEFI data by using the <a href="https://github.com/awslabs/python-uefivars">python-uefivars tool</a> on GitHub. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html">UEFI Secure Boot for Amazon EC2 instances</a> in the <i>Amazon EC2 User Guide</i>.</p>
    ///   - [`last_launched_time(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::last_launched_time): <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p><note>  <p><code>lastLaunchedTime</code> data is available starting April 2017.</p> </note>
    ///   - [`imds_support(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::imds_support): <p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration">Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p>
    ///   - [`deregistration_protection(Option<AttributeValue>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::deregistration_protection): <p>Indicates whether deregistration protection is enabled for the AMI.</p>
    ///   - [`image_id(Option<String>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::image_id): <p>The ID of the AMI.</p>
    ///   - [`launch_permissions(Option<Vec::<LaunchPermission>>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::launch_permissions): <p>The launch permissions.</p>
    ///   - [`product_codes(Option<Vec::<ProductCode>>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::product_codes): <p>The product codes.</p>
    ///   - [`block_device_mappings(Option<Vec::<BlockDeviceMapping>>)`](crate::operation::describe_image_attribute::DescribeImageAttributeOutput::block_device_mappings): <p>The block device mapping entries.</p>
    /// - On failure, responds with [`SdkError<DescribeImageAttributeError>`](crate::operation::describe_image_attribute::DescribeImageAttributeError)
    pub fn describe_image_attribute(&self) -> crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder {
        crate::operation::describe_image_attribute::builders::DescribeImageAttributeFluentBuilder::new(self.handle.clone())
    }
}