EC2 / Client / describe_store_image_tasks

describe_store_image_tasks

EC2.Client.describe_store_image_tasks(**kwargs)

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don’t specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ImageIds (list) –

  The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

  • (string) –

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

  • task-state - Returns tasks in a certain state ( InProgress | Completed | Failed)

  • bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

  Note

  When you specify the ImageIds parameter, any filters that you specify are ignored. To use the filters, you must remove the ImageIds parameter.

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

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• MaxResults (integer) –

  The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

  You cannot specify this parameter and the ImageIds parameter in the same call.

Return type:

dict

Returns:

Response Syntax

{
    'StoreImageTaskResults': [
        {
            'AmiId': 'string',
            'TaskStartTime': datetime(2015, 1, 1),
            'Bucket': 'string',
            'S3objectKey': 'string',
            'ProgressPercentage': 123,
            'StoreTaskState': 'string',
            'StoreTaskFailureReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • StoreImageTaskResults (list) –

    The information about the AMI store tasks.

    • (dict) –

      The information about the AMI store task, including the progress of the task.

      • AmiId (string) –

        The ID of the AMI that is being stored.

      • TaskStartTime (datetime) –

        The time the task started.

      • Bucket (string) –

        The name of the Amazon S3 bucket that contains the stored AMI object.

      • S3objectKey (string) –

        The name of the stored AMI object in the bucket.

      • ProgressPercentage (integer) –

        The progress of the task as a percentage.

      • StoreTaskState (string) –

        The state of the store task ( InProgress, Completed, or Failed).

      • StoreTaskFailureReason (string) –

        If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.