@aws-sdk/client-payment-cryptography-data 3.349.0

package/dist-types/commands/VerifyPinDataCommand.d.ts

@@ -0,0 +1,134 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { VerifyPinDataInput, VerifyPinDataOutput } from "../models/models_0";
+import { PaymentCryptographyDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyDataClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link VerifyPinDataCommand}.
+ */
+export interface VerifyPinDataCommandInput extends VerifyPinDataInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link VerifyPinDataCommand}.
+ */
+export interface VerifyPinDataCommandOutput extends VerifyPinDataOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html">Verify PIN data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
+ *          <p>This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an <code>EncryptedPinBlock</code> for transmission from Amazon Web Services Payment Cryptography.  </p>
+ *          <p>For information about valid keys for this operation, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html">Understanding key attributes</a> and <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p>
+ *          <p>
+ *             <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p>
+ *          <p>
+ *             <b>Related operations:</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>GeneratePinData</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>TranslatePinData</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PaymentCryptographyDataClient, VerifyPinDataCommand } from "@aws-sdk/client-payment-cryptography-data"; // ES Modules import
+ * // const { PaymentCryptographyDataClient, VerifyPinDataCommand } = require("@aws-sdk/client-payment-cryptography-data"); // CommonJS import
+ * const client = new PaymentCryptographyDataClient(config);
+ * const input = { // VerifyPinDataInput
+ *   VerificationKeyIdentifier: "STRING_VALUE", // required
+ *   EncryptionKeyIdentifier: "STRING_VALUE", // required
+ *   VerificationAttributes: { // PinVerificationAttributes Union: only one key present
+ *     VisaPin: { // VisaPinVerification
+ *       PinVerificationKeyIndex: Number("int"), // required
+ *       VerificationValue: "STRING_VALUE", // required
+ *     },
+ *     Ibm3624Pin: { // Ibm3624PinVerification
+ *       DecimalizationTable: "STRING_VALUE", // required
+ *       PinValidationDataPadCharacter: "STRING_VALUE", // required
+ *       PinValidationData: "STRING_VALUE", // required
+ *       PinOffset: "STRING_VALUE", // required
+ *     },
+ *   },
+ *   EncryptedPinBlock: "STRING_VALUE", // required
+ *   PrimaryAccountNumber: "STRING_VALUE", // required
+ *   PinBlockFormat: "STRING_VALUE", // required
+ *   PinDataLength: Number("int"),
+ *   DukptAttributes: { // DukptAttributes
+ *     KeySerialNumber: "STRING_VALUE", // required
+ *     DukptDerivationType: "STRING_VALUE", // required
+ *   },
+ * };
+ * const command = new VerifyPinDataCommand(input);
+ * const response = await client.send(command);
+ * // { // VerifyPinDataOutput
+ * //   VerificationKeyArn: "STRING_VALUE", // required
+ * //   VerificationKeyCheckValue: "STRING_VALUE", // required
+ * //   EncryptionKeyArn: "STRING_VALUE", // required
+ * //   EncryptionKeyCheckValue: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param VerifyPinDataCommandInput - {@link VerifyPinDataCommandInput}
+ * @returns {@link VerifyPinDataCommandOutput}
+ * @see {@link VerifyPinDataCommandInput} for command's `input` shape.
+ * @see {@link VerifyPinDataCommandOutput} for command's `response` shape.
+ * @see {@link PaymentCryptographyDataClientResolvedConfig | config} for PaymentCryptographyDataClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied due to an invalid resource error.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied due to an invalid request error.</p>
+ *
+ * @throws {@link VerificationFailedException} (client fault)
+ *  <p>This request failed verification.</p>
+ *
+ * @throws {@link PaymentCryptographyDataServiceException}
+ * <p>Base exception class for all service exceptions from PaymentCryptographyData service.</p>
+ *
+ */
+export declare class VerifyPinDataCommand extends $Command<VerifyPinDataCommandInput, VerifyPinDataCommandOutput, PaymentCryptographyDataClientResolvedConfig> {
+    readonly input: VerifyPinDataCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: VerifyPinDataCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyPinDataCommandInput, VerifyPinDataCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./DecryptDataCommand";
+export * from "./EncryptDataCommand";
+export * from "./GenerateCardValidationDataCommand";
+export * from "./GenerateMacCommand";
+export * from "./GeneratePinDataCommand";
+export * from "./ReEncryptDataCommand";
+export * from "./TranslatePinDataCommand";
+export * from "./VerifyAuthRequestCryptogramCommand";
+export * from "./VerifyCardValidationDataCommand";
+export * from "./VerifyMacCommand";
+export * from "./VerifyPinDataCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,20 @@
+import { EndpointParameters as __EndpointParameters, EndpointV2 } from "@aws-sdk/types";
+import { Endpoint, Provider } from "@smithy/types";
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@aws-sdk/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@aws-sdk/util-endpoints";
+export declare const ruleSet: RuleSetObject;

package/dist-types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * <p>You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.html">Data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
+ *          <p>To manage your encryption keys, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html">Amazon Web Services Payment Cryptography Control Plane</a>. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. </p>
+ *
+ * @packageDocumentation
+ */
+export * from "./PaymentCryptographyDataClient";
+export * from "./PaymentCryptographyData";
+export * from "./commands";
+export * from "./models";
+export { PaymentCryptographyDataServiceException } from "./models/PaymentCryptographyDataServiceException";

package/dist-types/models/PaymentCryptographyDataServiceException.d.ts

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from PaymentCryptographyData service.
+ */
+export declare class PaymentCryptographyDataServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";