@aws-sdk/client-cloudfront-keyvaluestore 3.456.0

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

@@ -0,0 +1,96 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CloudFrontKeyValueStoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFrontKeyValueStoreClient";
+import { PutKeyRequest, PutKeyResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutKeyCommand}.
+ */
+export interface PutKeyCommandInput extends PutKeyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutKeyCommand}.
+ */
+export interface PutKeyCommandOutput extends PutKeyResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates a new key value pair or replaces the value of an existing key.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudFrontKeyValueStoreClient, PutKeyCommand } from "@aws-sdk/client-cloudfront-keyvaluestore"; // ES Modules import
+ * // const { CloudFrontKeyValueStoreClient, PutKeyCommand } = require("@aws-sdk/client-cloudfront-keyvaluestore"); // CommonJS import
+ * const client = new CloudFrontKeyValueStoreClient(config);
+ * const input = { // PutKeyRequest
+ *   Key: "STRING_VALUE", // required
+ *   Value: "STRING_VALUE", // required
+ *   KvsARN: "STRING_VALUE", // required
+ *   IfMatch: "STRING_VALUE", // required
+ * };
+ * const command = new PutKeyCommand(input);
+ * const response = await client.send(command);
+ * // { // PutKeyResponse
+ * //   ItemCount: Number("int"), // required
+ * //   TotalSizeInBytes: Number("long"), // required
+ * //   ETag: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param PutKeyCommandInput - {@link PutKeyCommandInput}
+ * @returns {@link PutKeyCommandOutput}
+ * @see {@link PutKeyCommandInput} for command's `input` shape.
+ * @see {@link PutKeyCommandOutput} for command's `response` shape.
+ * @see {@link CloudFrontKeyValueStoreClientResolvedConfig | config} for CloudFrontKeyValueStoreClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Resource is not in expected state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Resource was not found.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Limit exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Validation failed.</p>
+ *
+ * @throws {@link CloudFrontKeyValueStoreServiceException}
+ * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
+ *
+ */
+export declare class PutKeyCommand extends $Command<PutKeyCommandInput, PutKeyCommandOutput, CloudFrontKeyValueStoreClientResolvedConfig> {
+    readonly input: PutKeyCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutKeyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFrontKeyValueStoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutKeyCommandInput, PutKeyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,105 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CloudFrontKeyValueStoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFrontKeyValueStoreClient";
+import { UpdateKeysRequest, UpdateKeysResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKeysCommand}.
+ */
+export interface UpdateKeysCommandInput extends UpdateKeysRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKeysCommand}.
+ */
+export interface UpdateKeysCommandOutput extends UpdateKeysResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudFrontKeyValueStoreClient, UpdateKeysCommand } from "@aws-sdk/client-cloudfront-keyvaluestore"; // ES Modules import
+ * // const { CloudFrontKeyValueStoreClient, UpdateKeysCommand } = require("@aws-sdk/client-cloudfront-keyvaluestore"); // CommonJS import
+ * const client = new CloudFrontKeyValueStoreClient(config);
+ * const input = { // UpdateKeysRequest
+ *   KvsARN: "STRING_VALUE", // required
+ *   IfMatch: "STRING_VALUE", // required
+ *   Puts: [ // PutKeyRequestsList
+ *     { // PutKeyRequestListItem
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   Deletes: [ // DeleteKeyRequestsList
+ *     { // DeleteKeyRequestListItem
+ *       Key: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateKeysCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKeysResponse
+ * //   ItemCount: Number("int"), // required
+ * //   TotalSizeInBytes: Number("long"), // required
+ * //   ETag: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKeysCommandInput - {@link UpdateKeysCommandInput}
+ * @returns {@link UpdateKeysCommandOutput}
+ * @see {@link UpdateKeysCommandInput} for command's `input` shape.
+ * @see {@link UpdateKeysCommandOutput} for command's `response` shape.
+ * @see {@link CloudFrontKeyValueStoreClientResolvedConfig | config} for CloudFrontKeyValueStoreClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Resource is not in expected state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Resource was not found.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Limit exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Validation failed.</p>
+ *
+ * @throws {@link CloudFrontKeyValueStoreServiceException}
+ * <p>Base exception class for all service exceptions from CloudFrontKeyValueStore service.</p>
+ *
+ */
+export declare class UpdateKeysCommand extends $Command<UpdateKeysCommandInput, UpdateKeysCommandOutput, CloudFrontKeyValueStoreClientResolvedConfig> {
+    readonly input: UpdateKeysCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateKeysCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFrontKeyValueStoreClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKeysCommandInput, UpdateKeysCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,6 @@
+export * from "./DeleteKeyCommand";
+export * from "./DescribeKeyValueStoreCommand";
+export * from "./GetKeyCommand";
+export * from "./ListKeysCommand";
+export * from "./PutKeyCommand";
+export * from "./UpdateKeysCommand";

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

@@ -0,0 +1,21 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    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 {
+    KvsARN?: string;
+    Region?: string;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

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

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/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 "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface CloudFrontKeyValueStoreExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * <p>Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./CloudFrontKeyValueStoreClient";
+export * from "./CloudFrontKeyValueStore";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { CloudFrontKeyValueStoreExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+import "@aws-sdk/util-endpoints";
+export { CloudFrontKeyValueStoreServiceException } from "./models/CloudFrontKeyValueStoreServiceException";

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

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

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

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

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

@@ -0,0 +1,403 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { CloudFrontKeyValueStoreServiceException as __BaseException } from "./CloudFrontKeyValueStoreServiceException";
+/**
+ * @public
+ * <p>Access denied.</p>
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Resource is not in expected state.</p>
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DeleteKeyRequest {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>The key to delete.</p>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <p>The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.</p>
+     */
+    IfMatch: string | undefined;
+}
+/**
+ * @public
+ * <p>Metadata information about a Key Value Store.</p>
+ */
+export interface DeleteKeyResponse {
+    /**
+     * @public
+     * <p>Number of key value pairs in the Key Value Store after the successful delete.</p>
+     */
+    ItemCount: number | undefined;
+    /**
+     * @public
+     * <p>Total size of the Key Value Store after the successful delete, in bytes.</p>
+     */
+    TotalSizeInBytes: number | undefined;
+    /**
+     * @public
+     * <p>The current version identifier of the Key Value Store after the successful delete.</p>
+     */
+    ETag: string | undefined;
+}
+/**
+ * @public
+ * <p>Internal server error.</p>
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Resource was not found.</p>
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Limit exceeded.</p>
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Validation failed.</p>
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DescribeKeyValueStoreRequest {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+}
+/**
+ * @public
+ * <p>Metadata information about a Key Value Store.</p>
+ */
+export interface DescribeKeyValueStoreResponse {
+    /**
+     * @public
+     * <p>Number of key value pairs in the Key Value Store.</p>
+     */
+    ItemCount: number | undefined;
+    /**
+     * @public
+     * <p>Total size of the Key Value Store in bytes.</p>
+     */
+    TotalSizeInBytes: number | undefined;
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>Date and time when the Key Value Store was created.</p>
+     */
+    Created: Date | undefined;
+    /**
+     * @public
+     * <p>The version identifier for the current version of the Key Value Store.</p>
+     */
+    ETag: string | undefined;
+    /**
+     * @public
+     * <p>Date and time when the key value pairs in the Key Value Store was last modified.</p>
+     */
+    LastModified?: Date;
+}
+/**
+ * @public
+ */
+export interface GetKeyRequest {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>The key to get.</p>
+     */
+    Key: string | undefined;
+}
+/**
+ * @public
+ * <p>A key value pair.</p>
+ */
+export interface GetKeyResponse {
+    /**
+     * @public
+     * <p>The key of the key value pair.</p>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <p>The value of the key value pair.</p>
+     */
+    Value: string | undefined;
+    /**
+     * @public
+     * <p>Number of key value pairs in the Key Value Store.</p>
+     */
+    ItemCount: number | undefined;
+    /**
+     * @public
+     * <p>Total size of the Key Value Store in bytes.</p>
+     */
+    TotalSizeInBytes: number | undefined;
+}
+/**
+ * @public
+ */
+export interface ListKeysRequest {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.</p>
+     */
+    MaxResults?: number;
+}
+/**
+ * @public
+ * <p>A key value pair.</p>
+ */
+export interface ListKeysResponseListItem {
+    /**
+     * @public
+     * <p>The key of the key value pair.</p>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <p>The value of the key value pair.</p>
+     */
+    Value: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListKeysResponse {
+    /**
+     * @public
+     * <p>If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>Key value pairs</p>
+     */
+    Items?: ListKeysResponseListItem[];
+}
+/**
+ * @public
+ * <p>A key value pair.</p>
+ */
+export interface PutKeyRequest {
+    /**
+     * @public
+     * <p>The key to put.</p>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <p>The value to put.</p>
+     */
+    Value: string | undefined;
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>The current version (ETag) of the Key Value Store that you are putting keys into, which you can get using DescribeKeyValueStore.</p>
+     */
+    IfMatch: string | undefined;
+}
+/**
+ * @public
+ * <p>Metadata information about a Key Value Store.</p>
+ */
+export interface PutKeyResponse {
+    /**
+     * @public
+     * <p>Number of key value pairs in the Key Value Store after the successful put.</p>
+     */
+    ItemCount: number | undefined;
+    /**
+     * @public
+     * <p>Total size of the Key Value Store after the successful put, in bytes.</p>
+     */
+    TotalSizeInBytes: number | undefined;
+    /**
+     * @public
+     * <p>The current version identifier of the Key Value Store after the successful put.</p>
+     */
+    ETag: string | undefined;
+}
+/**
+ * @public
+ * <p>List item for keys to delete.</p>
+ */
+export interface DeleteKeyRequestListItem {
+    /**
+     * @public
+     * <p>The key of the key value pair to be deleted.</p>
+     */
+    Key: string | undefined;
+}
+/**
+ * @public
+ * <p>List item for key value pair to put.</p>
+ */
+export interface PutKeyRequestListItem {
+    /**
+     * @public
+     * <p>The key of the key value pair list item to put.</p>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <p>The value for the key value pair to put.</p>
+     */
+    Value: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateKeysRequest {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
+     */
+    KvsARN: string | undefined;
+    /**
+     * @public
+     * <p>The current version (ETag) of the Key Value Store that you are updating keys of, which you can get using DescribeKeyValueStore.</p>
+     */
+    IfMatch: string | undefined;
+    /**
+     * @public
+     * <p>List of key value pairs to put.</p>
+     */
+    Puts?: PutKeyRequestListItem[];
+    /**
+     * @public
+     * <p>List of keys to delete.</p>
+     */
+    Deletes?: DeleteKeyRequestListItem[];
+}
+/**
+ * @public
+ * <p>Metadata information about a Key Value Store.</p>
+ */
+export interface UpdateKeysResponse {
+    /**
+     * @public
+     * <p>Number of key value pairs in the Key Value Store after the successful update.</p>
+     */
+    ItemCount: number | undefined;
+    /**
+     * @public
+     * <p>Total size of the Key Value Store after the successful update, in bytes.</p>
+     */
+    TotalSizeInBytes: number | undefined;
+    /**
+     * @public
+     * <p>The current version identifier of the Key Value Store after the successful update.</p>
+     */
+    ETag: string | undefined;
+}
+/**
+ * @internal
+ */
+export declare const GetKeyResponseFilterSensitiveLog: (obj: GetKeyResponse) => any;
+/**
+ * @internal
+ */
+export declare const ListKeysResponseListItemFilterSensitiveLog: (obj: ListKeysResponseListItem) => any;
+/**
+ * @internal
+ */
+export declare const ListKeysResponseFilterSensitiveLog: (obj: ListKeysResponse) => any;
+/**
+ * @internal
+ */
+export declare const PutKeyRequestFilterSensitiveLog: (obj: PutKeyRequest) => any;
+/**
+ * @internal
+ */
+export declare const PutKeyRequestListItemFilterSensitiveLog: (obj: PutKeyRequestListItem) => any;
+/**
+ * @internal
+ */
+export declare const UpdateKeysRequestFilterSensitiveLog: (obj: UpdateKeysRequest) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -0,0 +1,8 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { CloudFrontKeyValueStoreClient } from "../CloudFrontKeyValueStoreClient";
+/**
+ * @public
+ */
+export interface CloudFrontKeyValueStorePaginationConfiguration extends PaginationConfiguration {
+    client: CloudFrontKeyValueStoreClient;
+}