amazonka-workspaces-2.0: Amazon WorkSpaces 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.WorkSpaces.DescribeIpGroups

Description

Describes one or more of your IP access control groups.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeIpGroups Source #

See: newDescribeIpGroups smart constructor.

Constructors

DescribeIpGroups' 

Fields

  • groupIds :: Maybe [Text]

    The identifiers of one or more IP access control groups.

  • maxResults :: Maybe Natural

    The maximum number of items to return.

  • nextToken :: Maybe Text

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Instances

Instances details
ToJSON DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

ToHeaders DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

ToPath DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

ToQuery DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

AWSPager DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

AWSRequest DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type AWSResponse DescribeIpGroups #

Generic DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type Rep DescribeIpGroups :: Type -> Type #

Read DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Show DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

NFData DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

rnf :: DescribeIpGroups -> () #

Eq DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Hashable DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type AWSResponse DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type Rep DescribeIpGroups Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type Rep DescribeIpGroups = D1 ('MetaData "DescribeIpGroups" "Amazonka.WorkSpaces.DescribeIpGroups" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeIpGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeIpGroups :: DescribeIpGroups Source #

Create a value of DescribeIpGroups 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:groupIds:DescribeIpGroups', describeIpGroups_groupIds - The identifiers of one or more IP access control groups.

$sel:maxResults:DescribeIpGroups', describeIpGroups_maxResults - The maximum number of items to return.

DescribeIpGroups, describeIpGroups_nextToken - If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Request Lenses

describeIpGroups_groupIds :: Lens' DescribeIpGroups (Maybe [Text]) Source #

The identifiers of one or more IP access control groups.

describeIpGroups_maxResults :: Lens' DescribeIpGroups (Maybe Natural) Source #

The maximum number of items to return.

describeIpGroups_nextToken :: Lens' DescribeIpGroups (Maybe Text) Source #

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Destructuring the Response

data DescribeIpGroupsResponse Source #

See: newDescribeIpGroupsResponse smart constructor.

Constructors

DescribeIpGroupsResponse' 

Fields

Instances

Instances details
Generic DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type Rep DescribeIpGroupsResponse :: Type -> Type #

Read DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Show DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

NFData DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Eq DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type Rep DescribeIpGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type Rep DescribeIpGroupsResponse = D1 ('MetaData "DescribeIpGroupsResponse" "Amazonka.WorkSpaces.DescribeIpGroups" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeIpGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkspacesIpGroup])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeIpGroupsResponse Source #

Create a value of DescribeIpGroupsResponse 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:

DescribeIpGroups, describeIpGroupsResponse_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:result:DescribeIpGroupsResponse', describeIpGroupsResponse_result - Information about the IP access control groups.

$sel:httpStatus:DescribeIpGroupsResponse', describeIpGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeIpGroupsResponse_nextToken :: Lens' DescribeIpGroupsResponse (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.

describeIpGroupsResponse_result :: Lens' DescribeIpGroupsResponse (Maybe [WorkspacesIpGroup]) Source #

Information about the IP access control groups.