- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteIpGroupCommand
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesClient, DeleteIpGroupCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, DeleteIpGroupCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // DeleteIpGroupRequest
GroupId: "STRING_VALUE", // required
};
const command = new DeleteIpGroupCommand(input);
const response = await client.send(command);
// {};
DeleteIpGroupCommand Input
See DeleteIpGroupCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
GroupIdRequired | string | undefined | The identifier of the IP access control group. |
DeleteIpGroupCommand Output
See DeleteIpGroupCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The user is not authorized to access a resource. |
| InvalidParameterValuesException | client | One or more parameter values are not valid. |
| ResourceAssociatedException | client | The resource is associated with a directory. |
| ResourceNotFoundException | client | The resource could not be found. |
| WorkSpacesServiceException | Base exception class for all service exceptions from WorkSpaces service. |