describe-fast-launch-images¶

Description¶

Describe details for Windows AMIs that are configured for faster launching.

Synopsis¶

  describe-fast-launch-images
[--image-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--image-ids (list)

Details for one or more Windows AMI image IDs.

(string)

Syntax:

"string" "string" ...

--filters (list)

Use the following filters to streamline results.

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

launch-template - The launch template that is associated with the pre-provisioned Windows AMI.

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

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

(structure)

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)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe the details for Windows AMIs that are configured for faster launching

The following describe-fast-launch-images example describes the details for each of the AMIs in your account that are configured for faster launching, including the resource type, the snapshot configuration, the launch template details, the maximum number of parallel launches, the AMI owner ID, the state of the fast launch configuration, the reason the state was changed, and the time that the state change occurred.

aws ec2 describe-fast-launch-images

Output:

{
    "FastLaunchImages": [
        {
            "ImageId": "ami-01234567890abcedf",
            "ResourceType": "snapshot",
            "SnapshotConfiguration": {},
            "LaunchTemplate": {
                "LaunchTemplateId": "lt-01234567890abcedf",
                "LaunchTemplateName": "EC2FastLaunchDefaultResourceCreation-a8c6215d-94e6-441b-9272-dbd1f87b07e2",
                "Version": "1"
            },
            "MaxParallelLaunches": 6,
            "OwnerId": "0123456789123",
            "State": "enabled",
            "StateTransitionReason": "Client.UserInitiated",
            "StateTransitionTime": "2022-01-27T22:20:06.552000+00:00"
        }
    ]
}

For more information about configuring a Windows AMI for faster launching, see Configure your AMI for faster launching in the Amazon EC2 User Guide.

Output¶

FastLaunchImages -> (list)

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

(structure)

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

ImageId -> (string)

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

ResourceType -> (string)

The resource type that is used for pre-provisioning the Windows AMI. Supported values include: snapshot .

SnapshotConfiguration -> (structure)

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 fast-launch enabled Windows AMI.

LaunchTemplate -> (structure)

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

LaunchTemplateId -> (string)

The ID of the launch template for faster launching of the associated Windows AMI.

LaunchTemplateName -> (string)

The name of the launch template for faster launching of the associated Windows AMI.

Version -> (string)

The version of the launch template for faster launching of the associated Windows AMI.

MaxParallelLaunches -> (integer)

The maximum number of parallel instances that are launched for creating resources.

OwnerId -> (string)

The owner ID for the fast-launch enabled Windows AMI.

State -> (string)

The current state of faster launching for the specified Windows AMI.

StateTransitionReason -> (string)

The reason that faster launching for the Windows AMI changed to the current state.

StateTransitionTime -> (timestamp)

The time that faster launching for the Windows AMI changed to the current state.

NextToken -> (string)

The token to use for the next set of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide