amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeLaunchTemplateVersions

Description

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeLaunchTemplateVersions Source #

See: newDescribeLaunchTemplateVersions smart constructor.

Constructors

DescribeLaunchTemplateVersions' 

Fields

  • dryRun :: Maybe Bool

    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 :: Maybe [Filter]

    One or more filters.

    • create-time - The time the launch template version was created.
    • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
    • http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
    • http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
    • host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
    • http-tokens - The state of token usage for your instance metadata requests (optional | required).
    • iam-instance-profile - The ARN of the IAM instance profile.
    • image-id - The ID of the AMI.
    • instance-type - The instance type.
    • is-default-version - A boolean that indicates whether the launch template version is the default version.
    • kernel-id - The kernel ID.
    • license-configuration-arn - The ARN of the license configuration.
    • network-card-index - The index of the network card.
    • ram-disk-id - The RAM disk ID.
  • launchTemplateId :: Maybe Text

    The ID of the launch template.

    To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.

    To describe all the latest or default launch template versions in your account, you must omit this parameter.

  • launchTemplateName :: Maybe Text

    The name of the launch template.

    To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.

    To describe all the latest or default launch template versions in your account, you must omit this parameter.

  • maxResults :: Maybe Int

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

  • maxVersion :: Maybe Text

    The version number up to which to describe launch template versions.

  • minVersion :: Maybe Text

    The version number after which to describe launch template versions.

  • nextToken :: Maybe Text

    The token to request the next page of results.

  • versions :: Maybe [Text]

    One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.

    To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.

    To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.

Instances

Instances details
ToHeaders DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

ToPath DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

ToQuery DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

AWSPager DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

AWSRequest DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Generic DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Associated Types

type Rep DescribeLaunchTemplateVersions :: Type -> Type #

Read DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Show DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

NFData DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Eq DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Hashable DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

type AWSResponse DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

type Rep DescribeLaunchTemplateVersions Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

type Rep DescribeLaunchTemplateVersions = D1 ('MetaData "DescribeLaunchTemplateVersions" "Amazonka.EC2.DescribeLaunchTemplateVersions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeLaunchTemplateVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "launchTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchTemplateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "minVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newDescribeLaunchTemplateVersions :: DescribeLaunchTemplateVersions Source #

Create a value of DescribeLaunchTemplateVersions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_dryRun - 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.

$sel:filters:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_filters - One or more filters.

  • create-time - The time the launch template version was created.
  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
  • http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
  • http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
  • host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
  • http-tokens - The state of token usage for your instance metadata requests (optional | required).
  • iam-instance-profile - The ARN of the IAM instance profile.
  • image-id - The ID of the AMI.
  • instance-type - The instance type.
  • is-default-version - A boolean that indicates whether the launch template version is the default version.
  • kernel-id - The kernel ID.
  • license-configuration-arn - The ARN of the license configuration.
  • network-card-index - The index of the network card.
  • ram-disk-id - The RAM disk ID.

DescribeLaunchTemplateVersions, describeLaunchTemplateVersions_launchTemplateId - The ID of the launch template.

To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.

To describe all the latest or default launch template versions in your account, you must omit this parameter.

DescribeLaunchTemplateVersions, describeLaunchTemplateVersions_launchTemplateName - The name of the launch template.

To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.

To describe all the latest or default launch template versions in your account, you must omit this parameter.

$sel:maxResults:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_maxResults - The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

$sel:maxVersion:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_maxVersion - The version number up to which to describe launch template versions.

$sel:minVersion:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_minVersion - The version number after which to describe launch template versions.

DescribeLaunchTemplateVersions, describeLaunchTemplateVersions_nextToken - The token to request the next page of results.

$sel:versions:DescribeLaunchTemplateVersions', describeLaunchTemplateVersions_versions - One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.

To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.

To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.

Request Lenses

describeLaunchTemplateVersions_dryRun :: Lens' DescribeLaunchTemplateVersions (Maybe Bool) Source #

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.

describeLaunchTemplateVersions_filters :: Lens' DescribeLaunchTemplateVersions (Maybe [Filter]) Source #

One or more filters.

  • create-time - The time the launch template version was created.
  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
  • http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
  • http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
  • host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
  • http-tokens - The state of token usage for your instance metadata requests (optional | required).
  • iam-instance-profile - The ARN of the IAM instance profile.
  • image-id - The ID of the AMI.
  • instance-type - The instance type.
  • is-default-version - A boolean that indicates whether the launch template version is the default version.
  • kernel-id - The kernel ID.
  • license-configuration-arn - The ARN of the license configuration.
  • network-card-index - The index of the network card.
  • ram-disk-id - The RAM disk ID.

describeLaunchTemplateVersions_launchTemplateId :: Lens' DescribeLaunchTemplateVersions (Maybe Text) Source #

The ID of the launch template.

To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.

To describe all the latest or default launch template versions in your account, you must omit this parameter.

describeLaunchTemplateVersions_launchTemplateName :: Lens' DescribeLaunchTemplateVersions (Maybe Text) Source #

The name of the launch template.

To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.

To describe all the latest or default launch template versions in your account, you must omit this parameter.

describeLaunchTemplateVersions_maxResults :: Lens' DescribeLaunchTemplateVersions (Maybe Int) Source #

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

describeLaunchTemplateVersions_maxVersion :: Lens' DescribeLaunchTemplateVersions (Maybe Text) Source #

The version number up to which to describe launch template versions.

describeLaunchTemplateVersions_minVersion :: Lens' DescribeLaunchTemplateVersions (Maybe Text) Source #

The version number after which to describe launch template versions.

describeLaunchTemplateVersions_versions :: Lens' DescribeLaunchTemplateVersions (Maybe [Text]) Source #

One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.

To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.

To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.

Destructuring the Response

data DescribeLaunchTemplateVersionsResponse Source #

Constructors

DescribeLaunchTemplateVersionsResponse' 

Fields

Instances

Instances details
Generic DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Read DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Show DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

NFData DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

Eq DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

type Rep DescribeLaunchTemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLaunchTemplateVersions

type Rep DescribeLaunchTemplateVersionsResponse = D1 ('MetaData "DescribeLaunchTemplateVersionsResponse" "Amazonka.EC2.DescribeLaunchTemplateVersions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeLaunchTemplateVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "launchTemplateVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LaunchTemplateVersion])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeLaunchTemplateVersionsResponse Source #

Create a value of DescribeLaunchTemplateVersionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:launchTemplateVersions:DescribeLaunchTemplateVersionsResponse', describeLaunchTemplateVersionsResponse_launchTemplateVersions - Information about the launch template versions.

DescribeLaunchTemplateVersions, describeLaunchTemplateVersionsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeLaunchTemplateVersionsResponse', describeLaunchTemplateVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeLaunchTemplateVersionsResponse_nextToken :: Lens' DescribeLaunchTemplateVersionsResponse (Maybe Text) Source #

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