@aws-sdk/client-payment-cryptography 3.349.0

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

@@ -0,0 +1,115 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
+import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a tag from an Amazon Web Services Payment Cryptography key.</p>
+ *          <note>
+ *             <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p>
+ *          </note>
+ *          <p>
+ *             <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
+ *          <p>
+ *             <b>Related operations:</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>ListTagsForResource</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>TagResource</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PaymentCryptographyClient, UntagResourceCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
+ * // const { PaymentCryptographyClient, UntagResourceCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
+ * const client = new PaymentCryptographyClient(config);
+ * const input = { // UntagResourceInput
+ *   ResourceArn: "STRING_VALUE", // required
+ *   TagKeys: [ // TagKeys // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>This request can cause an inconsistent state for the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied due to an invalid resource error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied due to an invalid request error.</p>
+ *
+ * @throws {@link PaymentCryptographyServiceException}
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, PaymentCryptographyClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,125 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UpdateAliasInput, UpdateAliasOutput } from "../models/models_0";
+import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAliasCommand}.
+ */
+export interface UpdateAliasCommandInput extends UpdateAliasInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAliasCommand}.
+ */
+export interface UpdateAliasCommandOutput extends UpdateAliasOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>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</p>
+ *          <p>
+ *             <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
+ *          <p>
+ *             <b>Related operations:</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>CreateAlias</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>DeleteAlias</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetAlias</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListAliases</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PaymentCryptographyClient, UpdateAliasCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
+ * // const { PaymentCryptographyClient, UpdateAliasCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
+ * const client = new PaymentCryptographyClient(config);
+ * const input = { // UpdateAliasInput
+ *   AliasName: "STRING_VALUE", // required
+ *   KeyArn: "STRING_VALUE",
+ * };
+ * const command = new UpdateAliasCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAliasOutput
+ * //   Alias: { // Alias
+ * //     AliasName: "STRING_VALUE", // required
+ * //     KeyArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateAliasCommandInput - {@link UpdateAliasCommandInput}
+ * @returns {@link UpdateAliasCommandOutput}
+ * @see {@link UpdateAliasCommandInput} for command's `input` shape.
+ * @see {@link UpdateAliasCommandOutput} for command's `response` shape.
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>This request can cause an inconsistent state for the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied due to an invalid resource error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied due to an invalid request error.</p>
+ *
+ * @throws {@link PaymentCryptographyServiceException}
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
+ *
+ */
+export declare class UpdateAliasCommand extends $Command<UpdateAliasCommandInput, UpdateAliasCommandOutput, PaymentCryptographyClientResolvedConfig> {
+    readonly input: UpdateAliasCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateAliasCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAliasCommandInput, UpdateAliasCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,20 @@
+export * from "./CreateAliasCommand";
+export * from "./CreateKeyCommand";
+export * from "./DeleteAliasCommand";
+export * from "./DeleteKeyCommand";
+export * from "./ExportKeyCommand";
+export * from "./GetAliasCommand";
+export * from "./GetKeyCommand";
+export * from "./GetParametersForExportCommand";
+export * from "./GetParametersForImportCommand";
+export * from "./GetPublicKeyCertificateCommand";
+export * from "./ImportKeyCommand";
+export * from "./ListAliasesCommand";
+export * from "./ListKeysCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RestoreKeyCommand";
+export * from "./StartKeyUsageCommand";
+export * from "./StopKeyUsageCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateAliasCommand";

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

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

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

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

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

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

package/dist-types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * <p>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 <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html">Identity and access management</a> in the <i>Amazon Web Services Payment Cryptography User Guide.</i>
+ *          </p>
+ *          <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations. </p>
+ *          <p>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. </p>
+ *          <p>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./PaymentCryptographyClient";
+export * from "./PaymentCryptography";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { PaymentCryptographyServiceException } from "./models/PaymentCryptographyServiceException";

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

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

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

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