EC2 / Client / create_instance_export_task

create_instance_export_task#

EC2.Client.create_instance_export_task(**kwargs)#

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_instance_export_task(
    Description='string',
    ExportToS3Task={
        'ContainerFormat': 'ova',
        'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    InstanceId='string',
    TargetEnvironment='citrix'|'vmware'|'microsoft',
    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:

Description (string) – A description for the conversion task or the resource being exported. The maximum length is 255 characters.
ExportToS3Task (dict) –
[REQUIRED]

The format and location for an export instance task.
- ContainerFormat (string) –
  
  The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
- DiskImageFormat (string) –
  
  The format for the exported image.
- S3Bucket (string) –
  
  The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
- S3Prefix (string) –
  
  The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + ‘.’ + diskImageFormat.
InstanceId (string) –
[REQUIRED]

The ID of the instance.
TargetEnvironment (string) –
[REQUIRED]

The target virtualization environment.
TagSpecifications (list) –
The tags to apply to the export instance 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

{
    'ExportTask': {
        'Description': 'string',
        'ExportTaskId': 'string',
        'ExportToS3Task': {
            'ContainerFormat': 'ova',
            'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'InstanceExportDetails': {
            'InstanceId': 'string',
            'TargetEnvironment': 'citrix'|'vmware'|'microsoft'
        },
        'State': 'active'|'cancelling'|'cancelled'|'completed',
        'StatusMessage': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- ExportTask (dict) –
  
  Information about the export instance task.
  - Description (string) –
    
    A description of the resource being exported.
  - ExportTaskId (string) –
    
    The ID of the export task.
  - ExportToS3Task (dict) –
    
    Information about the export task.
    - ContainerFormat (string) –
      
      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
    - DiskImageFormat (string) –
      
      The format for the exported image.
    - S3Bucket (string) –
      
      The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
    - S3Key (string) –
      
      The encryption key for your S3 bucket.
  - InstanceExportDetails (dict) –
    
    Information about the instance to export.
    - InstanceId (string) –
      
      The ID of the resource being exported.
    - TargetEnvironment (string) –
      
      The target virtualization environment.
  - State (string) –
    
    The state of the export task.
  - StatusMessage (string) –
    
    The status message related to the export task.
  - Tags (list) –
    
    The tags for the export 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.