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 configure 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 `CreateAliasCommand`: + +```js +// ES5 example +const { PaymentCryptographyClient, CreateAliasCommand } = require("@aws-sdk/client-payment-cryptography"); +``` + +```ts +// ES6+ example +import { PaymentCryptographyClient, CreateAliasCommand } 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. + +```js +// a client can be shared by different commands. +const client = new PaymentCryptographyClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new CreateAliasCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// 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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// 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](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-payment-cryptography"; +const client = new AWS.PaymentCryptography({ region: "REGION" }); + +// async/await. +try { + const data = await client.createAlias(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .createAlias(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.createAlias(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). + +```js +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. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## 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](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +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 configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
+ */ +export class PaymentCryptography extends PaymentCryptographyClient implements PaymentCryptography {} +createAggregatedClient(commands, PaymentCryptography); diff --git a/clients/client-payment-cryptography/src/PaymentCryptographyClient.ts b/clients/client-payment-cryptography/src/PaymentCryptographyClient.ts new file mode 100644 index 000000000000..d8ba7c22c4cc --- /dev/null +++ b/clients/client-payment-cryptography/src/PaymentCryptographyClient.ts @@ -0,0 +1,355 @@ +// smithy-typescript generated code +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@aws-sdk/config-resolver"; +import { getContentLengthPlugin } from "@aws-sdk/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@aws-sdk/middleware-endpoint"; +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@aws-sdk/smithy-client"; +import { + BodyLengthCalculator as __BodyLengthCalculator, + Checksum as __Checksum, + ChecksumConstructor as __ChecksumConstructor, + Credentials as __Credentials, + EndpointV2 as __EndpointV2, + Hash as __Hash, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@aws-sdk/types"; +import { HttpHandler as __HttpHandler } from "@smithy/protocol-http"; +import { + Decoder as __Decoder, + Encoder as __Encoder, + Provider as __Provider, + StreamCollector as __StreamCollector, +} from "@smithy/types"; + +import { CreateAliasCommandInput, CreateAliasCommandOutput } from "./commands/CreateAliasCommand"; +import { CreateKeyCommandInput, CreateKeyCommandOutput } from "./commands/CreateKeyCommand"; +import { DeleteAliasCommandInput, DeleteAliasCommandOutput } from "./commands/DeleteAliasCommand"; +import { DeleteKeyCommandInput, DeleteKeyCommandOutput } from "./commands/DeleteKeyCommand"; +import { ExportKeyCommandInput, ExportKeyCommandOutput } from "./commands/ExportKeyCommand"; +import { GetAliasCommandInput, GetAliasCommandOutput } from "./commands/GetAliasCommand"; +import { GetKeyCommandInput, GetKeyCommandOutput } from "./commands/GetKeyCommand"; +import { + GetParametersForExportCommandInput, + GetParametersForExportCommandOutput, +} from "./commands/GetParametersForExportCommand"; +import { + GetParametersForImportCommandInput, + GetParametersForImportCommandOutput, +} from "./commands/GetParametersForImportCommand"; +import { + GetPublicKeyCertificateCommandInput, + GetPublicKeyCertificateCommandOutput, +} from "./commands/GetPublicKeyCertificateCommand"; +import { ImportKeyCommandInput, ImportKeyCommandOutput } from "./commands/ImportKeyCommand"; +import { ListAliasesCommandInput, ListAliasesCommandOutput } from "./commands/ListAliasesCommand"; +import { ListKeysCommandInput, ListKeysCommandOutput } from "./commands/ListKeysCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { RestoreKeyCommandInput, RestoreKeyCommandOutput } from "./commands/RestoreKeyCommand"; +import { StartKeyUsageCommandInput, StartKeyUsageCommandOutput } from "./commands/StartKeyUsageCommand"; +import { StopKeyUsageCommandInput, StopKeyUsageCommandOutput } from "./commands/StopKeyUsageCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { UpdateAliasCommandInput, UpdateAliasCommandOutput } from "./commands/UpdateAliasCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateAliasCommandInput + | CreateKeyCommandInput + | DeleteAliasCommandInput + | DeleteKeyCommandInput + | ExportKeyCommandInput + | GetAliasCommandInput + | GetKeyCommandInput + | GetParametersForExportCommandInput + | GetParametersForImportCommandInput + | GetPublicKeyCertificateCommandInput + | ImportKeyCommandInput + | ListAliasesCommandInput + | ListKeysCommandInput + | ListTagsForResourceCommandInput + | RestoreKeyCommandInput + | StartKeyUsageCommandInput + | StopKeyUsageCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateAliasCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateAliasCommandOutput + | CreateKeyCommandOutput + | DeleteAliasCommandOutput + | DeleteKeyCommandOutput + | ExportKeyCommandOutput + | GetAliasCommandOutput + | GetKeyCommandOutput + | GetParametersForExportCommandOutput + | GetParametersForImportCommandOutput + | GetPublicKeyCertificateCommandOutput + | ImportKeyCommandOutput + | ListAliasesCommandOutput + | ListKeysCommandOutput + | ListTagsForResourceCommandOutput + | RestoreKeyCommandOutput + | StartKeyUsageCommandOutput + | StopKeyUsageCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateAliasCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandler; + + /** + * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dyanamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderYou 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 configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
+ */ +export class PaymentCryptographyClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + PaymentCryptographyClientResolvedConfig +> { + /** + * The resolved configuration of PaymentCryptographyClient class. This is resolved and normalized from the {@link PaymentCryptographyClientConfig | constructor configuration interface}. + */ + readonly config: PaymentCryptographyClientResolvedConfig; + + constructor(configuration: PaymentCryptographyClientConfig) { + const _config_0 = __getRuntimeConfig(configuration); + const _config_1 = resolveClientEndpointParameters(_config_0); + const _config_2 = resolveRegionConfig(_config_1); + const _config_3 = resolveEndpointConfig(_config_2); + const _config_4 = resolveRetryConfig(_config_3); + const _config_5 = resolveHostHeaderConfig(_config_4); + const _config_6 = resolveAwsAuthConfig(_config_5); + const _config_7 = resolveUserAgentConfig(_config_6); + super(_config_7); + this.config = _config_7; + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + this.middlewareStack.use(getLoggerPlugin(this.config)); + this.middlewareStack.use(getRecursionDetectionPlugin(this.config)); + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + } + + /** + * Destroy underlying resources, like sockets. It's usually not necessary to do this. + * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. + * Otherwise, sockets might stay open for quite a long time before the server terminates them. + */ + destroy(): void { + super.destroy(); + } +} diff --git a/clients/client-payment-cryptography/src/commands/CreateAliasCommand.ts b/clients/client-payment-cryptography/src/commands/CreateAliasCommand.ts new file mode 100644 index 000000000000..98a20304c8f8 --- /dev/null +++ b/clients/client-payment-cryptography/src/commands/CreateAliasCommand.ts @@ -0,0 +1,201 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, +} from "@aws-sdk/types"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { SerdeContext as __SerdeContext } from "@smithy/types"; + +import { CreateAliasInput, CreateAliasOutput } from "../models/models_0"; +import { + PaymentCryptographyClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../PaymentCryptographyClient"; +import { de_CreateAliasCommand, se_CreateAliasCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateAliasCommand}. + */ +export interface CreateAliasCommandInput extends CreateAliasInput {} +/** + * @public + * + * The output of {@link CreateAliasCommand}. + */ +export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataBearer {} + +/** + * @public + *Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
+ *You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
+ *To change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * DeleteAlias + *
+ *+ * GetAlias + *
+ *+ * ListAliases + *
+ *+ * UpdateAlias + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class CreateAliasCommand extends $Command< + CreateAliasCommandInput, + CreateAliasCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateAliasCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
+ *In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
+ *When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
+ *+ * 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, CreateKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import + * // const { PaymentCryptographyClient, CreateKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import + * const client = new PaymentCryptographyClient(config); + * const input = { // CreateKeyInput + * 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, + * }, + * }, + * KeyCheckValueAlgorithm: "STRING_VALUE", + * Exportable: true || false, // required + * Enabled: true || false, + * Tags: [ // Tags + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", + * }, + * ], + * }; + * const command = new CreateKeyCommand(input); + * const response = await client.send(command); + * // { // CreateKeyOutput + * // Key: { // Key + * // KeyArn: "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 + * // KeyCheckValueAlgorithm: "STRING_VALUE", // required + * // Enabled: true || false, // required + * // Exportable: true || false, // required + * // KeyState: "STRING_VALUE", // required + * // KeyOrigin: "STRING_VALUE", // required + * // CreateTimestamp: new Date("TIMESTAMP"), // required + * // UsageStartTimestamp: new Date("TIMESTAMP"), + * // UsageStopTimestamp: new Date("TIMESTAMP"), + * // DeletePendingTimestamp: new Date("TIMESTAMP"), + * // DeleteTimestamp: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param CreateKeyCommandInput - {@link CreateKeyCommandInput} + * @returns {@link CreateKeyCommandOutput} + * @see {@link CreateKeyCommandInput} for command's `input` shape. + * @see {@link CreateKeyCommandOutput} 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.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class CreateKeyCommand extends $Command< + CreateKeyCommandInput, + CreateKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the alias, but doesn't affect the underlying key.
+ *Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * CreateAlias + *
+ *+ * GetAlias + *
+ *+ * ListAliases + *
+ *+ * UpdateAlias + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class DeleteAliasCommand extends $Command< + DeleteAliasCommandInput, + DeleteAliasCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteAliasCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.
+ *Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set DeleteKeyInDays. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
If you delete key material, you can use ImportKey to reimport the same key material into the Amazon Web Services Payment Cryptography key.
+ *You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * RestoreKey + *
+ *+ * StartKeyUsage + *
+ *+ * StopKeyUsage + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class DeleteKeyCommand extends $Command< + DeleteKeyCommandInput, + DeleteKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
+ *Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
+ *You can use ExportKey to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
+ * TR-34 key export + *
+ *Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.
+ *Set the following parameters:
+ *The KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.
Obtained from KDH by calling GetParametersForExport.
+ *Amazon Web Services Payment Cryptography uses this to wrap the key under export.
+ *When this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block.
+ *+ * TR-31 key export + *
+ *Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * GetParametersForExport + *
+ *+ * ImportKey + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class ExportKeyCommand extends $Command< + ExportKeyCommandInput, + ExportKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExportKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the Amazon Web Services Payment Cryptography key associated with the alias.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * CreateAlias + *
+ *+ * DeleteAlias + *
+ *+ * ListAliases + *
+ *+ * UpdateAlias + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class GetAliasCommand extends $Command< + GetAliasCommandInput, + GetAliasCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetAliasCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
+ *+ * 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, GetKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import + * // const { PaymentCryptographyClient, GetKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import + * const client = new PaymentCryptographyClient(config); + * const input = { // GetKeyInput + * KeyIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetKeyCommand(input); + * const response = await client.send(command); + * // { // GetKeyOutput + * // Key: { // Key + * // KeyArn: "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 + * // KeyCheckValueAlgorithm: "STRING_VALUE", // required + * // Enabled: true || false, // required + * // Exportable: true || false, // required + * // KeyState: "STRING_VALUE", // required + * // KeyOrigin: "STRING_VALUE", // required + * // CreateTimestamp: new Date("TIMESTAMP"), // required + * // UsageStartTimestamp: new Date("TIMESTAMP"), + * // UsageStopTimestamp: new Date("TIMESTAMP"), + * // DeletePendingTimestamp: new Date("TIMESTAMP"), + * // DeleteTimestamp: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param GetKeyCommandInput - {@link GetKeyCommandInput} + * @returns {@link GetKeyCommandOutput} + * @see {@link GetKeyCommandInput} for command's `input` shape. + * @see {@link GetKeyCommandOutput} 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.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class GetKeyCommand extends $Command< + GetKeyCommandInput, + GetKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
+ *The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * ExportKey + *
+ *+ * GetParametersForImport + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class GetParametersForExportCommand extends $Command< + GetParametersForExportCommandInput, + GetParametersForExportCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetParametersForExportCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
+ *The wrapping key certificate wraps the key under import within the TR-34 key payload. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. The same import token can be used to import multiple keys into your service account.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * GetParametersForExport + *
+ *+ * ImportKey + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class GetParametersForImportCommand extends $Command< + GetParametersForImportCommandInput, + GetParametersForImportCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetParametersForImportCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
+ *Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography
+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PaymentCryptographyClient, GetPublicKeyCertificateCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import + * // const { PaymentCryptographyClient, GetPublicKeyCertificateCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import + * const client = new PaymentCryptographyClient(config); + * const input = { // GetPublicKeyCertificateInput + * KeyIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetPublicKeyCertificateCommand(input); + * const response = await client.send(command); + * // { // GetPublicKeyCertificateOutput + * // KeyCertificate: "STRING_VALUE", // required + * // KeyCertificateChain: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetPublicKeyCertificateCommandInput - {@link GetPublicKeyCertificateCommandInput} + * @returns {@link GetPublicKeyCertificateCommandOutput} + * @see {@link GetPublicKeyCertificateCommandInput} for command's `input` shape. + * @see {@link GetPublicKeyCertificateCommandOutput} 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.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class GetPublicKeyCertificateCommand extends $Command< + GetPublicKeyCertificateCommandInput, + GetPublicKeyCertificateCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPublicKeyCertificateCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackImports keys and public key certificates into Amazon Web Services Payment Cryptography.
+ *Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
+ *You can use ImportKey to import main or root keys such as KEK (Key Encryption Key) using asymmetric key exchange technique following the ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys.
After you have imported a main or root key, you can import working keys to perform various cryptographic operations within Amazon Web Services Payment Cryptography using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN.
+ *You can also import a root public key certificate, a self-signed certificate used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
+ *+ * To import a public root key certificate + *
+ *Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
+ *Set the following parameters:
+ *
+ * KeyMaterial: RootCertificatePublicKey
+ *
+ * KeyClass: PUBLIC_KEY
+ *
+ * KeyModesOfUse: Verify
+ *
+ * KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE
+ *
+ * PublicKeyCertificate: The certificate authority used to sign the root public key certificate.
+ * To import a trusted public key certificate + *
+ *The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
+ *
+ * KeyMaterial: TrustedCertificatePublicKey
+ *
+ * CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
+ * KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
+ * PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.
+ * Import main keys + *
+ *Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to import main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). During the key import process, KDH is the user who initiates the key import and KRH is Amazon Web Services Payment Cryptography who receives the key. Before initiating TR-34 key import, you must obtain an import token by calling GetParametersForImport. This operation also returns the wrapping key certificate that KDH uses wrap key under import to generate a TR-34 wrapped key block. The import token expires after 7 days.
+ *Set the following parameters:
+ *
+ * CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.
+ * ImportToken: Obtained from KRH by calling GetParametersForImport.
+ * WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
+ * SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.
TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.
+ *+ * Import working keys + *
+ *Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import. To initiate a TR-31 key import, set the following parameters:
+ *
+ * WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.
+ * WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * ExportKey + *
+ *+ * GetParametersForImport + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class ImportKeyCommand extends $Command< + ImportKeyCommandInput, + ImportKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ImportKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
+ *This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.
+ * Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * CreateAlias + *
+ *+ * DeleteAlias + *
+ *+ * GetAlias + *
+ *+ * UpdateAlias + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class ListAliasesCommand extends $Command< + ListAliasesCommandInput, + ListAliasesCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListAliasesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists 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 + * 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 + * // }, + * // ], + * // 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.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class ListKeysCommand extends $Command< + ListKeysCommandInput, + ListKeysCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListKeysCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the tags for an Amazon Web Services resource.
+ *This is a paginated operation, which means that each response might contain only a subset of all the tags.
+ * When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.
+ * When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * TagResource + *
+ *+ * UntagResource + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.
+ * After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * DeleteKey + *
+ *+ * StartKeyUsage + *
+ *+ * StopKeyUsage + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class RestoreKeyCommand extends $Command< + RestoreKeyCommandInput, + RestoreKeyCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: RestoreKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * StopKeyUsage + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class StartKeyUsageCommand extends $Command< + StartKeyUsageCommandInput, + StartKeyUsageCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartKeyUsageCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
+ *You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * DeleteKey + *
+ *+ * StartKeyUsage + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class StopKeyUsageCommand extends $Command< + StopKeyUsageCommandInput, + StopKeyUsageCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StopKeyUsageCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds or edits tags on an Amazon Web Services Payment Cryptography key.
+ *Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
+ *Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * ListTagsForResource + *
+ *+ * UntagResource + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request would cause a service quota to be exceeded.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a tag from an Amazon Web Services Payment Cryptography key.
+ *Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * ListTagsForResource + *
+ *+ * TagResource + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAssociates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
+ *+ * Cross-account use: This operation can't be used across different Amazon Web Services accounts.
+ *+ * Related operations: + *
+ *+ * CreateAlias + *
+ *+ * DeleteAlias + *
+ *+ * GetAlias + *
+ *+ * ListAliases + *
+ *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This request can cause an inconsistent state for the resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception, or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request was denied due to an invalid resource error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request was denied due to an invalid request error.
+ * + * @throws {@link PaymentCryptographyServiceException} + *Base exception class for all service exceptions from PaymentCryptography service.
+ * + */ +export class UpdateAliasCommand extends $Command< + UpdateAliasCommandInput, + UpdateAliasCommandOutput, + PaymentCryptographyClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateAliasCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackYou 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 configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
+ * + * @packageDocumentation + */ +export * from "./PaymentCryptographyClient"; +export * from "./PaymentCryptography"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { PaymentCryptographyServiceException } from "./models/PaymentCryptographyServiceException"; diff --git a/clients/client-payment-cryptography/src/models/PaymentCryptographyServiceException.ts b/clients/client-payment-cryptography/src/models/PaymentCryptographyServiceException.ts new file mode 100644 index 000000000000..ecf8f1c3efa3 --- /dev/null +++ b/clients/client-payment-cryptography/src/models/PaymentCryptographyServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@aws-sdk/smithy-client"; + +export { __ServiceException, __ServiceExceptionOptions }; + +/** + * @public + * + * Base exception class for all service exceptions from PaymentCryptography service. + */ +export class PaymentCryptographyServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, PaymentCryptographyServiceException.prototype); + } +} diff --git a/clients/client-payment-cryptography/src/models/index.ts b/clients/client-payment-cryptography/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-payment-cryptography/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-payment-cryptography/src/models/models_0.ts b/clients/client-payment-cryptography/src/models/models_0.ts new file mode 100644 index 000000000000..0d9539425e95 --- /dev/null +++ b/clients/client-payment-cryptography/src/models/models_0.ts @@ -0,0 +1,1538 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@aws-sdk/smithy-client"; + +import { PaymentCryptographyServiceException as __BaseException } from "./PaymentCryptographyServiceException"; + +/** + * @public + *You do not have sufficient access to perform this action.
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeContains information about an alias.
+ */ +export interface Alias { + /** + *A friendly name that you can use to refer to a key. The value must begin with alias/.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *The KeyARN of the key associated with the alias.
This request can cause an inconsistent state for the resource.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *The KeyARN of the key to associate with the alias.
The alias for the key.
+ */ + Alias: Alias | undefined; +} + +/** + * @public + *The request processing has failed because of an unknown error, exception, or failure.
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to an invalid resource error.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + *The string for the exception.
+ */ + ResourceId?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis request would cause a service quota to be exceeded.
+ */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe service cannot complete the request.
+ */ +export class ServiceUnavailableException extends __BaseException { + readonly name: "ServiceUnavailableException" = "ServiceUnavailableException"; + readonly $fault: "server" = "server"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to an invalid request error.
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.
+ */ +export interface KeyModesOfUse { + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
+ */ + Encrypt?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
+ */ + Decrypt?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
+ */ + Wrap?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
+ */ + Unwrap?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
+ */ + Generate?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
+ */ + Sign?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
+ */ + Verify?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
+ */ + DeriveKey?: boolean; + + /** + *Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
+ */ +export interface KeyAttributes { + /** + *The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
+ */ + KeyUsage: KeyUsage | string | undefined; + + /** + *The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
+ */ + KeyClass: KeyClass | string | undefined; + + /** + *The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
+ *For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
The list of cryptographic operations that you can perform using the key.
+ */ + KeyModesOfUse: KeyModesOfUse | undefined; +} + +/** + * @public + * @enum + */ +export const KeyCheckValueAlgorithm = { + ANSI_X9_24: "ANSI_X9_24", + CMAC: "CMAC", +} as const; + +/** + * @public + */ +export type KeyCheckValueAlgorithm = (typeof KeyCheckValueAlgorithm)[keyof typeof KeyCheckValueAlgorithm]; + +/** + * @public + *A structure that contains information about a tag.
+ */ +export interface Tag { + /** + *The key of the tag.
+ */ + Key: string | undefined; + + /** + *The value of the tag.
+ */ + Value?: string; +} + +/** + * @public + */ +export interface CreateKeyInput { + /** + *The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
+ */ + KeyAttributes: KeyAttributes | undefined; + + /** + *The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
+ *For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
+ */ + KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | string; + + /** + *Specifies whether the key is exportable from the service.
+ */ + Exportable: boolean | undefined; + + /** + *Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
+ */ + Enabled?: boolean; + + /** + *The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
+ *To use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
+ *Metadata about an Amazon Web Services Payment Cryptography key.
+ */ +export interface Key { + /** + *The Amazon Resource Name (ARN) of the key.
+ */ + KeyArn: string | undefined; + + /** + *The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
+ */ + KeyAttributes: KeyAttributes | undefined; + + /** + *The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
+ */ + KeyCheckValue: string | undefined; + + /** + *The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
+ */ + KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | string | undefined; + + /** + *Specifies whether the key is enabled.
+ */ + Enabled: boolean | undefined; + + /** + *Specifies whether the key is exportable. This data is immutable after the key is created.
+ */ + Exportable: boolean | undefined; + + /** + *The state of key that is being created or deleted.
+ */ + KeyState: KeyState | string | undefined; + + /** + *The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
The date and time when the key was created.
+ */ + CreateTimestamp: Date | undefined; + + /** + *The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
+ */ + UsageStartTimestamp?: Date; + + /** + *The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
+ */ + UsageStopTimestamp?: Date; + + /** + *The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
The key material that contains all the key attributes.
+ */ + Key: Key | undefined; +} + +/** + * @public + */ +export interface DeleteAliasInput { + /** + *A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
The KeyARN of the key that is scheduled for deletion.
The waiting period for key deletion. The default value is seven days.
+ */ + DeleteKeyInDays?: number; +} + +/** + * @public + */ +export interface DeleteKeyOutput { + /** + *The KeyARN of the key that is scheduled for deletion.
Parameter information for key material export using TR-31 standard.
+ */ +export interface ExportTr31KeyBlock { + /** + *The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Parameter information for key material export using TR-34 standard.
+ */ +export interface ExportTr34KeyBlock { + /** + *The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
+ */ + ExportToken: string | undefined; + + /** + *The format of key block that Amazon Web Services Payment Cryptography will use during key export.
+ */ + KeyBlockFormat: Tr34KeyBlockFormat | string | undefined; + + /** + *A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
+ */ + RandomNonce?: string; +} + +/** + * @public + *Parameter information for key material export from Amazon Web Services Payment Cryptography.
+ */ +export type ExportKeyMaterial = + | ExportKeyMaterial.Tr31KeyBlockMember + | ExportKeyMaterial.Tr34KeyBlockMember + | ExportKeyMaterial.$UnknownMember; + +/** + * @public + */ +export namespace ExportKeyMaterial { + /** + *Parameter information for key material export using TR-31 standard.
+ */ + export interface Tr31KeyBlockMember { + Tr31KeyBlock: ExportTr31KeyBlock; + Tr34KeyBlock?: never; + $unknown?: never; + } + + /** + *Parameter information for key material export using TR-34 standard.
+ */ + export interface Tr34KeyBlockMember { + Tr31KeyBlock?: never; + Tr34KeyBlock: ExportTr34KeyBlock; + $unknown?: never; + } + + export interface $UnknownMember { + Tr31KeyBlock?: never; + Tr34KeyBlock?: never; + $unknown: [string, any]; + } + + export interface VisitorThe key block format type, for example, TR-34 or TR-31, to use during key material export.
+ */ + KeyMaterial: ExportKeyMaterial | undefined; + + /** + *The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
+ */ +export interface WrappedKey { + /** + *The KeyARN of the wrapped key.
The key block format of a wrapped key.
+ */ + WrappedKeyMaterialFormat: WrappedKeyMaterialFormat | string | undefined; + + /** + *Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
+ */ + KeyMaterial: string | undefined; +} + +/** + * @public + */ +export interface ExportKeyOutput { + /** + *The key material under export as a TR-34 or TR-31 wrapped key block.
+ */ + WrappedKey?: WrappedKey; +} + +/** + * @public + */ +export interface GetAliasInput { + /** + *The alias of the Amazon Web Services Payment Cryptography key.
+ */ + AliasName: string | undefined; +} + +/** + * @public + */ +export interface GetAliasOutput { + /** + *The alias of the Amazon Web Services Payment Cryptography key.
+ */ + Alias: Alias | undefined; +} + +/** + * @public + */ +export interface GetKeyInput { + /** + *The KeyARN of the Amazon Web Services Payment Cryptography key.
The key material, including the immutable and mutable data for the key.
+ */ + Key: Key | undefined; +} + +/** + * @public + * @enum + */ +export const KeyMaterialType = { + ROOT_PUBLIC_KEY_CERTIFICATE: "ROOT_PUBLIC_KEY_CERTIFICATE", + TR31_KEY_BLOCK: "TR31_KEY_BLOCK", + TR34_KEY_BLOCK: "TR34_KEY_BLOCK", + TRUSTED_PUBLIC_KEY_CERTIFICATE: "TRUSTED_PUBLIC_KEY_CERTIFICATE", +} as const; + +/** + * @public + */ +export type KeyMaterialType = (typeof KeyMaterialType)[keyof typeof KeyMaterialType]; + +/** + * @public + */ +export interface GetParametersForExportInput { + /** + *The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. RSA_2048 is the only signing key algorithm allowed.
The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days.
+ */ + SigningKeyCertificate: string | undefined; + + /** + *The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.
+ */ + SigningKeyCertificateChain: string | undefined; + + /** + *The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
+ */ + ExportToken: string | undefined; + + /** + *The validity period of the export token.
+ */ + ParametersValidUntilTimestamp: Date | undefined; +} + +/** + * @public + */ +export interface GetParametersForImportInput { + /** + *The key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import TR34_KEY_BLOCK. Import token is not required for TR-31 key import.
The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. RSA_2048 is the only wrapping key algorithm allowed.
The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
+ */ + WrappingKeyCertificate: string | undefined; + + /** + *The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account.
+ */ + WrappingKeyCertificateChain: string | undefined; + + /** + *The algorithm of the wrapping key for use within TR-34 key block. RSA_2048 is the only wrapping key algorithm allowed.
The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
+ */ + ImportToken: string | undefined; + + /** + *The validity period of the import token.
+ */ + ParametersValidUntilTimestamp: Date | undefined; +} + +/** + * @public + */ +export interface GetPublicKeyCertificateInput { + /** + *The KeyARN of the asymmetric key pair.
The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days.
+ */ + KeyCertificate: string | undefined; + + /** + *The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account.
+ */ + KeyCertificateChain: string | undefined; +} + +/** + * @public + *Parameter information for root public key certificate import.
+ */ +export interface RootCertificatePublicKey { + /** + *The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.
+ */ + KeyAttributes: KeyAttributes | undefined; + + /** + *Parameter information for root public key certificate import.
+ */ + PublicKeyCertificate: string | undefined; +} + +/** + * @public + *Parameter information for key material import using TR-31 standard.
+ */ +export interface ImportTr31KeyBlock { + /** + *The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
The TR-34 wrapped key block to import.
+ */ + WrappedKeyBlock: string | undefined; +} + +/** + * @public + *Parameter information for key material import using TR-34 standard.
+ */ +export interface ImportTr34KeyBlock { + /** + *The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.
+ */ + SigningKeyCertificate: string | undefined; + + /** + *The import token that initiates key import into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
+ */ + ImportToken: string | undefined; + + /** + *The TR-34 wrapped key block to import.
+ */ + WrappedKeyBlock: string | undefined; + + /** + *The key block format to use during key import. The only value allowed is X9_TR34_2012.
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
+ */ + RandomNonce?: string; +} + +/** + * @public + *Parameter information for trusted public key certificate import.
+ */ +export interface TrustedCertificatePublicKey { + /** + *The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.
+ */ + KeyAttributes: KeyAttributes | undefined; + + /** + *Parameter information for trusted public key certificate import.
+ */ + PublicKeyCertificate: string | undefined; + + /** + *The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
Parameter information for key material import.
+ */ +export type ImportKeyMaterial = + | ImportKeyMaterial.RootCertificatePublicKeyMember + | ImportKeyMaterial.Tr31KeyBlockMember + | ImportKeyMaterial.Tr34KeyBlockMember + | ImportKeyMaterial.TrustedCertificatePublicKeyMember + | ImportKeyMaterial.$UnknownMember; + +/** + * @public + */ +export namespace ImportKeyMaterial { + /** + *Parameter information for root public key certificate import.
+ */ + export interface RootCertificatePublicKeyMember { + RootCertificatePublicKey: RootCertificatePublicKey; + TrustedCertificatePublicKey?: never; + Tr31KeyBlock?: never; + Tr34KeyBlock?: never; + $unknown?: never; + } + + /** + *Parameter information for trusted public key certificate import.
+ */ + export interface TrustedCertificatePublicKeyMember { + RootCertificatePublicKey?: never; + TrustedCertificatePublicKey: TrustedCertificatePublicKey; + Tr31KeyBlock?: never; + Tr34KeyBlock?: never; + $unknown?: never; + } + + /** + *Parameter information for key material import using TR-31 standard.
+ */ + export interface Tr31KeyBlockMember { + RootCertificatePublicKey?: never; + TrustedCertificatePublicKey?: never; + Tr31KeyBlock: ImportTr31KeyBlock; + Tr34KeyBlock?: never; + $unknown?: never; + } + + /** + *Parameter information for key material import using TR-34 standard.
+ */ + export interface Tr34KeyBlockMember { + RootCertificatePublicKey?: never; + TrustedCertificatePublicKey?: never; + Tr31KeyBlock?: never; + Tr34KeyBlock: ImportTr34KeyBlock; + $unknown?: never; + } + + export interface $UnknownMember { + RootCertificatePublicKey?: never; + TrustedCertificatePublicKey?: never; + Tr31KeyBlock?: never; + Tr34KeyBlock?: never; + $unknown: [string, any]; + } + + export interface VisitorThe key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
+ */ + KeyMaterial: ImportKeyMaterial | undefined; + + /** + *The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
+ *For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
+ */ + KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | string; + + /** + *Specifies whether import key is enabled.
+ */ + Enabled?: boolean; + + /** + *The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
+ *You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
+ *To use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
+ *The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
Metadata about an Amazon Web Services Payment Cryptography key.
+ */ +export interface KeySummary { + /** + *The Amazon Resource Name (ARN) of the key.
+ */ + KeyArn: string | undefined; + + /** + *The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
+ */ + KeyState: KeyState | string | undefined; + + /** + *The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
+ */ + KeyAttributes: KeyAttributes | undefined; + + /** + *The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
+ */ + KeyCheckValue: string | undefined; + + /** + *Specifies whether the key is exportable. This data is immutable after the key is created.
+ */ + Exportable: boolean | undefined; + + /** + *Specifies whether the key is enabled.
+ */ + Enabled: boolean | undefined; +} + +/** + * @public + */ +export interface ListAliasesInput { + /** + *Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
+ *This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
+ */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListAliasesOutput { + /** + *The list of aliases. Each alias describes the KeyArn contained within.
The token for the next set of results, or an empty or null value if there are no more results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListKeysInput { + /** + *The key state of the keys you want to list.
+ */ + KeyState?: KeyState | string; + + /** + *Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
+ */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListKeysOutput { + /** + *The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
+ */ + Keys: KeySummary[] | undefined; + + /** + *The token for the next set of results, or an empty or null value if there are no more results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceInput { + /** + *The KeyARN of the key whose tags you are getting.
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
+ */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListTagsForResourceOutput { + /** + *The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
The token for the next set of results, or an empty or null value if there are no more results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface RestoreKeyInput { + /** + *The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
The KeyArn of the key.
The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
The KeyArn of the key.
The KeyARN of the key.
The KeyARN of the key whose tags are being updated.
One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
+ *Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *To use this parameter, you must have TagResource permission in an IAM policy.
+ *Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
+ *The KeyARN of the key whose tags are being removed.
One or more tag keys. Don't include the tag values.
+ *If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
+ */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceOutput {} + +/** + * @public + */ +export interface UpdateAliasInput { + /** + *The alias whose associated key is changing.
+ */ + AliasName: string | undefined; + + /** + *The KeyARN for the key that you are updating or removing from the alias.
The alias name.
+ */ + Alias: Alias | undefined; +} + +/** + * @internal + */ +export const ExportTr34KeyBlockFilterSensitiveLog = (obj: ExportTr34KeyBlock): any => ({ + ...obj, + ...(obj.WrappingKeyCertificate && { WrappingKeyCertificate: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ExportKeyMaterialFilterSensitiveLog = (obj: ExportKeyMaterial): any => { + if (obj.Tr31KeyBlock !== undefined) return { Tr31KeyBlock: obj.Tr31KeyBlock }; + if (obj.Tr34KeyBlock !== undefined) return { Tr34KeyBlock: ExportTr34KeyBlockFilterSensitiveLog(obj.Tr34KeyBlock) }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const ExportKeyInputFilterSensitiveLog = (obj: ExportKeyInput): any => ({ + ...obj, + ...(obj.KeyMaterial && { KeyMaterial: ExportKeyMaterialFilterSensitiveLog(obj.KeyMaterial) }), +}); + +/** + * @internal + */ +export const WrappedKeyFilterSensitiveLog = (obj: WrappedKey): any => ({ + ...obj, + ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ExportKeyOutputFilterSensitiveLog = (obj: ExportKeyOutput): any => ({ + ...obj, + ...(obj.WrappedKey && { WrappedKey: WrappedKeyFilterSensitiveLog(obj.WrappedKey) }), +}); + +/** + * @internal + */ +export const GetParametersForExportOutputFilterSensitiveLog = (obj: GetParametersForExportOutput): any => ({ + ...obj, + ...(obj.SigningKeyCertificate && { SigningKeyCertificate: SENSITIVE_STRING }), + ...(obj.SigningKeyCertificateChain && { SigningKeyCertificateChain: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetParametersForImportOutputFilterSensitiveLog = (obj: GetParametersForImportOutput): any => ({ + ...obj, + ...(obj.WrappingKeyCertificate && { WrappingKeyCertificate: SENSITIVE_STRING }), + ...(obj.WrappingKeyCertificateChain && { WrappingKeyCertificateChain: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetPublicKeyCertificateOutputFilterSensitiveLog = (obj: GetPublicKeyCertificateOutput): any => ({ + ...obj, + ...(obj.KeyCertificate && { KeyCertificate: SENSITIVE_STRING }), + ...(obj.KeyCertificateChain && { KeyCertificateChain: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const RootCertificatePublicKeyFilterSensitiveLog = (obj: RootCertificatePublicKey): any => ({ + ...obj, + ...(obj.PublicKeyCertificate && { PublicKeyCertificate: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ImportTr34KeyBlockFilterSensitiveLog = (obj: ImportTr34KeyBlock): any => ({ + ...obj, + ...(obj.SigningKeyCertificate && { SigningKeyCertificate: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const TrustedCertificatePublicKeyFilterSensitiveLog = (obj: TrustedCertificatePublicKey): any => ({ + ...obj, + ...(obj.PublicKeyCertificate && { PublicKeyCertificate: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ImportKeyMaterialFilterSensitiveLog = (obj: ImportKeyMaterial): any => { + if (obj.RootCertificatePublicKey !== undefined) + return { RootCertificatePublicKey: RootCertificatePublicKeyFilterSensitiveLog(obj.RootCertificatePublicKey) }; + if (obj.TrustedCertificatePublicKey !== undefined) + return { + TrustedCertificatePublicKey: TrustedCertificatePublicKeyFilterSensitiveLog(obj.TrustedCertificatePublicKey), + }; + if (obj.Tr31KeyBlock !== undefined) return { Tr31KeyBlock: obj.Tr31KeyBlock }; + if (obj.Tr34KeyBlock !== undefined) return { Tr34KeyBlock: ImportTr34KeyBlockFilterSensitiveLog(obj.Tr34KeyBlock) }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const ImportKeyInputFilterSensitiveLog = (obj: ImportKeyInput): any => ({ + ...obj, + ...(obj.KeyMaterial && { KeyMaterial: ImportKeyMaterialFilterSensitiveLog(obj.KeyMaterial) }), +}); diff --git a/clients/client-payment-cryptography/src/pagination/Interfaces.ts b/clients/client-payment-cryptography/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..2f981c3905b3 --- /dev/null +++ b/clients/client-payment-cryptography/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@aws-sdk/types"; + +import { PaymentCryptographyClient } from "../PaymentCryptographyClient"; + +/** + * @public + */ +export interface PaymentCryptographyPaginationConfiguration extends PaginationConfiguration { + client: PaymentCryptographyClient; +} diff --git a/clients/client-payment-cryptography/src/pagination/ListAliasesPaginator.ts b/clients/client-payment-cryptography/src/pagination/ListAliasesPaginator.ts new file mode 100644 index 000000000000..724450b806b9 --- /dev/null +++ b/clients/client-payment-cryptography/src/pagination/ListAliasesPaginator.ts @@ -0,0 +1,46 @@ +// smithy-typescript generated code +import { Paginator } from "@aws-sdk/types"; + +import { ListAliasesCommand, ListAliasesCommandInput, ListAliasesCommandOutput } from "../commands/ListAliasesCommand"; +import { PaymentCryptographyClient } from "../PaymentCryptographyClient"; +import { PaymentCryptographyPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: PaymentCryptographyClient, + input: ListAliasesCommandInput, + ...args: any +): PromiseYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.paymentcryptography#Alias": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.paymentcryptography#AliasName", + "traits": { + "smithy.api#documentation": "A friendly name that you can use to refer to a key. The value must begin with alias/.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe KeyARN of the key associated with the alias.
Contains information about an alias.
" + } + }, + "com.amazonaws.paymentcryptography#AliasName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 256 + }, + "smithy.api#pattern": "^alias/[a-zA-Z0-9/_-]+$" + } + }, + "com.amazonaws.paymentcryptography#Aliases": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#Alias" + } + }, + "com.amazonaws.paymentcryptography#CertificateType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + }, + "smithy.api#pattern": "^[^\\[;\\]<>]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptography#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This request can cause an inconsistent state for the resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.paymentcryptography#CreateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#CreateAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#CreateAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nA friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe KeyARN of the key to associate with the alias.
The alias for the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#CreateKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#CreateKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#CreateKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " + } + }, + "com.amazonaws.paymentcryptography#CreateKeyInput": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
\nFor DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
" + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable from the service.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
" + } + }, + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nTo use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nThe key material that contains all the key attributes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#DeleteAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#DeleteAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#DeleteAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nA friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set DeleteKeyInDays. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
If you delete key material, you can use ImportKey to reimport the same key material into the Amazon Web Services Payment Cryptography key.
\nYou should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nThe KeyARN of the key that is scheduled for deletion.
The waiting period for key deletion. The default value is seven days.
", + "smithy.api#range": { + "min": 3, + "max": 180 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#DeleteKeyOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "smithy.api#documentation": "The KeyARN of the key that is scheduled for deletion.
Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
\nAmazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
\nYou can use ExportKey to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
\n TR-34 key export\n
\nAmazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.
\nSet the following parameters:
\nThe KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.
Obtained from KDH by calling GetParametersForExport.
\nAmazon Web Services Payment Cryptography uses this to wrap the key under export.
\nWhen this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block.
\n\n TR-31 key export\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe key block format type, for example, TR-34 or TR-31, to use during key material export.
", + "smithy.api#required": {} + } + }, + "ExportKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
Parameter information for key material export using TR-31 standard.
" + } + }, + "Tr34KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ExportTr34KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material export using TR-34 standard.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material export from Amazon Web Services Payment Cryptography.
" + } + }, + "com.amazonaws.paymentcryptography#ExportKeyOutput": { + "type": "structure", + "members": { + "WrappedKey": { + "target": "com.amazonaws.paymentcryptography#WrappedKey", + "traits": { + "smithy.api#documentation": "The key material under export as a TR-34 or TR-31 wrapped key block.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ExportTokenId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^export-token-[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#ExportTr31KeyBlock": { + "type": "structure", + "members": { + "WrappingKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Parameter information for key material export using TR-31 standard.
" + } + }, + "com.amazonaws.paymentcryptography#ExportTr34KeyBlock": { + "type": "structure", + "members": { + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#required": {} + } + }, + "KeyBlockFormat": { + "target": "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat", + "traits": { + "smithy.api#documentation": "The format of key block that Amazon Web Services Payment Cryptography will use during key export.
", + "smithy.api#required": {} + } + }, + "RandomNonce": { + "target": "com.amazonaws.paymentcryptography#HexLength16", + "traits": { + "smithy.api#documentation": "A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material export using TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#GetAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nThe alias of the Amazon Web Services Payment Cryptography key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#GetAliasOutput": { + "type": "structure", + "members": { + "Alias": { + "target": "com.amazonaws.paymentcryptography#Alias", + "traits": { + "smithy.api#documentation": "The alias of the Amazon Web Services Payment Cryptography key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#GetKeyInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the Amazon Web Services Payment Cryptography key.
The key material, including the immutable and mutable data for the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetParametersForExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetParametersForExportInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetParametersForExportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nThe key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. RSA_2048 is the only signing key algorithm allowed.
The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days.
", + "smithy.api#required": {} + } + }, + "SigningKeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + }, + "SigningKeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#required": {} + } + }, + "ParametersValidUntilTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The validity period of the export token.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetParametersForImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetParametersForImportInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetParametersForImportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import within the TR-34 key payload. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. The same import token can be used to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import TR34_KEY_BLOCK. Import token is not required for TR-31 key import.
The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. RSA_2048 is the only wrapping key algorithm allowed.
The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
", + "smithy.api#required": {} + } + }, + "WrappingKeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + }, + "WrappingKeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm of the wrapping key for use within TR-34 key block. RSA_2048 is the only wrapping key algorithm allowed.
The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
", + "smithy.api#required": {} + } + }, + "ParametersValidUntilTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The validity period of the import token.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetPublicKeyCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificateInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
\nUnlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#GetPublicKeyCertificateInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the asymmetric key pair.
The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days.
", + "smithy.api#required": {} + } + }, + "KeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#HexLength16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-F]+$" + } + }, + "com.amazonaws.paymentcryptography#ImportKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ImportKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ImportKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Imports keys and public key certificates into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
\nYou can use ImportKey to import main or root keys such as KEK (Key Encryption Key) using asymmetric key exchange technique following the ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys.
After you have imported a main or root key, you can import working keys to perform various cryptographic operations within Amazon Web Services Payment Cryptography using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN.
\nYou can also import a root public key certificate, a self-signed certificate used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The certificate authority used to sign the root public key certificate.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.
\n Import main keys\n
\nAmazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to import main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). During the key import process, KDH is the user who initiates the key import and KRH is Amazon Web Services Payment Cryptography who receives the key. Before initiating TR-34 key import, you must obtain an import token by calling GetParametersForImport. This operation also returns the wrapping key certificate that KDH uses wrap key under import to generate a TR-34 wrapped key block. The import token expires after 7 days.
\nSet the following parameters:
\n\n CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.
\n ImportToken: Obtained from KRH by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.
TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.
\n\n Import working keys\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import. To initiate a TR-31 key import, set the following parameters:
\n\n WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nThe key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
\nFor DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
" + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether import key is enabled.
" + } + }, + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nYou can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nTo use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nParameter information for root public key certificate import.
" + } + }, + "TrustedCertificatePublicKey": { + "target": "com.amazonaws.paymentcryptography#TrustedCertificatePublicKey", + "traits": { + "smithy.api#documentation": "Parameter information for trusted public key certificate import.
" + } + }, + "Tr31KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ImportTr31KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-31 standard.
" + } + }, + "Tr34KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ImportTr34KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-34 standard.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import.
" + } + }, + "com.amazonaws.paymentcryptography#ImportKeyOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "smithy.api#documentation": "The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
The TR-34 wrapped key block to import.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-31 standard.
" + } + }, + "com.amazonaws.paymentcryptography#ImportTr34KeyBlock": { + "type": "structure", + "members": { + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.
", + "smithy.api#required": {} + } + }, + "ImportToken": { + "target": "com.amazonaws.paymentcryptography#ImportTokenId", + "traits": { + "smithy.api#documentation": "The import token that initiates key import into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
", + "smithy.api#required": {} + } + }, + "WrappedKeyBlock": { + "target": "com.amazonaws.paymentcryptography#Tr34WrappedKeyBlock", + "traits": { + "smithy.api#documentation": "The TR-34 wrapped key block to import.
", + "smithy.api#required": {} + } + }, + "KeyBlockFormat": { + "target": "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat", + "traits": { + "smithy.api#documentation": "The key block format to use during key import. The only value allowed is X9_TR34_2012.
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.paymentcryptography#Key": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key.
", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValue": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValue", + "traits": { + "smithy.api#documentation": "The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is enabled.
", + "smithy.api#required": {} + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The state of key that is being created or deleted.
", + "smithy.api#required": {} + } + }, + "KeyOrigin": { + "target": "com.amazonaws.paymentcryptography#KeyOrigin", + "traits": { + "smithy.api#documentation": "The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
The date and time when the key was created.
", + "smithy.api#required": {} + } + }, + "UsageStartTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
" + } + }, + "UsageStopTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
" + } + }, + "DeletePendingTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
Metadata about an Amazon Web Services Payment Cryptography key.
" + } + }, + "com.amazonaws.paymentcryptography#KeyAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TDES_2KEY", + "name": "TDES_2KEY" + }, + { + "value": "TDES_3KEY", + "name": "TDES_3KEY" + }, + { + "value": "AES_128", + "name": "AES_128" + }, + { + "value": "AES_192", + "name": "AES_192" + }, + { + "value": "AES_256", + "name": "AES_256" + }, + { + "value": "RSA_2048", + "name": "RSA_2048" + }, + { + "value": "RSA_3072", + "name": "RSA_3072" + }, + { + "value": "RSA_4096", + "name": "RSA_4096" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 150 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 322 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$" + } + }, + "com.amazonaws.paymentcryptography#KeyAttributes": { + "type": "structure", + "members": { + "KeyUsage": { + "target": "com.amazonaws.paymentcryptography#KeyUsage", + "traits": { + "smithy.api#documentation": "The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
", + "smithy.api#required": {} + } + }, + "KeyClass": { + "target": "com.amazonaws.paymentcryptography#KeyClass", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
", + "smithy.api#required": {} + } + }, + "KeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
\nFor symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
The list of cryptographic operations that you can perform using the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
" + } + }, + "com.amazonaws.paymentcryptography#KeyCheckValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CMAC", + "name": "CMAC" + }, + { + "value": "ANSI_X9_24", + "name": "ANSI_X9_24" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYMMETRIC_KEY", + "name": "SYMMETRIC_KEY" + }, + { + "value": "ASYMMETRIC_KEY_PAIR", + "name": "ASYMMETRIC_KEY_PAIR" + }, + { + "value": "PRIVATE_KEY", + "name": "PRIVATE_KEY" + }, + { + "value": "PUBLIC_KEY", + "name": "PUBLIC_KEY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyMaterial": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 48, + "max": 16384 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptography#KeyMaterialType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TR34_KEY_BLOCK", + "name": "TR34_KEY_BLOCK" + }, + { + "value": "TR31_KEY_BLOCK", + "name": "TR31_KEY_BLOCK" + }, + { + "value": "ROOT_PUBLIC_KEY_CERTIFICATE", + "name": "ROOT_PUBLIC_KEY_CERTIFICATE" + }, + { + "value": "TRUSTED_PUBLIC_KEY_CERTIFICATE", + "name": "TRUSTED_PUBLIC_KEY_CERTIFICATE" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyModesOfUse": { + "type": "structure", + "members": { + "Encrypt": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
" + } + }, + "Decrypt": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
" + } + }, + "Wrap": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
" + } + }, + "Unwrap": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
" + } + }, + "Generate": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
" + } + }, + "Sign": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
" + } + }, + "Verify": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
" + } + }, + "DeriveKey": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
" + } + }, + "NoRestrictions": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.
" + } + }, + "com.amazonaws.paymentcryptography#KeyOrigin": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the source of a key", + "smithy.api#enum": [ + { + "value": "EXTERNAL", + "name": "EXTERNAL" + }, + { + "value": "AWS_PAYMENT_CRYPTOGRAPHY", + "name": "AWS_PAYMENT_CRYPTOGRAPHY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyState": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the state of a key", + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_COMPLETE", + "name": "CREATE_COMPLETE" + }, + { + "value": "DELETE_PENDING", + "name": "DELETE_PENDING" + }, + { + "value": "DELETE_COMPLETE", + "name": "DELETE_COMPLETE" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeySummary": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key.
", + "smithy.api#required": {} + } + }, + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValue": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValue", + "traits": { + "smithy.api#documentation": "The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about an Amazon Web Services Payment Cryptography key.
" + } + }, + "com.amazonaws.paymentcryptography#KeySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#KeySummary" + } + }, + "com.amazonaws.paymentcryptography#KeyUsage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TR31_B0_BASE_DERIVATION_KEY", + "name": "TR31_B0_BASE_DERIVATION_KEY" + }, + { + "value": "TR31_C0_CARD_VERIFICATION_KEY", + "name": "TR31_C0_CARD_VERIFICATION_KEY" + }, + { + "value": "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", + "name": "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" + }, + { + "value": "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", + "name": "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" + }, + { + "value": "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", + "name": "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" + }, + { + "value": "TR31_E1_EMV_MKEY_CONFIDENTIALITY", + "name": "TR31_E1_EMV_MKEY_CONFIDENTIALITY" + }, + { + "value": "TR31_E2_EMV_MKEY_INTEGRITY", + "name": "TR31_E2_EMV_MKEY_INTEGRITY" + }, + { + "value": "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", + "name": "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" + }, + { + "value": "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", + "name": "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" + }, + { + "value": "TR31_E6_EMV_MKEY_OTHER", + "name": "TR31_E6_EMV_MKEY_OTHER" + }, + { + "value": "TR31_K0_KEY_ENCRYPTION_KEY", + "name": "TR31_K0_KEY_ENCRYPTION_KEY" + }, + { + "value": "TR31_K1_KEY_BLOCK_PROTECTION_KEY", + "name": "TR31_K1_KEY_BLOCK_PROTECTION_KEY" + }, + { + "value": "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", + "name": "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" + }, + { + "value": "TR31_M3_ISO_9797_3_MAC_KEY", + "name": "TR31_M3_ISO_9797_3_MAC_KEY" + }, + { + "value": "TR31_M6_ISO_9797_5_CMAC_KEY", + "name": "TR31_M6_ISO_9797_5_CMAC_KEY" + }, + { + "value": "TR31_M7_HMAC_KEY", + "name": "TR31_M7_HMAC_KEY" + }, + { + "value": "TR31_P0_PIN_ENCRYPTION_KEY", + "name": "TR31_P0_PIN_ENCRYPTION_KEY" + }, + { + "value": "TR31_P1_PIN_GENERATION_KEY", + "name": "TR31_P1_PIN_GENERATION_KEY" + }, + { + "value": "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", + "name": "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" + }, + { + "value": "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", + "name": "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" + }, + { + "value": "TR31_V2_VISA_PIN_VERIFICATION_KEY", + "name": "TR31_V2_VISA_PIN_VERIFICATION_KEY" + }, + { + "value": "TR31_K2_TR34_ASYMMETRIC_KEY", + "name": "TR31_K2_TR34_ASYMMETRIC_KEY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListAliasesInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListAliasesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nUse this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
\nThis value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListAliasesOutput": { + "type": "structure", + "members": { + "Aliases": { + "target": "com.amazonaws.paymentcryptography#Aliases", + "traits": { + "smithy.api#documentation": "The list of aliases. Each alias describes the KeyArn contained within.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListKeysInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListKeysOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n 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.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Keys" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeysInput": { + "type": "structure", + "members": { + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The key state of the keys you want to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.paymentcryptography#NextToken", + "traits": { + "smithy.api#documentation": "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeysOutput": { + "type": "structure", + "members": { + "Keys": { + "target": "com.amazonaws.paymentcryptography#KeySummaryList", + "traits": { + "smithy.api#documentation": "The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.paymentcryptography#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nThe KeyARN of the key whose tags you are getting.
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.paymentcryptography#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.paymentcryptography#PaymentCryptographyControlPlane": { + "type": "service", + "version": "2021-09-14", + "operations": [ + { + "target": "com.amazonaws.paymentcryptography#CreateAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#CreateKey" + }, + { + "target": "com.amazonaws.paymentcryptography#DeleteAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#DeleteKey" + }, + { + "target": "com.amazonaws.paymentcryptography#ExportKey" + }, + { + "target": "com.amazonaws.paymentcryptography#GetAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#GetKey" + }, + { + "target": "com.amazonaws.paymentcryptography#GetParametersForExport" + }, + { + "target": "com.amazonaws.paymentcryptography#GetParametersForImport" + }, + { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificate" + }, + { + "target": "com.amazonaws.paymentcryptography#ImportKey" + }, + { + "target": "com.amazonaws.paymentcryptography#ListAliases" + }, + { + "target": "com.amazonaws.paymentcryptography#ListKeys" + }, + { + "target": "com.amazonaws.paymentcryptography#ListTagsForResource" + }, + { + "target": "com.amazonaws.paymentcryptography#RestoreKey" + }, + { + "target": "com.amazonaws.paymentcryptography#StartKeyUsage" + }, + { + "target": "com.amazonaws.paymentcryptography#StopKeyUsage" + }, + { + "target": "com.amazonaws.paymentcryptography#TagResource" + }, + { + "target": "com.amazonaws.paymentcryptography#UntagResource" + }, + { + "target": "com.amazonaws.paymentcryptography#UpdateAlias" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Payment Cryptography", + "arnNamespace": "payment-cryptography", + "endpointPrefix": "controlplane.payment-cryptography" + }, + "aws.auth#sigv4": { + "name": "payment-cryptography" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "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.\n
\nTo 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.
\nAll 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.
\nAmazon 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 configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
", + "smithy.api#title": "Payment Cryptography Control Plane", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.paymentcryptography#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 150 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#ResourceNotFoundException": { + "type": "structure", + "members": { + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The string for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid resource error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.paymentcryptography#RestoreKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#RestoreKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#RestoreKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nThe KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.
", + "smithy.api#required": {} + } + }, + "PublicKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Parameter information for root public key certificate import.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for root public key certificate import.
" + } + }, + "com.amazonaws.paymentcryptography#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This request would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.paymentcryptography#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The service cannot complete the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.paymentcryptography#StartKeyUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#StartKeyUsageInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#StartKeyUsageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nThe KeyArn of the key.
The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nThe KeyArn of the key.
The KeyARN of the key.
The key of the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.paymentcryptography#TagValue", + "traits": { + "smithy.api#documentation": "The value of the tag.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about a tag.
" + } + }, + "com.amazonaws.paymentcryptography#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.paymentcryptography#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.paymentcryptography#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Adds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nThe KeyARN of the key whose tags are being updated.
One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.paymentcryptography#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.paymentcryptography#Tr31WrappedKeyBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 56, + "max": 9984 + }, + "smithy.api#pattern": "^[0-9A-Z]+$" + } + }, + "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "X9_TR34_2012", + "name": "X9_TR34_2012" + } + ] + } + }, + "com.amazonaws.paymentcryptography#Tr34WrappedKeyBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4096 + }, + "smithy.api#pattern": "^[0-9A-F]+$" + } + }, + "com.amazonaws.paymentcryptography#TrustedCertificatePublicKey": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.
", + "smithy.api#required": {} + } + }, + "PublicKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Parameter information for trusted public key certificate import.
", + "smithy.api#required": {} + } + }, + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
Parameter information for trusted public key certificate import.
" + } + }, + "com.amazonaws.paymentcryptography#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nThe KeyARN of the key whose tags are being removed.
One or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#UpdateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#UpdateAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#UpdateAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nThe alias whose associated key is changing.
", + "smithy.api#required": {} + } + }, + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The KeyARN for the key that you are updating or removing from the alias.
The alias name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.paymentcryptography#WrappedKey": { + "type": "structure", + "members": { + "WrappingKeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The KeyARN of the wrapped key.
The key block format of a wrapped key.
", + "smithy.api#required": {} + } + }, + "KeyMaterial": { + "target": "com.amazonaws.paymentcryptography#KeyMaterial", + "traits": { + "smithy.api#documentation": "Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#WrappedKeyMaterialFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KEY_CRYPTOGRAM", + "name": "KEY_CRYPTOGRAM" + }, + { + "value": "TR31_KEY_BLOCK", + "name": "TR31_KEY_BLOCK" + }, + { + "value": "TR34_KEY_BLOCK", + "name": "TR34_KEY_BLOCK" + } + ] + } + } + } +}