describe_export_tasks

describe_export_tasks(**kwargs)

Describes the specified export instance tasks or all of your export instance tasks.

See also: AWS API Documentation

Request Syntax

response = client.describe_export_tasks(
    ExportTaskIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters

• ExportTaskIds (list) --

  The export task IDs.

  • (string) --
• Filters (list) --

  the filters for the export tasks.

  • (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.

    If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

      • (string) --

Return type

dict

Returns

Response Syntax

{
    'ExportTasks': [
        {
            '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) --

  • ExportTasks (list) --

    Information about the export tasks.

    • (dict) --

      Describes an 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.