import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListKeysInput, ListKeysOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link ListKeysCommand}. */ export interface ListKeysCommandInput extends ListKeysInput { } /** * @public * * The output of {@link ListKeysCommand}. */ export interface ListKeysCommandOutput extends ListKeysOutput, __MetadataBearer { } declare const ListKeysCommand_base: { new (input: ListKeysCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [ListKeysCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.

This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PaymentCryptographyClient, ListKeysCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import * // const { PaymentCryptographyClient, ListKeysCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import * // import type { PaymentCryptographyClientConfig } from "@aws-sdk/client-payment-cryptography"; * const config = {}; // type is PaymentCryptographyClientConfig * const client = new PaymentCryptographyClient(config); * const input = { // ListKeysInput * KeyState: "STRING_VALUE", * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * }; * const command = new ListKeysCommand(input); * const response = await client.send(command); * // { // ListKeysOutput * // Keys: [ // KeySummaryList // required * // { // KeySummary * // KeyArn: "STRING_VALUE", // required * // KeyState: "STRING_VALUE", // required * // KeyAttributes: { // KeyAttributes * // KeyUsage: "STRING_VALUE", // required * // KeyClass: "STRING_VALUE", // required * // KeyAlgorithm: "STRING_VALUE", // required * // KeyModesOfUse: { // KeyModesOfUse * // Encrypt: true || false, * // Decrypt: true || false, * // Wrap: true || false, * // Unwrap: true || false, * // Generate: true || false, * // Sign: true || false, * // Verify: true || false, * // DeriveKey: true || false, * // NoRestrictions: true || false, * // }, * // }, * // KeyCheckValue: "STRING_VALUE", // required * // Exportable: true || false, // required * // Enabled: true || false, // required * // MultiRegionKeyType: "STRING_VALUE", * // PrimaryRegion: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListKeysCommandInput - {@link ListKeysCommandInput} * @returns {@link ListKeysCommandOutput} * @see {@link ListKeysCommandInput} for command's `input` shape. * @see {@link ListKeysCommandOutput} for command's `response` shape. * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.

* * @throws {@link InternalServerException} (server fault) *

The request processing has failed because of an unknown error, exception, or failure.

This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) *

The request was denied due to resource not found.

The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.

* * @throws {@link ServiceUnavailableException} (server fault) *

The service cannot complete the request.

The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.

* * @throws {@link ValidationException} (client fault) *

The request was denied due to an invalid request error.

One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.

* * @throws {@link PaymentCryptographyServiceException} *

Base exception class for all service exceptions from PaymentCryptography service.

* * * @public */ export declare class ListKeysCommand extends ListKeysCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListKeysInput; output: ListKeysOutput; }; sdk: { input: ListKeysCommandInput; output: ListKeysCommandOutput; }; }; }