libZSservicesZSamazonka-resourcegroupsZSamazonka-resourcegroups
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.ResourceGroups.ListGroups

Description

Returns a list of existing resource groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups' 

Fields

  • filters :: Maybe [GroupFilter]

    Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

    • resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.
    • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

      • AWS:EC2::CapacityReservationPool
      • AWS:EC2::HostManagement
  • nextToken :: Maybe Text

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

  • maxResults :: Maybe Natural

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Instances

Instances details
Eq ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Read ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Show ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Generic ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type #

NFData ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Methods

rnf :: ListGroups -> () #

Hashable ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

ToJSON ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

AWSPager ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

AWSRequest ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Associated Types

type AWSResponse ListGroups #

ToHeaders ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Methods

toHeaders :: ListGroups -> [Header] #

ToPath ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

ToQuery ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

type Rep ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.ResourceGroups.ListGroups" "libZSservicesZSamazonka-resourcegroupsZSamazonka-resourcegroups" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListGroups Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

newListGroups :: ListGroups Source #

Create a value of ListGroups 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:ListGroups', listGroups_filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.
  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool
    • AWS:EC2::HostManagement

$sel:nextToken:ListGroups', listGroups_nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

$sel:maxResults:ListGroups', listGroups_maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Request Lenses

listGroups_filters :: Lens' ListGroups (Maybe [GroupFilter]) Source #

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.
  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool
    • AWS:EC2::HostManagement

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse' 

Fields

  • groups :: Maybe [Group]

    /__Deprecated - don't use this field. Use the GroupIdentifiers response field instead.__/

  • nextToken :: Maybe Text

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • groupIdentifiers :: Maybe [GroupIdentifier]

    A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Read ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Show ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Generic ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type #

NFData ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
Instance details

Defined in Amazonka.ResourceGroups.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.ResourceGroups.ListGroups" "libZSservicesZSamazonka-resourcegroupsZSamazonka-resourcegroups" 'False) (C1 ('MetaCons "ListGroupsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Group])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "groupIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupIdentifier])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupsResponse Source #

Create a value of ListGroupsResponse 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:groups:ListGroupsResponse', listGroupsResponse_groups - /__Deprecated - don't use this field. Use the GroupIdentifiers response field instead.__/

$sel:nextToken:ListGroups', listGroupsResponse_nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

$sel:groupIdentifiers:ListGroupsResponse', listGroupsResponse_groupIdentifiers - A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [Group]) Source #

/__Deprecated - don't use this field. Use the GroupIdentifiers response field instead.__/

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

listGroupsResponse_groupIdentifiers :: Lens' ListGroupsResponse (Maybe [GroupIdentifier]) Source #

A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.