Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-payment-cryptography

@aws-sdk/client-payment-cryptography

Description

AWS SDK for JavaScript PaymentCryptography Client for Node.js, Browser and React Native.

You use the Amazon Web Services Payment Cryptography Control Plane to manage the encryption keys you use for payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.

To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations.

All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.

Amazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't conīŦgure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.

Installing

To install the this package, simply type add or install @aws-sdk/client-payment-cryptography using your favorite package manager:

  • npm install @aws-sdk/client-payment-cryptography
  • yarn add @aws-sdk/client-payment-cryptography
  • pnpm add @aws-sdk/client-payment-cryptography

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the PaymentCryptographyClient and the commands you need, for example ListAliasesCommand:

// ES5 example
const { PaymentCryptographyClient, ListAliasesCommand } = require("@aws-sdk/client-payment-cryptography");
// ES6+ example
import { PaymentCryptographyClient, ListAliasesCommand } from "@aws-sdk/client-payment-cryptography";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new PaymentCryptographyClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new ListAliasesCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-payment-cryptography";
const client = new AWS.PaymentCryptography({ region: "REGION" });

// async/await.
try {
const data = await client.listAliases(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listAliases(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listAliases(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-payment-cryptography package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateAlias

Command API Reference / Input / Output

CreateKey

Command API Reference / Input / Output

DeleteAlias

Command API Reference / Input / Output

DeleteKey

Command API Reference / Input / Output

ExportKey

Command API Reference / Input / Output

GetAlias

Command API Reference / Input / Output

GetKey

Command API Reference / Input / Output

GetParametersForExport

Command API Reference / Input / Output

GetParametersForImport

Command API Reference / Input / Output

GetPublicKeyCertificate

Command API Reference / Input / Output

ImportKey

Command API Reference / Input / Output

ListAliases

Command API Reference / Input / Output

ListKeys

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RestoreKey

Command API Reference / Input / Output

StartKeyUsage

Command API Reference / Input / Output

StopKeyUsage

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAlias

Command API Reference / Input / Output