/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** */ class DescribeImagesRequest : public EC2Request { public: AWS_EC2_API DescribeImagesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeImages"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline const Aws::Vector& GetExecutableUsers() const{ return m_executableUsers; } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline bool ExecutableUsersHasBeenSet() const { return m_executableUsersHasBeenSet; } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline void SetExecutableUsers(const Aws::Vector& value) { m_executableUsersHasBeenSet = true; m_executableUsers = value; } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline void SetExecutableUsers(Aws::Vector&& value) { m_executableUsersHasBeenSet = true; m_executableUsers = std::move(value); } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline DescribeImagesRequest& WithExecutableUsers(const Aws::Vector& value) { SetExecutableUsers(value); return *this;} /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline DescribeImagesRequest& WithExecutableUsers(Aws::Vector&& value) { SetExecutableUsers(std::move(value)); return *this;} /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline DescribeImagesRequest& AddExecutableUsers(const Aws::String& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline DescribeImagesRequest& AddExecutableUsers(Aws::String&& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(std::move(value)); return *this; } /** *

Scopes the images by users with explicit launch permissions. Specify an * Amazon Web Services account ID, self (the sender of the request), * or all (public AMIs).

  • If you specify an Amazon Web * Services account ID that is not your own, only AMIs shared with that specific * Amazon Web Services account ID are returned. However, AMIs that are shared with * the account’s organization or organizational unit (OU) are not returned.

    *
  • If you specify self or your own Amazon Web Services * account ID, AMIs shared with your account are returned. In addition, AMIs that * are shared with the organization or OU of which you are member are also * returned.

  • If you specify all, all public AMIs * are returned.

*/ inline DescribeImagesRequest& AddExecutableUsers(const char* value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline DescribeImagesRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline DescribeImagesRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline DescribeImagesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

The filters.

  • architecture - The image * architecture (i386 | x86_64 | arm64 | * x86_64_mac | arm64_mac).

  • * block-device-mapping.delete-on-termination - A Boolean value that * indicates whether the Amazon EBS volume is deleted on instance termination.

    *
  • block-device-mapping.device-name - The device name * specified in the block device mapping (for example, /dev/sdh or * xvdh).

  • * block-device-mapping.snapshot-id - The ID of the snapshot used for * the Amazon EBS volume.

  • * block-device-mapping.volume-size - The volume size of the Amazon * EBS volume, in GiB.

  • * block-device-mapping.volume-type - The volume type of the Amazon * EBS volume (io1 | io2 | gp2 | * gp3 | sc1 | st1 | * standard).

  • * block-device-mapping.encrypted - A Boolean that indicates whether * the Amazon EBS volume is encrypted.

  • * creation-date - The time when the image was created, in the ISO * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, * 2021-09-29T11:04:43.305Z. You can use a wildcard (*), * for example, 2021-09-29T*, which matches an entire day.

  • *
  • description - The description of the image (provided * during image creation).

  • ena-support - A Boolean * that indicates whether enhanced networking with ENA is enabled.

  • *

    hypervisor - The hypervisor type (ovm | * xen).

  • image-id - The ID of the * image.

  • image-type - The image type * (machine | kernel | ramdisk).

  • *
  • is-public - A Boolean that indicates whether the image is * public.

  • kernel-id - The kernel ID.

  • *
  • manifest-location - The location of the image * manifest.

  • name - The name of the AMI (provided * during image creation).

  • owner-alias - The owner * alias (amazon | aws-marketplace). The valid aliases * are defined in an Amazon-maintained list. This is not the Amazon Web Services * account alias that can be set using the IAM console. We recommend that you use * the Owner request parameter instead of this filter.

  • * owner-id - The Amazon Web Services account ID of the owner. We * recommend that you use the Owner request parameter instead of this * filter.

  • platform - The platform. The only * supported value is windows.

  • * product-code - The product code.

  • * product-code.type - The type of the product code * (marketplace).

  • ramdisk-id - The RAM * disk ID.

  • root-device-name - The device name of * the root device volume (for example, /dev/sda1).

  • * root-device-type - The type of the root device volume * (ebs | instance-store).

  • * state - The state of the image (available | * pending | failed).

  • * state-reason-code - The reason code for the state change.

  • *
  • state-reason-message - The message for the state * change.

  • sriov-net-support - A value of * simple indicates that enhanced networking with the Intel 82599 VF * interface is enabled.

  • tag:<key> - The * key/value combination of a tag assigned to the resource. Use the tag key in the * filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

  • tag-key * - The key of a tag assigned to the resource. Use this filter to find all * resources assigned a tag with a specific key, regardless of the tag value.

    *
  • virtualization-type - The virtualization type * (paravirtual | hvm).

*/ inline DescribeImagesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline const Aws::Vector& GetImageIds() const{ return m_imageIds; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline bool ImageIdsHasBeenSet() const { return m_imageIdsHasBeenSet; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline void SetImageIds(const Aws::Vector& value) { m_imageIdsHasBeenSet = true; m_imageIds = value; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline void SetImageIds(Aws::Vector&& value) { m_imageIdsHasBeenSet = true; m_imageIds = std::move(value); } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline DescribeImagesRequest& WithImageIds(const Aws::Vector& value) { SetImageIds(value); return *this;} /** *

The image IDs.

Default: Describes all images available to you.

*/ inline DescribeImagesRequest& WithImageIds(Aws::Vector&& value) { SetImageIds(std::move(value)); return *this;} /** *

The image IDs.

Default: Describes all images available to you.

*/ inline DescribeImagesRequest& AddImageIds(const Aws::String& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline DescribeImagesRequest& AddImageIds(Aws::String&& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(std::move(value)); return *this; } /** *

The image IDs.

Default: Describes all images available to you.

*/ inline DescribeImagesRequest& AddImageIds(const char* value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline const Aws::Vector& GetOwners() const{ return m_owners; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline bool OwnersHasBeenSet() const { return m_ownersHasBeenSet; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline void SetOwners(const Aws::Vector& value) { m_ownersHasBeenSet = true; m_owners = value; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline void SetOwners(Aws::Vector&& value) { m_ownersHasBeenSet = true; m_owners = std::move(value); } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline DescribeImagesRequest& WithOwners(const Aws::Vector& value) { SetOwners(value); return *this;} /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline DescribeImagesRequest& WithOwners(Aws::Vector&& value) { SetOwners(std::move(value)); return *this;} /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline DescribeImagesRequest& AddOwners(const Aws::String& value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline DescribeImagesRequest& AddOwners(Aws::String&& value) { m_ownersHasBeenSet = true; m_owners.push_back(std::move(value)); return *this; } /** *

Scopes the results to images with the specified owners. You can specify a * combination of Amazon Web Services account IDs, self, * amazon, and aws-marketplace. If you omit this * parameter, the results include all images for which you have launch permissions, * regardless of ownership.

*/ inline DescribeImagesRequest& AddOwners(const char* value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; } /** *

Specifies whether to include deprecated AMIs.

Default: No deprecated * AMIs are included in the response.

If you are the AMI owner, all * deprecated AMIs appear in the response regardless of what you specify for this * parameter.

*/ inline bool GetIncludeDeprecated() const{ return m_includeDeprecated; } /** *

Specifies whether to include deprecated AMIs.

Default: No deprecated * AMIs are included in the response.

If you are the AMI owner, all * deprecated AMIs appear in the response regardless of what you specify for this * parameter.

*/ inline bool IncludeDeprecatedHasBeenSet() const { return m_includeDeprecatedHasBeenSet; } /** *

Specifies whether to include deprecated AMIs.

Default: No deprecated * AMIs are included in the response.

If you are the AMI owner, all * deprecated AMIs appear in the response regardless of what you specify for this * parameter.

*/ inline void SetIncludeDeprecated(bool value) { m_includeDeprecatedHasBeenSet = true; m_includeDeprecated = value; } /** *

Specifies whether to include deprecated AMIs.

Default: No deprecated * AMIs are included in the response.

If you are the AMI owner, all * deprecated AMIs appear in the response regardless of what you specify for this * parameter.

*/ inline DescribeImagesRequest& WithIncludeDeprecated(bool value) { SetIncludeDeprecated(value); return *this;} /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool GetDryRun() const{ return m_dryRun; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline DescribeImagesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

*/ inline DescribeImagesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline DescribeImagesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline DescribeImagesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

*/ inline DescribeImagesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_executableUsers; bool m_executableUsersHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::Vector m_imageIds; bool m_imageIdsHasBeenSet = false; Aws::Vector m_owners; bool m_ownersHasBeenSet = false; bool m_includeDeprecated; bool m_includeDeprecatedHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws