DescribeIpGroupsCommand

Suggest an Edit

Describes one or more of your IP access control groups.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesClient, DescribeIpGroupsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, DescribeIpGroupsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // DescribeIpGroupsRequest
  GroupIds: [ // IpGroupIdList
    "STRING_VALUE",
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeIpGroupsCommand(input);
const response = await client.send(command);
// { // DescribeIpGroupsResult
//   Result: [ // WorkspacesIpGroupsList
//     { // WorkspacesIpGroup
//       groupId: "STRING_VALUE",
//       groupName: "STRING_VALUE",
//       groupDesc: "STRING_VALUE",
//       userRules: [ // IpRuleList
//         { // IpRuleItem
//           ipRule: "STRING_VALUE",
//           ruleDesc: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeIpGroupsCommand Input

See DescribeIpGroupsCommandInput for more details

Parameter
Type
Description
GroupIds
string[] | undefined

The identifiers of one or more IP access control groups.

MaxResults
number | undefined

The maximum number of items to return.

NextToken
string | undefined

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

DescribeIpGroupsCommand Output

See DescribeIpGroupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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

Result
WorkspacesIpGroup[] | undefined

Information about the IP access control groups.

Throws

Name
Fault
Details
AccessDeniedException
client

The user is not authorized to access a resource.

InvalidParameterValuesException
client

One or more parameter values are not valid.

WorkSpacesServiceException
Base exception class for all service exceptions from WorkSpaces service.