EC2 / Client / export_image

export_image#

EC2.Client.export_image(**kwargs)#

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.

Request Syntax

response = client.export_image(
    ClientToken='string',
    Description='string',
    DiskImageFormat='VMDK'|'RAW'|'VHD',
    DryRun=True|False,
    ImageId='string',
    S3ExportLocation={
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    RoleName='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

ClientToken (string) –
Token to enable idempotency for export image requests.

This field is autopopulated if not provided.
Description (string) – A description of the image being exported. The maximum length is 255 characters.
DiskImageFormat (string) –
[REQUIRED]

The disk image format.
DryRun (boolean) – 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.
ImageId (string) –
[REQUIRED]

The ID of the image.
S3ExportLocation (dict) –
[REQUIRED]

The Amazon S3 bucket for the destination image. The destination bucket must exist.
- S3Bucket (string) – [REQUIRED]
  
  The destination Amazon S3 bucket.
- S3Prefix (string) –
  
  The prefix (logical hierarchy) in the bucket.
RoleName (string) – 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’.
TagSpecifications (list) –
The tags to apply to the export image task during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
    'ExportImageTaskId': 'string',
    'ImageId': 'string',
    'RoleName': 'string',
    'Progress': 'string',
    'S3ExportLocation': {
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    'Status': 'string',
    'StatusMessage': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
- Description (string) –
  
  A description of the image being exported.
- DiskImageFormat (string) –
  
  The disk image format for the exported image.
- ExportImageTaskId (string) –
  
  The ID of the export image task.
- ImageId (string) –
  
  The ID of the image.
- RoleName (string) –
  
  The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
- Progress (string) –
  
  The percent complete of the export image task.
- S3ExportLocation (dict) –
  
  Information about the destination Amazon S3 bucket.
  - S3Bucket (string) –
    
    The destination Amazon S3 bucket.
  - S3Prefix (string) –
    
    The prefix (logical hierarchy) in the bucket.
- Status (string) –
  
  The status of the export image task. The possible values are active, completed, deleting, and deleted.
- StatusMessage (string) –
  
  The status message for the export image task.
- Tags (list) –
  
  Any tags assigned to the export image task.
  - (dict) –
    
    Describes a tag.
    - Key (string) –
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) –
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.