This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ec2/include/aws/ec2/model/DescribeImagesRequest.h

782 lines
50 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ec2/EC2_EXPORTS.h>
#include <aws/ec2/EC2Request.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/ec2/model/Filter.h>
#include <utility>
namespace Aws
{
namespace EC2
{
namespace Model
{
/**
*/
class AWS_EC2_API DescribeImagesRequest : public EC2Request
{
public:
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::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline const Aws::Vector<Aws::String>& GetExecutableUsers() const{ return m_executableUsers; }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline bool ExecutableUsersHasBeenSet() const { return m_executableUsersHasBeenSet; }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline void SetExecutableUsers(const Aws::Vector<Aws::String>& value) { m_executableUsersHasBeenSet = true; m_executableUsers = value; }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline void SetExecutableUsers(Aws::Vector<Aws::String>&& value) { m_executableUsersHasBeenSet = true; m_executableUsers = std::move(value); }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline DescribeImagesRequest& WithExecutableUsers(const Aws::Vector<Aws::String>& value) { SetExecutableUsers(value); return *this;}
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline DescribeImagesRequest& WithExecutableUsers(Aws::Vector<Aws::String>&& value) { SetExecutableUsers(std::move(value)); return *this;}
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline DescribeImagesRequest& AddExecutableUsers(const Aws::String& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline DescribeImagesRequest& AddExecutableUsers(Aws::String&& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(std::move(value)); return *this; }
/**
* <p>Scopes the images by users with explicit launch permissions. Specify an AWS
* account ID, <code>self</code> (the sender of the request), or <code>all</code>
* (public AMIs).</p>
*/
inline DescribeImagesRequest& AddExecutableUsers(const char* value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline DescribeImagesRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline DescribeImagesRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline DescribeImagesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
/**
* <p>The filters.</p> <ul> <li> <p> <code>architecture</code> - The image
* architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code>).</p>
* </li> <li> <p> <code>block-device-mapping.delete-on-termination</code> - A
* Boolean value that indicates whether the Amazon EBS volume is deleted on
* instance termination.</p> </li> <li> <p>
* <code>block-device-mapping.device-name</code> - The device name specified in the
* block device mapping (for example, <code>/dev/sdh</code> or
* <code>xvdh</code>).</p> </li> <li> <p>
* <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for
* the EBS volume.</p> </li> <li> <p> <code>block-device-mapping.volume-size</code>
* - The volume size of the EBS volume, in GiB.</p> </li> <li> <p>
* <code>block-device-mapping.volume-type</code> - The volume type of the EBS
* volume (<code>gp2</code> | <code>io1</code> | <code>io2</code> | <code>st1
* </code>| <code>sc1</code> | <code>standard</code>).</p> </li> <li> <p>
* <code>block-device-mapping.encrypted</code> - A Boolean that indicates whether
* the EBS volume is encrypted.</p> </li> <li> <p> <code>description</code> - The
* description of the image (provided during image creation).</p> </li> <li> <p>
* <code>ena-support</code> - A Boolean that indicates whether enhanced networking
* with ENA is enabled.</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor
* type (<code>ovm</code> | <code>xen</code>).</p> </li> <li> <p>
* <code>image-id</code> - The ID of the image.</p> </li> <li> <p>
* <code>image-type</code> - The image type (<code>machine</code> |
* <code>kernel</code> | <code>ramdisk</code>).</p> </li> <li> <p>
* <code>is-public</code> - A Boolean that indicates whether the image is
* public.</p> </li> <li> <p> <code>kernel-id</code> - The kernel ID.</p> </li>
* <li> <p> <code>manifest-location</code> - The location of the image
* manifest.</p> </li> <li> <p> <code>name</code> - The name of the AMI (provided
* during image creation).</p> </li> <li> <p> <code>owner-alias</code> - The owner
* alias, from an Amazon-maintained list (<code>amazon</code> |
* <code>aws-marketplace</code>). This is not the user-configured AWS account alias
* set using the IAM console. We recommend that you use the related parameter
* instead of this filter.</p> </li> <li> <p> <code>owner-id</code> - The AWS
* account ID of the owner. We recommend that you use the related parameter instead
* of this filter.</p> </li> <li> <p> <code>platform</code> - The platform. To only
* list Windows-based AMIs, use <code>windows</code>.</p> </li> <li> <p>
* <code>product-code</code> - The product code.</p> </li> <li> <p>
* <code>product-code.type</code> - The type of the product code
* (<code>devpay</code> | <code>marketplace</code>).</p> </li> <li> <p>
* <code>ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p>
* <code>root-device-name</code> - The device name of the root device volume (for
* example, <code>/dev/sda1</code>).</p> </li> <li> <p>
* <code>root-device-type</code> - The type of the root device volume
* (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p>
* <code>state</code> - The state of the image (<code>available</code> |
* <code>pending</code> | <code>failed</code>).</p> </li> <li> <p>
* <code>state-reason-code</code> - The reason code for the state change.</p> </li>
* <li> <p> <code>state-reason-message</code> - The message for the state
* change.</p> </li> <li> <p> <code>sriov-net-support</code> - A value of
* <code>simple</code> indicates that enhanced networking with the Intel 82599 VF
* interface is enabled.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - 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 <code>Owner</code> and the value
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
* - 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.</p>
* </li> <li> <p> <code>virtualization-type</code> - The virtualization type
* (<code>paravirtual</code> | <code>hvm</code>).</p> </li> </ul>
*/
inline DescribeImagesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline const Aws::Vector<Aws::String>& GetImageIds() const{ return m_imageIds; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline bool ImageIdsHasBeenSet() const { return m_imageIdsHasBeenSet; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline void SetImageIds(const Aws::Vector<Aws::String>& value) { m_imageIdsHasBeenSet = true; m_imageIds = value; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline void SetImageIds(Aws::Vector<Aws::String>&& value) { m_imageIdsHasBeenSet = true; m_imageIds = std::move(value); }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline DescribeImagesRequest& WithImageIds(const Aws::Vector<Aws::String>& value) { SetImageIds(value); return *this;}
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline DescribeImagesRequest& WithImageIds(Aws::Vector<Aws::String>&& value) { SetImageIds(std::move(value)); return *this;}
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline DescribeImagesRequest& AddImageIds(const Aws::String& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline DescribeImagesRequest& AddImageIds(Aws::String&& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(std::move(value)); return *this; }
/**
* <p>The image IDs.</p> <p>Default: Describes all images available to you.</p>
*/
inline DescribeImagesRequest& AddImageIds(const char* value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline const Aws::Vector<Aws::String>& GetOwners() const{ return m_owners; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline bool OwnersHasBeenSet() const { return m_ownersHasBeenSet; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline void SetOwners(const Aws::Vector<Aws::String>& value) { m_ownersHasBeenSet = true; m_owners = value; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline void SetOwners(Aws::Vector<Aws::String>&& value) { m_ownersHasBeenSet = true; m_owners = std::move(value); }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline DescribeImagesRequest& WithOwners(const Aws::Vector<Aws::String>& value) { SetOwners(value); return *this;}
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline DescribeImagesRequest& WithOwners(Aws::Vector<Aws::String>&& value) { SetOwners(std::move(value)); return *this;}
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline DescribeImagesRequest& AddOwners(const Aws::String& value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline DescribeImagesRequest& AddOwners(Aws::String&& value) { m_ownersHasBeenSet = true; m_owners.push_back(std::move(value)); return *this; }
/**
* <p>Scopes the results to images with the specified owners. You can specify a
* combination of AWS account IDs, <code>self</code>, <code>amazon</code>, and
* <code>aws-marketplace</code>. If you omit this parameter, the results include
* all images for which you have launch permissions, regardless of ownership.</p>
*/
inline DescribeImagesRequest& AddOwners(const char* value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; }
/**
* <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>
*/
inline bool GetDryRun() const{ return m_dryRun; }
/**
* <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>
*/
inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
/**
* <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>
*/
inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
/**
* <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>
*/
inline DescribeImagesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
private:
Aws::Vector<Aws::String> m_executableUsers;
bool m_executableUsersHasBeenSet;
Aws::Vector<Filter> m_filters;
bool m_filtersHasBeenSet;
Aws::Vector<Aws::String> m_imageIds;
bool m_imageIdsHasBeenSet;
Aws::Vector<Aws::String> m_owners;
bool m_ownersHasBeenSet;
bool m_dryRun;
bool m_dryRunHasBeenSet;
};
} // namespace Model
} // namespace EC2
} // namespace Aws