DescribeACLsCommand

Suggest an Edit

Returns a list of ACLs.

Example Syntax

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

import { MemoryDBClient, DescribeACLsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, DescribeACLsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // DescribeACLsRequest
  ACLName: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeACLsCommand(input);
const response = await client.send(command);
// { // DescribeACLsResponse
//   ACLs: [ // ACLList
//     { // 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",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeACLsCommand Input

See DescribeACLsCommandInput for more details

Parameter
Type
Description
ACLName
string | undefined

The name of the ACL.

MaxResults
number | undefined

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

NextToken
string | undefined

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

DescribeACLsCommand Output

See DescribeACLsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ACLs
ACL[] | undefined

The list of ACLs.

NextToken
string | undefined

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Throws

Name
Fault
Details
ACLNotFoundFault
client

InvalidParameterCombinationException
client

MemoryDBServiceException
Base exception class for all service exceptions from MemoryDB service.