Amazonka.WorkSpaces.DescribeIpGroups

Describes one or more of your IP access control groups.

This operation returns paginated results.

Creating a Request

data DescribeIpGroups

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

ToJSON DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

toJSON :: DescribeIpGroups -> Value

toEncoding :: DescribeIpGroups -> Encoding

toJSONList :: [DescribeIpGroups] -> Value

toEncodingList :: [DescribeIpGroups] -> Encoding

ToHeaders DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

toHeaders :: DescribeIpGroups -> [Header]

ToPath DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

toPath :: DescribeIpGroups -> ByteString

ToQuery DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

toQuery :: DescribeIpGroups -> QueryString

AWSPager DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

page :: DescribeIpGroups -> AWSResponse DescribeIpGroups -> Maybe DescribeIpGroups

AWSRequest DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type AWSResponse DescribeIpGroups

Methods

request :: (Service -> Service) -> DescribeIpGroups -> Request DescribeIpGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeIpGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIpGroups)))

Generic DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type Rep DescribeIpGroups :: Type -> Type

Methods

from :: DescribeIpGroups -> Rep DescribeIpGroups x

to :: Rep DescribeIpGroups x -> DescribeIpGroups

Read DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

readsPrec :: Int -> ReadS DescribeIpGroups

readList :: ReadS [DescribeIpGroups]

readPrec :: ReadPrec DescribeIpGroups

readListPrec :: ReadPrec [DescribeIpGroups]

Show DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

showsPrec :: Int -> DescribeIpGroups -> ShowS

show :: DescribeIpGroups -> String

showList :: [DescribeIpGroups] -> ShowS

NFData DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

rnf :: DescribeIpGroups -> ()

Eq DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

(==) :: DescribeIpGroups -> DescribeIpGroups -> Bool

(/=) :: DescribeIpGroups -> DescribeIpGroups -> Bool

Hashable DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

hashWithSalt :: Int -> DescribeIpGroups -> Int

hash :: DescribeIpGroups -> Int

type AWSResponse DescribeIpGroups

Defined in Amazonka.WorkSpaces.DescribeIpGroups

type AWSResponse DescribeIpGroups = DescribeIpGroupsResponse

type Rep DescribeIpGroups

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

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])

The identifiers of one or more IP access control groups.

describeIpGroups_maxResults :: Lens' DescribeIpGroups (Maybe Natural)

The maximum number of items to return.

describeIpGroups_nextToken :: Lens' DescribeIpGroups (Maybe Text)

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

See: newDescribeIpGroupsResponse smart constructor.

Constructors

DescribeIpGroupsResponse'

Fields

• nextToken :: Maybe Text

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

• result :: Maybe [WorkspacesIpGroup]

  Information about the IP access control groups.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeIpGroupsResponse

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Associated Types

type Rep DescribeIpGroupsResponse :: Type -> Type

Methods

from :: DescribeIpGroupsResponse -> Rep DescribeIpGroupsResponse x

to :: Rep DescribeIpGroupsResponse x -> DescribeIpGroupsResponse

Read DescribeIpGroupsResponse

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

readsPrec :: Int -> ReadS DescribeIpGroupsResponse

readList :: ReadS [DescribeIpGroupsResponse]

readPrec :: ReadPrec DescribeIpGroupsResponse

readListPrec :: ReadPrec [DescribeIpGroupsResponse]

Show DescribeIpGroupsResponse

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

showsPrec :: Int -> DescribeIpGroupsResponse -> ShowS

show :: DescribeIpGroupsResponse -> String

showList :: [DescribeIpGroupsResponse] -> ShowS

NFData DescribeIpGroupsResponse

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

rnf :: DescribeIpGroupsResponse -> ()

Eq DescribeIpGroupsResponse

Defined in Amazonka.WorkSpaces.DescribeIpGroups

Methods

(==) :: DescribeIpGroupsResponse -> DescribeIpGroupsResponse -> Bool

(/=) :: DescribeIpGroupsResponse -> DescribeIpGroupsResponse -> Bool

type Rep DescribeIpGroupsResponse

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

Arguments

:: Int

$sel:httpStatus:DescribeIpGroupsResponse'

-> DescribeIpGroupsResponse

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)

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])

Information about the IP access control groups.

describeIpGroupsResponse_httpStatus :: Lens' DescribeIpGroupsResponse Int

The response's http status code.