AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeImagesRequest Class Reference

#include <DescribeImagesRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeImagesRequest:

Public Member Functions

 DescribeImagesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetExecutableUsers () const
 
bool ExecutableUsersHasBeenSet () const
 
void SetExecutableUsers (const Aws::Vector< Aws::String > &value)
 
void SetExecutableUsers (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestWithExecutableUsers (const Aws::Vector< Aws::String > &value)
 
DescribeImagesRequestWithExecutableUsers (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestAddExecutableUsers (const Aws::String &value)
 
DescribeImagesRequestAddExecutableUsers (Aws::String &&value)
 
DescribeImagesRequestAddExecutableUsers (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeImagesRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeImagesRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeImagesRequestAddFilters (const Filter &value)
 
DescribeImagesRequestAddFilters (Filter &&value)
 
const Aws::Vector< Aws::String > & GetImageIds () const
 
bool ImageIdsHasBeenSet () const
 
void SetImageIds (const Aws::Vector< Aws::String > &value)
 
void SetImageIds (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestWithImageIds (const Aws::Vector< Aws::String > &value)
 
DescribeImagesRequestWithImageIds (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestAddImageIds (const Aws::String &value)
 
DescribeImagesRequestAddImageIds (Aws::String &&value)
 
DescribeImagesRequestAddImageIds (const char *value)
 
const Aws::Vector< Aws::String > & GetOwners () const
 
bool OwnersHasBeenSet () const
 
void SetOwners (const Aws::Vector< Aws::String > &value)
 
void SetOwners (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestWithOwners (const Aws::Vector< Aws::String > &value)
 
DescribeImagesRequestWithOwners (Aws::Vector< Aws::String > &&value)
 
DescribeImagesRequestAddOwners (const Aws::String &value)
 
DescribeImagesRequestAddOwners (Aws::String &&value)
 
DescribeImagesRequestAddOwners (const char *value)
 
bool GetIncludeDeprecated () const
 
bool IncludeDeprecatedHasBeenSet () const
 
void SetIncludeDeprecated (bool value)
 
DescribeImagesRequestWithIncludeDeprecated (bool value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeImagesRequestWithDryRun (bool value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file DescribeImagesRequest.h.

Constructor & Destructor Documentation

◆ DescribeImagesRequest()

Aws::EC2::Model::DescribeImagesRequest::DescribeImagesRequest ( )

Member Function Documentation

◆ AddExecutableUsers() [1/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers ( Aws::String &&  value)
inline

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

Definition at line 95 of file DescribeImagesRequest.h.

◆ AddExecutableUsers() [2/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers ( const Aws::String value)
inline

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

Definition at line 88 of file DescribeImagesRequest.h.

◆ AddExecutableUsers() [3/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers ( const char *  value)
inline

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

Definition at line 102 of file DescribeImagesRequest.h.

◆ AddFilters() [1/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddFilters ( const Filter value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 558 of file DescribeImagesRequest.h.

◆ AddFilters() [2/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddFilters ( Filter &&  value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 623 of file DescribeImagesRequest.h.

◆ AddImageIds() [1/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddImageIds ( Aws::String &&  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 664 of file DescribeImagesRequest.h.

◆ AddImageIds() [2/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddImageIds ( const Aws::String value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 659 of file DescribeImagesRequest.h.

◆ AddImageIds() [3/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddImageIds ( const char *  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 669 of file DescribeImagesRequest.h.

◆ AddOwners() [1/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddOwners ( Aws::String &&  value)
inline

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.

Definition at line 742 of file DescribeImagesRequest.h.

◆ AddOwners() [2/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddOwners ( const Aws::String value)
inline

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.

Definition at line 733 of file DescribeImagesRequest.h.

◆ AddOwners() [3/3]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::AddOwners ( const char *  value)
inline

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.

Definition at line 751 of file DescribeImagesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 809 of file DescribeImagesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeImagesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExecutableUsersHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::ExecutableUsersHasBeenSet ( ) const
inline

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

Definition at line 53 of file DescribeImagesRequest.h.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::FiltersHasBeenSet ( ) const
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 233 of file DescribeImagesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeImagesRequest::GetDryRun ( ) const
inline

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.

Definition at line 801 of file DescribeImagesRequest.h.

◆ GetExecutableUsers()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeImagesRequest::GetExecutableUsers ( ) const
inline

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

Definition at line 46 of file DescribeImagesRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeImagesRequest::GetFilters ( ) const
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 168 of file DescribeImagesRequest.h.

◆ GetImageIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeImagesRequest::GetImageIds ( ) const
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 629 of file DescribeImagesRequest.h.

◆ GetIncludeDeprecated()

bool Aws::EC2::Model::DescribeImagesRequest::GetIncludeDeprecated ( ) const
inline

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

Definition at line 762 of file DescribeImagesRequest.h.

◆ GetOwners()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeImagesRequest::GetOwners ( ) const
inline

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.

Definition at line 679 of file DescribeImagesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeImagesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeImagesRequest.h.

◆ ImageIdsHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::ImageIdsHasBeenSet ( ) const
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 634 of file DescribeImagesRequest.h.

◆ IncludeDeprecatedHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::IncludeDeprecatedHasBeenSet ( ) const
inline

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

Definition at line 772 of file DescribeImagesRequest.h.

◆ OwnersHasBeenSet()

bool Aws::EC2::Model::DescribeImagesRequest::OwnersHasBeenSet ( ) const
inline

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.

Definition at line 688 of file DescribeImagesRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeImagesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeImagesRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 817 of file DescribeImagesRequest.h.

◆ SetExecutableUsers() [1/2]

void Aws::EC2::Model::DescribeImagesRequest::SetExecutableUsers ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 67 of file DescribeImagesRequest.h.

◆ SetExecutableUsers() [2/2]

void Aws::EC2::Model::DescribeImagesRequest::SetExecutableUsers ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 60 of file DescribeImagesRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribeImagesRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 363 of file DescribeImagesRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribeImagesRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 298 of file DescribeImagesRequest.h.

◆ SetImageIds() [1/2]

void Aws::EC2::Model::DescribeImagesRequest::SetImageIds ( Aws::Vector< Aws::String > &&  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 644 of file DescribeImagesRequest.h.

◆ SetImageIds() [2/2]

void Aws::EC2::Model::DescribeImagesRequest::SetImageIds ( const Aws::Vector< Aws::String > &  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 639 of file DescribeImagesRequest.h.

◆ SetIncludeDeprecated()

void Aws::EC2::Model::DescribeImagesRequest::SetIncludeDeprecated ( bool  value)
inline

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

Definition at line 782 of file DescribeImagesRequest.h.

◆ SetOwners() [1/2]

void Aws::EC2::Model::DescribeImagesRequest::SetOwners ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 706 of file DescribeImagesRequest.h.

◆ SetOwners() [2/2]

void Aws::EC2::Model::DescribeImagesRequest::SetOwners ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 697 of file DescribeImagesRequest.h.

◆ WithDryRun()

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 825 of file DescribeImagesRequest.h.

◆ WithExecutableUsers() [1/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithExecutableUsers ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 81 of file DescribeImagesRequest.h.

◆ WithExecutableUsers() [2/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithExecutableUsers ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 74 of file DescribeImagesRequest.h.

◆ WithFilters() [1/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 493 of file DescribeImagesRequest.h.

◆ WithFilters() [2/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters.

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

  • 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.

  • 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. To only list Windows-based AMIs, use 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).

Definition at line 428 of file DescribeImagesRequest.h.

◆ WithImageIds() [1/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithImageIds ( Aws::Vector< Aws::String > &&  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 654 of file DescribeImagesRequest.h.

◆ WithImageIds() [2/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithImageIds ( const Aws::Vector< Aws::String > &  value)
inline

The image IDs.

Default: Describes all images available to you.

Definition at line 649 of file DescribeImagesRequest.h.

◆ WithIncludeDeprecated()

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithIncludeDeprecated ( bool  value)
inline

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

Definition at line 792 of file DescribeImagesRequest.h.

◆ WithOwners() [1/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithOwners ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 724 of file DescribeImagesRequest.h.

◆ WithOwners() [2/2]

DescribeImagesRequest& Aws::EC2::Model::DescribeImagesRequest::WithOwners ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 715 of file DescribeImagesRequest.h.


The documentation for this class was generated from the following file: