NAME

Paws::EC2::ExportImage - Arguments for method ExportImage on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method ExportImage on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method ExportImage.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportImage.

SYNOPSIS

    my $ec2 = Paws->service('EC2');
    my $ExportImageResult = $ec2->ExportImage(
      DiskImageFormat  => 'VMDK',
      ImageId          => 'MyImageId',
      S3ExportLocation => {
        S3Bucket => 'MyString',
        S3Prefix => 'MyString',
      },
      ClientToken       => 'MyString',    # OPTIONAL
      Description       => 'MyString',    # OPTIONAL
      DryRun            => 1,             # OPTIONAL
      RoleName          => 'MyString',    # OPTIONAL
      TagSpecifications => [
        {
          ResourceType => 'client-vpn-endpoint'
          , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL
          Tags => [
            {
              Key   => 'MyString',
              Value => 'MyString',
            },
            ...
          ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $Description       = $ExportImageResult->Description;
    my $DiskImageFormat   = $ExportImageResult->DiskImageFormat;
    my $ExportImageTaskId = $ExportImageResult->ExportImageTaskId;
    my $ImageId           = $ExportImageResult->ImageId;
    my $Progress          = $ExportImageResult->Progress;
    my $RoleName          = $ExportImageResult->RoleName;
    my $S3ExportLocation  = $ExportImageResult->S3ExportLocation;
    my $Status            = $ExportImageResult->Status;
    my $StatusMessage     = $ExportImageResult->StatusMessage;
    my $Tags              = $ExportImageResult->Tags;
    # Returns a L<Paws::EC2::ExportImageResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ec2/ExportImage>

ATTRIBUTES

ClientToken => Str

Token to enable idempotency for export image requests.

Description => Str

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

REQUIRED DiskImageFormat => Str

The disk image format.

Valid values are: "VMDK", "RAW", "VHD"

DryRun => Bool

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

REQUIRED ImageId => Str

The ID of the image.

RoleName => Str

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

REQUIRED S3ExportLocation => Paws::EC2::ExportTaskS3LocationRequest

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.