- 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.
DeleteACLCommand
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs) .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MemoryDBClient, DeleteACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, DeleteACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // DeleteACLRequest
ACLName: "STRING_VALUE", // required
};
const command = new DeleteACLCommand(input);
const response = await client.send(command);
// { // DeleteACLResponse
// ACL: { // ACL
// Name: "STRING_VALUE",
// Status: "STRING_VALUE",
// UserNames: [ // UserNameList
// "STRING_VALUE",
// ],
// MinimumEngineVersion: "STRING_VALUE",
// PendingChanges: { // ACLPendingChanges
// UserNamesToRemove: [
// "STRING_VALUE",
// ],
// UserNamesToAdd: [
// "STRING_VALUE",
// ],
// },
// Clusters: [ // ACLClusterNameList
// "STRING_VALUE",
// ],
// ARN: "STRING_VALUE",
// },
// };
DeleteACLCommand Input
See DeleteACLCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ACLName Required | string | undefined | The name of the Access Control List to delete. |
DeleteACLCommand Output
See DeleteACLCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ACL | ACL | undefined | The Access Control List object that has been deleted. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ACLNotFoundFault | client | |
InvalidACLStateFault | client | |
InvalidParameterValueException | client | |
MemoryDBServiceException | Base exception class for all service exceptions from MemoryDB service. |