AWS API Changes

2021/08/19 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes The ImportImage API now supports the ability to create AMIs with AWS-managed licenses for Microsoft SQL Server for both Windows and Linux.

DescribeImportImageTasks (updated)

Link ¶
Changes (response)

{'ImportImageTasks': {'UsageOperation': 'string'}}

Displays details about an import virtual machine or import snapshot tasks that are already created.

See also: AWS API Documentation

Request Syntax

client.describe_import_image_tasks(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ImportTaskIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun:

boolean

param DryRun:

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.

type Filters:

list

param Filters:

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type ImportTaskIds:

list

param ImportTaskIds:

The IDs of the import image tasks.

(string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

A token that indicates the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'ImportImageTasks': [
        {
            'Architecture': 'string',
            'Description': 'string',
            'Encrypted': True|False,
            'Hypervisor': 'string',
            'ImageId': 'string',
            'ImportTaskId': 'string',
            'KmsKeyId': 'string',
            'LicenseType': 'string',
            'Platform': 'string',
            'Progress': 'string',
            'SnapshotDetails': [
                {
                    'Description': 'string',
                    'DeviceName': 'string',
                    'DiskImageSize': 123.0,
                    'Format': 'string',
                    'Progress': 'string',
                    'SnapshotId': 'string',
                    'Status': 'string',
                    'StatusMessage': 'string',
                    'Url': 'string',
                    'UserBucket': {
                        'S3Bucket': 'string',
                        'S3Key': 'string'
                    }
                },
            ],
            'Status': 'string',
            'StatusMessage': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'LicenseSpecifications': [
                {
                    'LicenseConfigurationArn': 'string'
                },
            ],
            'UsageOperation': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ImportImageTasks (list) --
  
  A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
  - (dict) --
    
    Describes an import image task.
    - Architecture (string) --
      
      The architecture of the virtual machine.
      
      Valid values: i386 | x86_64 | arm64
    - Description (string) --
      
      A description of the import task.
    - Encrypted (boolean) --
      
      Indicates whether the image is encrypted.
    - Hypervisor (string) --
      
      The target hypervisor for the import task.
      
      Valid values: xen
    - ImageId (string) --
      
      The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
    - ImportTaskId (string) --
      
      The ID of the import image task.
    - KmsKeyId (string) --
      
      The identifier for the KMS key that was used to create the encrypted image.
    - LicenseType (string) --
      
      The license type of the virtual machine.
    - Platform (string) --
      
      The description string for the import image task.
    - Progress (string) --
      
      The percentage of progress of the import image task.
    - SnapshotDetails (list) --
      
      Information about the snapshots.
      - (dict) --
        
        Describes the snapshot created from the imported disk.
        
        Description (string) --
        
        A description for the snapshot.
        
        DeviceName (string) --
        
        The block device mapping for the snapshot.
        
        DiskImageSize (float) --
        
        The size of the disk in the snapshot, in GiB.
        
        Format (string) --
        
        The format of the disk image from which the snapshot is created.
        
        Progress (string) --
        
        The percentage of progress for the task.
        
        SnapshotId (string) --
        
        The snapshot ID of the disk being imported.
        
        Status (string) --
        
        A brief status of the snapshot creation.
        
        StatusMessage (string) --
        
        A detailed status message for the snapshot creation.
        
        Url (string) --
        
        The URL used to access the disk image.
        
        UserBucket (dict) --
        
        The Amazon S3 bucket for the disk image.
        
        S3Bucket (string) --
        
        The Amazon S3 bucket from which the disk image was created.
        
        S3Key (string) --
        
        The file name of the disk image.
    - Status (string) --
      
      A brief status for the import image task.
    - StatusMessage (string) --
      
      A descriptive status message for the import image task.
    - Tags (list) --
      
      The tags for the import 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 255 Unicode characters.
    - LicenseSpecifications (list) --
      
      The ARNs of the license configurations that are associated with the import image task.
      - (dict) --
        
        The response information for license configurations.
        
        LicenseConfigurationArn (string) --
        
        The ARN of a license configuration.
    - UsageOperation (string) --
      
      The usage operation value.
- NextToken (string) --
  
  The token to use to get the next page of results. This value is null when there are no more results to return.

ImportImage (updated)

Link ¶
Changes (both)

{'UsageOperation': 'string'}

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

See also: AWS API Documentation

Request Syntax

client.import_image(
    Architecture='string',
    ClientData={
        'Comment': 'string',
        'UploadEnd': datetime(2015, 1, 1),
        'UploadSize': 123.0,
        'UploadStart': datetime(2015, 1, 1)
    },
    ClientToken='string',
    Description='string',
    DiskContainers=[
        {
            'Description': 'string',
            'DeviceName': 'string',
            'Format': 'string',
            'SnapshotId': 'string',
            'Url': 'string',
            'UserBucket': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            }
        },
    ],
    DryRun=True|False,
    Encrypted=True|False,
    Hypervisor='string',
    KmsKeyId='string',
    LicenseType='string',
    Platform='string',
    RoleName='string',
    LicenseSpecifications=[
        {
            'LicenseConfigurationArn': 'string'
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': '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'|'instance-event-window'|'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'|'security-group-rule'|'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',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    UsageOperation='string'
)

type Architecture:

string

param Architecture:

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

type ClientData:

dict

param ClientData:

The client-specific data.

Comment (string) --

A user-defined comment about the disk upload.
UploadEnd (datetime) --

The time that the disk upload ends.
UploadSize (float) --

The size of the uploaded disk image, in GiB.
UploadStart (datetime) --

The time that the disk upload starts.

type ClientToken:

string

param ClientToken:

The token to enable idempotency for VM import requests.

type Description:

string

param Description:

A description string for the import image task.

type DiskContainers:

list

param DiskContainers:

Information about the disk containers.

(dict) --

Describes the disk container object for an import image task.
- Description (string) --
  
  The description of the disk image.
- DeviceName (string) --
  
  The block device mapping for the disk.
- Format (string) --
  
  The format of the disk image being imported.
  
  Valid values: OVA | VHD | VHDX | VMDK | RAW
- SnapshotId (string) --
  
  The ID of the EBS snapshot to be used for importing the snapshot.
- Url (string) --
  
  The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
- UserBucket (dict) --
  
  The S3 bucket for the disk image.
  - S3Bucket (string) --
    
    The name of the Amazon S3 bucket where the disk image is located.
  - S3Key (string) --
    
    The file name of the disk image.

type DryRun:

boolean

param DryRun:

type Encrypted:

boolean

param Encrypted:

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

type Hypervisor:

string

param Hypervisor:

The target hypervisor platform.

Valid values: xen

type KmsKeyId:

string

param KmsKeyId:

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

type LicenseType:

string

param LicenseType:

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

type Platform:

string

param Platform:

The operating system of the virtual machine.

Valid values: Windows | Linux

type RoleName:

string

param RoleName:

The name of the role to use when not using the default role, 'vmimport'.

type LicenseSpecifications:

list

param LicenseSpecifications:

The ARNs of the license configurations.

(dict) --

The request information of license configurations.
- LicenseConfigurationArn (string) --
  
  The ARN of a license configuration.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the import image task during creation.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | 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 | instance-event-window | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances | route-table | security-group``| ``snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for Amazon Web Services PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.
  
  To tag a resource after it has been created, see CreateTags.
- 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 255 Unicode characters.

type UsageOperation:

string

param UsageOperation:

The usage operation value. For more information, see AMI billing information fields in the Amazon Elastic Compute Cloud User Guide.

rtype:

dict

returns:

Response Syntax

{
    'Architecture': 'string',
    'Description': 'string',
    'Encrypted': True|False,
    'Hypervisor': 'string',
    'ImageId': 'string',
    'ImportTaskId': 'string',
    'KmsKeyId': 'string',
    'LicenseType': 'string',
    'Platform': 'string',
    'Progress': 'string',
    'SnapshotDetails': [
        {
            'Description': 'string',
            'DeviceName': 'string',
            'DiskImageSize': 123.0,
            'Format': 'string',
            'Progress': 'string',
            'SnapshotId': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'Url': 'string',
            'UserBucket': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            }
        },
    ],
    'Status': 'string',
    'StatusMessage': 'string',
    'LicenseSpecifications': [
        {
            'LicenseConfigurationArn': 'string'
        },
    ],
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'UsageOperation': 'string'
}

Response Structure

(dict) --
- Architecture (string) --
  
  The architecture of the virtual machine.
- Description (string) --
  
  A description of the import task.
- Encrypted (boolean) --
  
  Indicates whether the AMI is encrypted.
- Hypervisor (string) --
  
  The target hypervisor of the import task.
- ImageId (string) --
  
  The ID of the Amazon Machine Image (AMI) created by the import task.
- ImportTaskId (string) --
  
  The task ID of the import image task.
- KmsKeyId (string) --
  
  The identifier for the symmetric KMS key that was used to create the encrypted AMI.
- LicenseType (string) --
  
  The license type of the virtual machine.
- Platform (string) --
  
  The operating system of the virtual machine.
- Progress (string) --
  
  The progress of the task.
- SnapshotDetails (list) --
  
  Information about the snapshots.
  - (dict) --
    
    Describes the snapshot created from the imported disk.
    - Description (string) --
      
      A description for the snapshot.
    - DeviceName (string) --
      
      The block device mapping for the snapshot.
    - DiskImageSize (float) --
      
      The size of the disk in the snapshot, in GiB.
    - Format (string) --
      
      The format of the disk image from which the snapshot is created.
    - Progress (string) --
      
      The percentage of progress for the task.
    - SnapshotId (string) --
      
      The snapshot ID of the disk being imported.
    - Status (string) --
      
      A brief status of the snapshot creation.
    - StatusMessage (string) --
      
      A detailed status message for the snapshot creation.
    - Url (string) --
      
      The URL used to access the disk image.
    - UserBucket (dict) --
      
      The Amazon S3 bucket for the disk image.
      - S3Bucket (string) --
        
        The Amazon S3 bucket from which the disk image was created.
      - S3Key (string) --
        
        The file name of the disk image.
- Status (string) --
  
  A brief status of the task.
- StatusMessage (string) --
  
  A detailed status message of the import task.
- LicenseSpecifications (list) --
  
  The ARNs of the license configurations.
  - (dict) --
    
    The response information for license configurations.
    - LicenseConfigurationArn (string) --
      
      The ARN of a license configuration.
- Tags (list) --
  
  Any tags assigned to the import 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 255 Unicode characters.
- UsageOperation (string) --
  
  The usage operation value.