EC2 / Client / describe_fast_launch_images

describe_fast_launch_images

EC2.Client.describe_fast_launch_images(**kwargs)

Describe details for Windows AMIs that are configured for Windows fast launch.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ImageIds (list) –

  Specify one or more Windows AMI image IDs for the request.

  • (string) –

• Filters (list) –

  Use the following filters to streamline results.

  • resource-type - The resource type for pre-provisioning.

  • owner-id - The owner ID for the pre-provisioning resource.

  • state - The current state of fast launching for the Windows AMI.

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

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'FastLaunchImages': [
        {
            'ImageId': 'string',
            'ResourceType': 'snapshot',
            'SnapshotConfiguration': {
                'TargetResourceCount': 123
            },
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'MaxParallelLaunches': 123,
            'OwnerId': 'string',
            'State': 'enabling'|'enabling-failed'|'enabled'|'enabled-failed'|'disabling'|'disabling-failed',
            'StateTransitionReason': 'string',
            'StateTransitionTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FastLaunchImages (list) –

    A collection of details about the fast-launch enabled Windows images that meet the requested criteria.

    • (dict) –

      Describe details about a Windows image with Windows fast launch enabled that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters.

      • ImageId (string) –

        The image ID that identifies the Windows fast launch enabled image.

      • ResourceType (string) –

        The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values include: snapshot.

      • SnapshotConfiguration (dict) –

        A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.

        • TargetResourceCount (integer) –

          The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch enabled AMI.

      • LaunchTemplate (dict) –

        The launch template that the Windows fast launch enabled AMI uses when it launches Windows instances from pre-provisioned snapshots.

        • LaunchTemplateId (string) –

          The ID of the launch template that the AMI uses for Windows fast launch.

        • LaunchTemplateName (string) –

          The name of the launch template that the AMI uses for Windows fast launch.

        • Version (string) –

          The version of the launch template that the AMI uses for Windows fast launch.

      • MaxParallelLaunches (integer) –

        The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.

      • OwnerId (string) –

        The owner ID for the Windows fast launch enabled AMI.

      • State (string) –

        The current state of Windows fast launch for the specified Windows AMI.

      • StateTransitionReason (string) –

        The reason that Windows fast launch for the AMI changed to the current state.

      • StateTransitionTime (datetime) –

        The time that Windows fast launch for the AMI changed to the current state.

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