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

#include <ExportImageRequest.h>

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

Public Member Functions

 ExportImageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
ExportImageRequestWithClientToken (const Aws::String &value)
 
ExportImageRequestWithClientToken (Aws::String &&value)
 
ExportImageRequestWithClientToken (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ExportImageRequestWithDescription (const Aws::String &value)
 
ExportImageRequestWithDescription (Aws::String &&value)
 
ExportImageRequestWithDescription (const char *value)
 
const DiskImageFormatGetDiskImageFormat () const
 
bool DiskImageFormatHasBeenSet () const
 
void SetDiskImageFormat (const DiskImageFormat &value)
 
void SetDiskImageFormat (DiskImageFormat &&value)
 
ExportImageRequestWithDiskImageFormat (const DiskImageFormat &value)
 
ExportImageRequestWithDiskImageFormat (DiskImageFormat &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
ExportImageRequestWithDryRun (bool value)
 
const Aws::StringGetImageId () const
 
bool ImageIdHasBeenSet () const
 
void SetImageId (const Aws::String &value)
 
void SetImageId (Aws::String &&value)
 
void SetImageId (const char *value)
 
ExportImageRequestWithImageId (const Aws::String &value)
 
ExportImageRequestWithImageId (Aws::String &&value)
 
ExportImageRequestWithImageId (const char *value)
 
const ExportTaskS3LocationRequestGetS3ExportLocation () const
 
bool S3ExportLocationHasBeenSet () const
 
void SetS3ExportLocation (const ExportTaskS3LocationRequest &value)
 
void SetS3ExportLocation (ExportTaskS3LocationRequest &&value)
 
ExportImageRequestWithS3ExportLocation (const ExportTaskS3LocationRequest &value)
 
ExportImageRequestWithS3ExportLocation (ExportTaskS3LocationRequest &&value)
 
const Aws::StringGetRoleName () const
 
bool RoleNameHasBeenSet () const
 
void SetRoleName (const Aws::String &value)
 
void SetRoleName (Aws::String &&value)
 
void SetRoleName (const char *value)
 
ExportImageRequestWithRoleName (const Aws::String &value)
 
ExportImageRequestWithRoleName (Aws::String &&value)
 
ExportImageRequestWithRoleName (const char *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 34 of file ExportImageRequest.h.

Constructor & Destructor Documentation

◆ ExportImageRequest()

Aws::EC2::Model::ExportImageRequest::ExportImageRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::ClientTokenHasBeenSet ( ) const
inline

Token to enable idempotency for export image requests.

Definition at line 60 of file ExportImageRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::DescriptionHasBeenSet ( ) const
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 103 of file ExportImageRequest.h.

◆ DiskImageFormatHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::DiskImageFormatHasBeenSet ( ) const
inline

The disk image format.

Definition at line 150 of file ExportImageRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::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 187 of file ExportImageRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::ExportImageRequest::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.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::ExportImageRequest::GetClientToken ( ) const
inline

Token to enable idempotency for export image requests.

Definition at line 55 of file ExportImageRequest.h.

◆ GetDescription()

const Aws::String& Aws::EC2::Model::ExportImageRequest::GetDescription ( ) const
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 97 of file ExportImageRequest.h.

◆ GetDiskImageFormat()

const DiskImageFormat& Aws::EC2::Model::ExportImageRequest::GetDiskImageFormat ( ) const
inline

The disk image format.

Definition at line 145 of file ExportImageRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::ExportImageRequest::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 179 of file ExportImageRequest.h.

◆ GetImageId()

const Aws::String& Aws::EC2::Model::ExportImageRequest::GetImageId ( ) const
inline

The ID of the image.

Definition at line 209 of file ExportImageRequest.h.

◆ GetRoleName()

const Aws::String& Aws::EC2::Model::ExportImageRequest::GetRoleName ( ) const
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 295 of file ExportImageRequest.h.

◆ GetS3ExportLocation()

const ExportTaskS3LocationRequest& Aws::EC2::Model::ExportImageRequest::GetS3ExportLocation ( ) const
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 252 of file ExportImageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file ExportImageRequest.h.

◆ ImageIdHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::ImageIdHasBeenSet ( ) const
inline

The ID of the image.

Definition at line 214 of file ExportImageRequest.h.

◆ RoleNameHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::RoleNameHasBeenSet ( ) const
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 302 of file ExportImageRequest.h.

◆ S3ExportLocationHasBeenSet()

bool Aws::EC2::Model::ExportImageRequest::S3ExportLocationHasBeenSet ( ) const
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 259 of file ExportImageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::ExportImageRequest::SetClientToken ( const Aws::String value)
inline

Token to enable idempotency for export image requests.

Definition at line 65 of file ExportImageRequest.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::ExportImageRequest::SetClientToken ( Aws::String &&  value)
inline

Token to enable idempotency for export image requests.

Definition at line 70 of file ExportImageRequest.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::ExportImageRequest::SetClientToken ( const char *  value)
inline

Token to enable idempotency for export image requests.

Definition at line 75 of file ExportImageRequest.h.

◆ SetDescription() [1/3]

void Aws::EC2::Model::ExportImageRequest::SetDescription ( const Aws::String value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 109 of file ExportImageRequest.h.

◆ SetDescription() [2/3]

void Aws::EC2::Model::ExportImageRequest::SetDescription ( Aws::String &&  value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 115 of file ExportImageRequest.h.

◆ SetDescription() [3/3]

void Aws::EC2::Model::ExportImageRequest::SetDescription ( const char *  value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 121 of file ExportImageRequest.h.

◆ SetDiskImageFormat() [1/2]

void Aws::EC2::Model::ExportImageRequest::SetDiskImageFormat ( const DiskImageFormat value)
inline

The disk image format.

Definition at line 155 of file ExportImageRequest.h.

◆ SetDiskImageFormat() [2/2]

void Aws::EC2::Model::ExportImageRequest::SetDiskImageFormat ( DiskImageFormat &&  value)
inline

The disk image format.

Definition at line 160 of file ExportImageRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::ExportImageRequest::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 195 of file ExportImageRequest.h.

◆ SetImageId() [1/3]

void Aws::EC2::Model::ExportImageRequest::SetImageId ( const Aws::String value)
inline

The ID of the image.

Definition at line 219 of file ExportImageRequest.h.

◆ SetImageId() [2/3]

void Aws::EC2::Model::ExportImageRequest::SetImageId ( Aws::String &&  value)
inline

The ID of the image.

Definition at line 224 of file ExportImageRequest.h.

◆ SetImageId() [3/3]

void Aws::EC2::Model::ExportImageRequest::SetImageId ( const char *  value)
inline

The ID of the image.

Definition at line 229 of file ExportImageRequest.h.

◆ SetRoleName() [1/3]

void Aws::EC2::Model::ExportImageRequest::SetRoleName ( const Aws::String value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 309 of file ExportImageRequest.h.

◆ SetRoleName() [2/3]

void Aws::EC2::Model::ExportImageRequest::SetRoleName ( Aws::String &&  value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 316 of file ExportImageRequest.h.

◆ SetRoleName() [3/3]

void Aws::EC2::Model::ExportImageRequest::SetRoleName ( const char *  value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 323 of file ExportImageRequest.h.

◆ SetS3ExportLocation() [1/2]

void Aws::EC2::Model::ExportImageRequest::SetS3ExportLocation ( const ExportTaskS3LocationRequest value)
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 266 of file ExportImageRequest.h.

◆ SetS3ExportLocation() [2/2]

void Aws::EC2::Model::ExportImageRequest::SetS3ExportLocation ( ExportTaskS3LocationRequest &&  value)
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 273 of file ExportImageRequest.h.

◆ WithClientToken() [1/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithClientToken ( const Aws::String value)
inline

Token to enable idempotency for export image requests.

Definition at line 80 of file ExportImageRequest.h.

◆ WithClientToken() [2/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithClientToken ( Aws::String &&  value)
inline

Token to enable idempotency for export image requests.

Definition at line 85 of file ExportImageRequest.h.

◆ WithClientToken() [3/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithClientToken ( const char *  value)
inline

Token to enable idempotency for export image requests.

Definition at line 90 of file ExportImageRequest.h.

◆ WithDescription() [1/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithDescription ( const Aws::String value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 127 of file ExportImageRequest.h.

◆ WithDescription() [2/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithDescription ( Aws::String &&  value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 133 of file ExportImageRequest.h.

◆ WithDescription() [3/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithDescription ( const char *  value)
inline

A description of the image being exported. The maximum length is 255 bytes.

Definition at line 139 of file ExportImageRequest.h.

◆ WithDiskImageFormat() [1/2]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithDiskImageFormat ( const DiskImageFormat value)
inline

The disk image format.

Definition at line 165 of file ExportImageRequest.h.

◆ WithDiskImageFormat() [2/2]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithDiskImageFormat ( DiskImageFormat &&  value)
inline

The disk image format.

Definition at line 170 of file ExportImageRequest.h.

◆ WithDryRun()

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::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 203 of file ExportImageRequest.h.

◆ WithImageId() [1/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithImageId ( const Aws::String value)
inline

The ID of the image.

Definition at line 234 of file ExportImageRequest.h.

◆ WithImageId() [2/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithImageId ( Aws::String &&  value)
inline

The ID of the image.

Definition at line 239 of file ExportImageRequest.h.

◆ WithImageId() [3/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithImageId ( const char *  value)
inline

The ID of the image.

Definition at line 244 of file ExportImageRequest.h.

◆ WithRoleName() [1/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithRoleName ( const Aws::String value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 330 of file ExportImageRequest.h.

◆ WithRoleName() [2/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithRoleName ( Aws::String &&  value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 337 of file ExportImageRequest.h.

◆ WithRoleName() [3/3]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithRoleName ( const char *  value)
inline

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Definition at line 344 of file ExportImageRequest.h.

◆ WithS3ExportLocation() [1/2]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithS3ExportLocation ( const ExportTaskS3LocationRequest value)
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 280 of file ExportImageRequest.h.

◆ WithS3ExportLocation() [2/2]

ExportImageRequest& Aws::EC2::Model::ExportImageRequest::WithS3ExportLocation ( ExportTaskS3LocationRequest &&  value)
inline

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-im.nosp@m.port.nosp@m.-expo.nosp@m.rt@a.nosp@m.mazon.nosp@m..com.

Definition at line 287 of file ExportImageRequest.h.


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