EC2 / Paginator / DescribeImportSnapshotTasks

DescribeImportSnapshotTasks

class EC2.Paginator.DescribeImportSnapshotTasks

paginator = client.get_paginator('describe_import_snapshot_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_import_snapshot_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ImportTaskIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• Filters (list) –

  The filters.

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

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • 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) –

• ImportTaskIds (list) –

  A list of import snapshot task IDs.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ImportSnapshotTasks': [
        {
            'Description': 'string',
            'ImportTaskId': 'string',
            'SnapshotTaskDetail': {
                'Description': 'string',
                'DiskImageSize': 123.0,
                'Encrypted': True|False,
                'Format': 'string',
                'KmsKeyId': 'string',
                'Progress': 'string',
                'SnapshotId': 'string',
                'Status': 'string',
                'StatusMessage': 'string',
                'Url': 'string',
                'UserBucket': {
                    'S3Bucket': 'string',
                    'S3Key': 'string'
                }
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • ImportSnapshotTasks (list) –

    A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

    • (dict) –

      Describes an import snapshot task.

      • Description (string) –

        A description of the import snapshot task.

      • ImportTaskId (string) –

        The ID of the import snapshot task.

      • SnapshotTaskDetail (dict) –

        Describes an import snapshot task.

        • Description (string) –

          The description of the disk image being imported.

        • DiskImageSize (float) –

          The size of the disk in the snapshot, in GiB.

        • Encrypted (boolean) –

          Indicates whether the snapshot is encrypted.

        • Format (string) –

          The format of the disk image from which the snapshot is created.

        • KmsKeyId (string) –

          The identifier for the KMS key that was used to create the encrypted snapshot.

        • Progress (string) –

          The percentage of completion for the import snapshot task.

        • SnapshotId (string) –

          The snapshot ID of the disk being imported.

        • Status (string) –

          A brief status for the import snapshot task.

        • StatusMessage (string) –

          A detailed status message for the import snapshot task.

        • Url (string) –

          The URL of the disk image from which the snapshot is created.

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

      • Tags (list) –

        The tags for the import snapshot 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.