libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AutoScaling.DescribeAutoScalingGroups

Description

Gets information about the Auto Scaling groups in the account and Region.

If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.

This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeAutoScalingGroups Source #

See: newDescribeAutoScalingGroups smart constructor.

Constructors

DescribeAutoScalingGroups' 

Fields

  • filters :: Maybe [Filter]

    One or more filters to limit the results based on specific tags.

  • autoScalingGroupNames :: Maybe [Text]

    The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

    If you omit this parameter, all Auto Scaling groups are described.

  • nextToken :: Maybe Text

    The token for the next set of items to return. (You received this token from a previous call.)

  • maxRecords :: Maybe Int

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Instances

Instances details
Eq DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Read DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Show DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Generic DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Associated Types

type Rep DescribeAutoScalingGroups :: Type -> Type #

NFData DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Hashable DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

AWSPager DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

AWSRequest DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

ToHeaders DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

ToPath DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

ToQuery DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

type Rep DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

type Rep DescribeAutoScalingGroups = D1 ('MetaData "DescribeAutoScalingGroups" "Amazonka.AutoScaling.DescribeAutoScalingGroups" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "DescribeAutoScalingGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "autoScalingGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeAutoScalingGroups Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

newDescribeAutoScalingGroups :: DescribeAutoScalingGroups Source #

Create a value of DescribeAutoScalingGroups 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:filters:DescribeAutoScalingGroups', describeAutoScalingGroups_filters - One or more filters to limit the results based on specific tags.

$sel:autoScalingGroupNames:DescribeAutoScalingGroups', describeAutoScalingGroups_autoScalingGroupNames - The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

$sel:nextToken:DescribeAutoScalingGroups', describeAutoScalingGroups_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:maxRecords:DescribeAutoScalingGroups', describeAutoScalingGroups_maxRecords - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Request Lenses

describeAutoScalingGroups_filters :: Lens' DescribeAutoScalingGroups (Maybe [Filter]) Source #

One or more filters to limit the results based on specific tags.

describeAutoScalingGroups_autoScalingGroupNames :: Lens' DescribeAutoScalingGroups (Maybe [Text]) Source #

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

describeAutoScalingGroups_nextToken :: Lens' DescribeAutoScalingGroups (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeAutoScalingGroups_maxRecords :: Lens' DescribeAutoScalingGroups (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Destructuring the Response

data DescribeAutoScalingGroupsResponse Source #

See: newDescribeAutoScalingGroupsResponse smart constructor.

Constructors

DescribeAutoScalingGroupsResponse' 

Fields

  • nextToken :: Maybe Text

    A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

  • httpStatus :: Int

    The response's http status code.

  • autoScalingGroups :: [AutoScalingGroup]

    The groups.

Instances

Instances details
Eq DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Read DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Show DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Generic DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

Associated Types

type Rep DescribeAutoScalingGroupsResponse :: Type -> Type #

NFData DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

type Rep DescribeAutoScalingGroupsResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.DescribeAutoScalingGroups

type Rep DescribeAutoScalingGroupsResponse = D1 ('MetaData "DescribeAutoScalingGroupsResponse" "Amazonka.AutoScaling.DescribeAutoScalingGroups" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "DescribeAutoScalingGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "autoScalingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AutoScalingGroup]))))

newDescribeAutoScalingGroupsResponse Source #

Create a value of DescribeAutoScalingGroupsResponse 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:nextToken:DescribeAutoScalingGroups', describeAutoScalingGroupsResponse_nextToken - A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

$sel:httpStatus:DescribeAutoScalingGroupsResponse', describeAutoScalingGroupsResponse_httpStatus - The response's http status code.

$sel:autoScalingGroups:DescribeAutoScalingGroupsResponse', describeAutoScalingGroupsResponse_autoScalingGroups - The groups.

Response Lenses

describeAutoScalingGroupsResponse_nextToken :: Lens' DescribeAutoScalingGroupsResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.