@aws-sdk/client-pca-connector-ad 3.403.0

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

@@ -0,0 +1,101 @@
+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 { DeleteConnectorRequest } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteConnectorCommand}.
+ */
+export interface DeleteConnectorCommandInput extends DeleteConnectorRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteConnectorCommand}.
+ */
+export interface DeleteConnectorCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the
+ *          connector that you want to delete. You can find the ARN by calling the <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors</a>
+ *          action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can
+ *          deregister your directory by calling the <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration</a>
+ *          action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, DeleteConnectorCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, DeleteConnectorCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // DeleteConnectorRequest
+ *   ConnectorArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteConnectorCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteConnectorCommandInput - {@link DeleteConnectorCommandInput}
+ * @returns {@link DeleteConnectorCommandOutput}
+ * @see {@link DeleteConnectorCommandInput} for command's `input` shape.
+ * @see {@link DeleteConnectorCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 ConflictException} (client fault)
+ *  <p>This request cannot be completed for one of the following reasons because the requested
+ *          resource was being concurrently modified by another request.</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 not be
+ *          specified correctly, or its status might not be ACTIVE.</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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class DeleteConnectorCommand extends $Command<DeleteConnectorCommandInput, DeleteConnectorCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: DeleteConnectorCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteConnectorCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectorCommandInput, DeleteConnectorCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,94 @@
+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 { DeleteDirectoryRegistrationRequest } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteDirectoryRegistrationCommand}.
+ */
+export interface DeleteDirectoryRegistrationCommandInput extends DeleteDirectoryRegistrationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteDirectoryRegistrationCommand}.
+ */
+export interface DeleteDirectoryRegistrationCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a directory registration. Deleting a directory registration deauthorizes
+ *          Amazon Web Services Private CA with the directory. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, DeleteDirectoryRegistrationCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, DeleteDirectoryRegistrationCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // DeleteDirectoryRegistrationRequest
+ *   DirectoryRegistrationArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteDirectoryRegistrationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteDirectoryRegistrationCommandInput - {@link DeleteDirectoryRegistrationCommandInput}
+ * @returns {@link DeleteDirectoryRegistrationCommandOutput}
+ * @see {@link DeleteDirectoryRegistrationCommandInput} for command's `input` shape.
+ * @see {@link DeleteDirectoryRegistrationCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 ConflictException} (client fault)
+ *  <p>This request cannot be completed for one of the following reasons because the requested
+ *          resource was being concurrently modified by another request.</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 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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class DeleteDirectoryRegistrationCommand extends $Command<DeleteDirectoryRegistrationCommandInput, DeleteDirectoryRegistrationCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: DeleteDirectoryRegistrationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteDirectoryRegistrationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDirectoryRegistrationCommandInput, DeleteDirectoryRegistrationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,95 @@
+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 { DeleteServicePrincipalNameRequest } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteServicePrincipalNameCommand}.
+ */
+export interface DeleteServicePrincipalNameCommandInput extends DeleteServicePrincipalNameRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteServicePrincipalNameCommand}.
+ */
+export interface DeleteServicePrincipalNameCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes the service principal name (SPN) used by a connector to authenticate with your
+ *          Active Directory.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, DeleteServicePrincipalNameCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, DeleteServicePrincipalNameCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // DeleteServicePrincipalNameRequest
+ *   DirectoryRegistrationArn: "STRING_VALUE", // required
+ *   ConnectorArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteServicePrincipalNameCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteServicePrincipalNameCommandInput - {@link DeleteServicePrincipalNameCommandInput}
+ * @returns {@link DeleteServicePrincipalNameCommandOutput}
+ * @see {@link DeleteServicePrincipalNameCommandInput} for command's `input` shape.
+ * @see {@link DeleteServicePrincipalNameCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 ConflictException} (client fault)
+ *  <p>This request cannot be completed for one of the following reasons because the requested
+ *          resource was being concurrently modified by another request.</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 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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class DeleteServicePrincipalNameCommand extends $Command<DeleteServicePrincipalNameCommandInput, DeleteServicePrincipalNameCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: DeleteServicePrincipalNameCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteServicePrincipalNameCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteServicePrincipalNameCommandInput, DeleteServicePrincipalNameCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,98 @@
+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 { DeleteTemplateRequest } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteTemplateCommand}.
+ */
+export interface DeleteTemplateCommandInput extends DeleteTemplateRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteTemplateCommand}.
+ */
+export interface DeleteTemplateCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a template. Certificates issued using the template are still valid until they
+ *          are revoked or expired.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, DeleteTemplateCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, DeleteTemplateCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // DeleteTemplateRequest
+ *   TemplateArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteTemplateCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteTemplateCommandInput - {@link DeleteTemplateCommandInput}
+ * @returns {@link DeleteTemplateCommandOutput}
+ * @see {@link DeleteTemplateCommandInput} for command's `input` shape.
+ * @see {@link DeleteTemplateCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 ConflictException} (client fault)
+ *  <p>This request cannot be completed for one of the following reasons because the requested
+ *          resource was being concurrently modified by another request.</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 not be
+ *          specified correctly, or its status might not be ACTIVE.</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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class DeleteTemplateCommand extends $Command<DeleteTemplateCommandInput, DeleteTemplateCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: DeleteTemplateCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteTemplateCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTemplateCommandInput, DeleteTemplateCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,98 @@
+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 { DeleteTemplateGroupAccessControlEntryRequest } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteTemplateGroupAccessControlEntryCommand}.
+ */
+export interface DeleteTemplateGroupAccessControlEntryCommandInput extends DeleteTemplateGroupAccessControlEntryRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteTemplateGroupAccessControlEntryCommand}.
+ */
+export interface DeleteTemplateGroupAccessControlEntryCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a group access control entry.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, DeleteTemplateGroupAccessControlEntryCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, DeleteTemplateGroupAccessControlEntryCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // DeleteTemplateGroupAccessControlEntryRequest
+ *   TemplateArn: "STRING_VALUE", // required
+ *   GroupSecurityIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteTemplateGroupAccessControlEntryCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteTemplateGroupAccessControlEntryCommandInput - {@link DeleteTemplateGroupAccessControlEntryCommandInput}
+ * @returns {@link DeleteTemplateGroupAccessControlEntryCommandOutput}
+ * @see {@link DeleteTemplateGroupAccessControlEntryCommandInput} for command's `input` shape.
+ * @see {@link DeleteTemplateGroupAccessControlEntryCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 ConflictException} (client fault)
+ *  <p>This request cannot be completed for one of the following reasons because the requested
+ *          resource was being concurrently modified by another request.</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 not be
+ *          specified correctly, or its status might not be ACTIVE.</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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class DeleteTemplateGroupAccessControlEntryCommand extends $Command<DeleteTemplateGroupAccessControlEntryCommandInput, DeleteTemplateGroupAccessControlEntryCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: DeleteTemplateGroupAccessControlEntryCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteTemplateGroupAccessControlEntryCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTemplateGroupAccessControlEntryCommandInput, DeleteTemplateGroupAccessControlEntryCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,110 @@
+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 { GetConnectorRequest, GetConnectorResponse } from "../models/models_0";
+import { PcaConnectorAdClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PcaConnectorAdClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetConnectorCommand}.
+ */
+export interface GetConnectorCommandInput extends GetConnectorRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetConnectorCommand}.
+ */
+export interface GetConnectorCommandOutput extends GetConnectorResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists information about your connector. You specify the connector on input by its ARN
+ *          (Amazon Resource Name). </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PcaConnectorAdClient, GetConnectorCommand } from "@aws-sdk/client-pca-connector-ad"; // ES Modules import
+ * // const { PcaConnectorAdClient, GetConnectorCommand } = require("@aws-sdk/client-pca-connector-ad"); // CommonJS import
+ * const client = new PcaConnectorAdClient(config);
+ * const input = { // GetConnectorRequest
+ *   ConnectorArn: "STRING_VALUE", // required
+ * };
+ * const command = new GetConnectorCommand(input);
+ * const response = await client.send(command);
+ * // { // GetConnectorResponse
+ * //   Connector: { // Connector
+ * //     Arn: "STRING_VALUE",
+ * //     CertificateAuthorityArn: "STRING_VALUE",
+ * //     CertificateEnrollmentPolicyServerEndpoint: "STRING_VALUE",
+ * //     DirectoryId: "STRING_VALUE",
+ * //     VpcInformation: { // VpcInformation
+ * //       SecurityGroupIds: [ // SecurityGroupIdList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED",
+ * //     StatusReason: "DIRECTORY_ACCESS_DENIED" || "INTERNAL_FAILURE" || "PRIVATECA_ACCESS_DENIED" || "PRIVATECA_RESOURCE_NOT_FOUND" || "SECURITY_GROUP_NOT_IN_VPC" || "VPC_ACCESS_DENIED" || "VPC_ENDPOINT_LIMIT_EXCEEDED" || "VPC_RESOURCE_NOT_FOUND",
+ * //     CreatedAt: new Date("TIMESTAMP"),
+ * //     UpdatedAt: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetConnectorCommandInput - {@link GetConnectorCommandInput}
+ * @returns {@link GetConnectorCommandOutput}
+ * @see {@link GetConnectorCommandInput} for command's `input` shape.
+ * @see {@link GetConnectorCommandOutput} for command's `response` shape.
+ * @see {@link PcaConnectorAdClientResolvedConfig | config} for PcaConnectorAdClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You can receive this error if you attempt to create a resource share when 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 not be
+ *          specified correctly, or its status might not be ACTIVE.</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 template name,
+ *          or if a pagination token is invalid. </p>
+ *
+ * @throws {@link PcaConnectorAdServiceException}
+ * <p>Base exception class for all service exceptions from PcaConnectorAd service.</p>
+ *
+ */
+export declare class GetConnectorCommand extends $Command<GetConnectorCommandInput, GetConnectorCommandOutput, PcaConnectorAdClientResolvedConfig> {
+    readonly input: GetConnectorCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetConnectorCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PcaConnectorAdClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConnectorCommandInput, GetConnectorCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}