@aws-sdk/client-pca-connector-scep 3.595.0

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

@@ -0,0 +1,86 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
+import { PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorScepClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListTagsForResourceCommand}.
+ */
+export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListTagsForResourceCommand}.
+ */
+export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
+}
+declare const ListTagsForResourceCommand_base: {
+    new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves the tags associated with the specified resource. Tags are key-value pairs that
+ *       you can use to categorize and manage your resources, for purposes like billing. For
+ *       example, you might set the tag key to "customer" and the value to the customer name or ID.
+ *       You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
+ *       resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorScepClient, ListTagsForResourceCommand } from "@aws-sdk/client-pca-connector-scep"; // ES Modules import
+ * // const { PcaConnectorScepClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pca-connector-scep"); // CommonJS import
+ * const client = new PcaConnectorScepClient(config);
+ * const input = { // ListTagsForResourceRequest
+ *   ResourceArn: "STRING_VALUE", // required
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * // { // ListTagsForResourceResponse
+ * //   Tags: { // Tags
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorScepClientResolvedConfig | config} for PcaConnectorScepClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to perform an operation and you don't have
+ *       the required permissions. This can be caused by insufficient permissions in policies
+ *       attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen
+ *       because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)
+ *       that affects your Amazon Web Services account.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure with
+ *       an internal server.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.</p>
+ *
+ * @throws {@link PcaConnectorScepServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorScep service.</p>
+ *
+ * @public
+ */
+export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
+}

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

@@ -0,0 +1,81 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { TagResourceRequest } from "../models/models_0";
+import { PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorScepClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends __MetadataBearer {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Adds one or more tags to your resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorScepClient, TagResourceCommand } from "@aws-sdk/client-pca-connector-scep"; // ES Modules import
+ * // const { PcaConnectorScepClient, TagResourceCommand } = require("@aws-sdk/client-pca-connector-scep"); // CommonJS import
+ * const client = new PcaConnectorScepClient(config);
+ * const input = { // TagResourceRequest
+ *   ResourceArn: "STRING_VALUE", // required
+ *   Tags: { // Tags // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorScepClientResolvedConfig | config} for PcaConnectorScepClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to perform an operation and you don't have
+ *       the required permissions. This can be caused by insufficient permissions in policies
+ *       attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen
+ *       because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)
+ *       that affects your Amazon Web Services account.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure with
+ *       an internal server.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.</p>
+ *
+ * @throws {@link PcaConnectorScepServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorScep service.</p>
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+}

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

@@ -0,0 +1,81 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UntagResourceRequest } from "../models/models_0";
+import { PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorScepClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends __MetadataBearer {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, PcaConnectorScepClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Removes one or more tags from your resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorScepClient, UntagResourceCommand } from "@aws-sdk/client-pca-connector-scep"; // ES Modules import
+ * // const { PcaConnectorScepClient, UntagResourceCommand } = require("@aws-sdk/client-pca-connector-scep"); // CommonJS import
+ * const client = new PcaConnectorScepClient(config);
+ * const input = { // UntagResourceRequest
+ *   ResourceArn: "STRING_VALUE", // required
+ *   TagKeys: [ // TagKeyList // 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 PcaConnectorScepClientResolvedConfig | config} for PcaConnectorScepClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to perform an operation and you don't have
+ *       the required permissions. This can be caused by insufficient permissions in policies
+ *       attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen
+ *       because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)
+ *       that affects your Amazon Web Services account.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure with
+ *       an internal server.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.</p>
+ *
+ * @throws {@link PcaConnectorScepServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorScep service.</p>
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+}

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

@@ -0,0 +1,12 @@
+export * from "./CreateChallengeCommand";
+export * from "./CreateConnectorCommand";
+export * from "./DeleteChallengeCommand";
+export * from "./DeleteConnectorCommand";
+export * from "./GetChallengeMetadataCommand";
+export * from "./GetChallengePasswordCommand";
+export * from "./GetConnectorCommand";
+export * from "./ListChallengeMetadataCommand";
+export * from "./ListConnectorsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";

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

@@ -0,0 +1,40 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+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 declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+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 "@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,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface PcaConnectorScepExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * <note>
+ *             <p>Connector for SCEP (Preview) is in preview release for Amazon Web Services Private Certificate Authority and is subject to change.</p>
+ *          </note>
+ *          <p>Connector for SCEP (Preview) creates a connector between Amazon Web Services Private CA and your SCEP-enabled clients and devices. For more
+ *       information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.html">Connector for SCEP</a> in the <i>Amazon Web Services Private CA User Guide</i>.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./PcaConnectorScepClient";
+export * from "./PcaConnectorScep";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { PcaConnectorScepExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { PcaConnectorScepServiceException } from "./models/PcaConnectorScepServiceException";

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

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

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

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