@aws-sdk/client-directory-service 3.856.0 → 3.857.0

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

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceClient";
+import { ListADAssessmentsRequest, ListADAssessmentsResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListADAssessmentsCommand}.
+ */
+export interface ListADAssessmentsCommandInput extends ListADAssessmentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListADAssessmentsCommand}.
+ */
+export interface ListADAssessmentsCommandOutput extends ListADAssessmentsResult, __MetadataBearer {
+}
+declare const ListADAssessmentsCommand_base: {
+    new (input: ListADAssessmentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListADAssessmentsCommandInput, ListADAssessmentsCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListADAssessmentsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListADAssessmentsCommandInput, ListADAssessmentsCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a list of directory assessments for the specified directory or all
+ *             assessments in your account. Use this operation to monitor assessment status and manage
+ *             multiple assessments.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DirectoryServiceClient, ListADAssessmentsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import
+ * // const { DirectoryServiceClient, ListADAssessmentsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import
+ * const client = new DirectoryServiceClient(config);
+ * const input = { // ListADAssessmentsRequest
+ *   DirectoryId: "STRING_VALUE",
+ *   NextToken: "STRING_VALUE",
+ *   Limit: Number("int"),
+ * };
+ * const command = new ListADAssessmentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListADAssessmentsResult
+ * //   Assessments: [ // Assessments
+ * //     { // AssessmentSummary
+ * //       AssessmentId: "STRING_VALUE",
+ * //       DirectoryId: "STRING_VALUE",
+ * //       DnsName: "STRING_VALUE",
+ * //       StartTime: new Date("TIMESTAMP"),
+ * //       LastUpdateDateTime: new Date("TIMESTAMP"),
+ * //       Status: "STRING_VALUE",
+ * //       CustomerDnsIps: [ // CustomerDnsIps
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       ReportType: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListADAssessmentsCommandInput - {@link ListADAssessmentsCommandInput}
+ * @returns {@link ListADAssessmentsCommandOutput}
+ * @see {@link ListADAssessmentsCommandInput} for command's `input` shape.
+ * @see {@link ListADAssessmentsCommandOutput} for command's `response` shape.
+ * @see {@link DirectoryServiceClientResolvedConfig | config} for DirectoryServiceClient's `config` shape.
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>A client exception has occurred.</p>
+ *
+ * @throws {@link DirectoryDoesNotExistException} (client fault)
+ *  <p>The specified directory does not exist in the system.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more parameters are not valid.</p>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>An exception has occurred in Directory Service.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The operation is not supported.</p>
+ *
+ * @throws {@link DirectoryServiceServiceException}
+ * <p>Base exception class for all service exceptions from DirectoryService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListADAssessmentsCommand extends ListADAssessmentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListADAssessmentsRequest;
+            output: ListADAssessmentsResult;
+        };
+        sdk: {
+            input: ListADAssessmentsCommandInput;
+            output: ListADAssessmentsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,132 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceClient";
+import { StartADAssessmentRequest, StartADAssessmentResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartADAssessmentCommand}.
+ */
+export interface StartADAssessmentCommandInput extends StartADAssessmentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartADAssessmentCommand}.
+ */
+export interface StartADAssessmentCommandOutput extends StartADAssessmentResult, __MetadataBearer {
+}
+declare const StartADAssessmentCommand_base: {
+    new (input: StartADAssessmentCommandInput): import("@smithy/smithy-client").CommandImpl<StartADAssessmentCommandInput, StartADAssessmentCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [StartADAssessmentCommandInput]): import("@smithy/smithy-client").CommandImpl<StartADAssessmentCommandInput, StartADAssessmentCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Initiates a directory assessment to validate your self-managed AD environment for
+ *             hybrid domain join. The assessment checks compatibility and connectivity of the
+ *             self-managed AD environment.</p>
+ *          <p>A directory assessment is automatically created when you create a hybrid directory.
+ *             There are two types of assessments: <code>CUSTOMER</code> and <code>SYSTEM</code>. Your
+ *             Amazon Web Services account has a limit of 100 <code>CUSTOMER</code> directory assessments.</p>
+ *          <p>The assessment process typically takes 30 minutes or more to complete. The assessment
+ *             process is asynchronous and you can monitor it with
+ *             <code>DescribeADAssessment</code>.</p>
+ *          <p>The <code>InstanceIds</code> must have a one-to-one correspondence with
+ *                 <code>CustomerDnsIps</code>, meaning that if the IP address for instance i-10243410
+ *             is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the
+ *             input arrays must maintain the same order relationship, either [10.24.34.100,
+ *             10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]
+ *             paired with [i-10243420, i-10243410].</p>
+ *          <p>Note: You must provide exactly one <code>DirectoryId</code> or
+ *                 <code>AssessmentConfiguration</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DirectoryServiceClient, StartADAssessmentCommand } from "@aws-sdk/client-directory-service"; // ES Modules import
+ * // const { DirectoryServiceClient, StartADAssessmentCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import
+ * const client = new DirectoryServiceClient(config);
+ * const input = { // StartADAssessmentRequest
+ *   AssessmentConfiguration: { // AssessmentConfiguration
+ *     CustomerDnsIps: [ // CustomerDnsIps // required
+ *       "STRING_VALUE",
+ *     ],
+ *     DnsName: "STRING_VALUE", // required
+ *     VpcSettings: { // DirectoryVpcSettings
+ *       VpcId: "STRING_VALUE", // required
+ *       SubnetIds: [ // SubnetIds // required
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *     InstanceIds: [ // AssessmentInstanceIds // required
+ *       "STRING_VALUE",
+ *     ],
+ *     SecurityGroupIds: [ // SecurityGroupIds
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   DirectoryId: "STRING_VALUE",
+ * };
+ * const command = new StartADAssessmentCommand(input);
+ * const response = await client.send(command);
+ * // { // StartADAssessmentResult
+ * //   AssessmentId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartADAssessmentCommandInput - {@link StartADAssessmentCommandInput}
+ * @returns {@link StartADAssessmentCommandOutput}
+ * @see {@link StartADAssessmentCommandInput} for command's `input` shape.
+ * @see {@link StartADAssessmentCommandOutput} for command's `response` shape.
+ * @see {@link DirectoryServiceClientResolvedConfig | config} for DirectoryServiceClient's `config` shape.
+ *
+ * @throws {@link ADAssessmentLimitExceededException} (client fault)
+ *  <p>A directory assessment is automatically created when you create a hybrid directory.
+ *             There are two types of assessments: <code>CUSTOMER</code> and <code>SYSTEM</code>. Your
+ *             Amazon Web Services account has a limit of 100 <code>CUSTOMER</code> directory assessments.</p>
+ *          <p>If you attempt to create a hybrid directory; and you already have 100
+ *                 <code>CUSTOMER</code> directory assessments;, you will encounter an error. Delete
+ *             assessments to free up capacity before trying again.</p>
+ *          <p>You can request an increase to your <code>CUSTOMER</code> directory assessment quota
+ *             by contacting customer support or delete existing CUSTOMER directory assessments; to
+ *             free up capacity.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>A client exception has occurred.</p>
+ *
+ * @throws {@link DirectoryDoesNotExistException} (client fault)
+ *  <p>The specified directory does not exist in the system.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more parameters are not valid.</p>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>An exception has occurred in Directory Service.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The operation is not supported.</p>
+ *
+ * @throws {@link DirectoryServiceServiceException}
+ * <p>Base exception class for all service exceptions from DirectoryService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartADAssessmentCommand extends StartADAssessmentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartADAssessmentRequest;
+            output: StartADAssessmentResult;
+        };
+        sdk: {
+            input: StartADAssessmentCommandInput;
+            output: StartADAssessmentCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,122 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceClient";
+import { UpdateHybridADRequest, UpdateHybridADResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateHybridADCommand}.
+ */
+export interface UpdateHybridADCommandInput extends UpdateHybridADRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateHybridADCommand}.
+ */
+export interface UpdateHybridADCommandOutput extends UpdateHybridADResult, __MetadataBearer {
+}
+declare const UpdateHybridADCommand_base: {
+    new (input: UpdateHybridADCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHybridADCommandInput, UpdateHybridADCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateHybridADCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHybridADCommandInput, UpdateHybridADCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the configuration of an existing hybrid directory. You can recover hybrid
+ *             directory administrator account or modify self-managed instance settings.</p>
+ *          <p>Updates are applied asynchronously. Use <a>DescribeHybridADUpdate</a> to
+ *             monitor the progress of configuration changes.</p>
+ *          <p>The <code>InstanceIds</code> must have a one-to-one correspondence with
+ *                 <code>CustomerDnsIps</code>, meaning that if the IP address for instance i-10243410
+ *             is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the
+ *             input arrays must maintain the same order relationship, either [10.24.34.100,
+ *             10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]
+ *             paired with [i-10243420, i-10243410].</p>
+ *          <note>
+ *             <p>You must provide at least one update to <a>UpdateHybridADRequest$HybridAdministratorAccountUpdate</a> or <a>UpdateHybridADRequest$SelfManagedInstancesSettings</a>.</p>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DirectoryServiceClient, UpdateHybridADCommand } from "@aws-sdk/client-directory-service"; // ES Modules import
+ * // const { DirectoryServiceClient, UpdateHybridADCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import
+ * const client = new DirectoryServiceClient(config);
+ * const input = { // UpdateHybridADRequest
+ *   DirectoryId: "STRING_VALUE", // required
+ *   HybridAdministratorAccountUpdate: { // HybridAdministratorAccountUpdate
+ *     SecretArn: "STRING_VALUE", // required
+ *   },
+ *   SelfManagedInstancesSettings: { // HybridCustomerInstancesSettings
+ *     CustomerDnsIps: [ // CustomerDnsIps // required
+ *       "STRING_VALUE",
+ *     ],
+ *     InstanceIds: [ // AssessmentInstanceIds // required
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new UpdateHybridADCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateHybridADResult
+ * //   DirectoryId: "STRING_VALUE",
+ * //   AssessmentId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateHybridADCommandInput - {@link UpdateHybridADCommandInput}
+ * @returns {@link UpdateHybridADCommandOutput}
+ * @see {@link UpdateHybridADCommandInput} for command's `input` shape.
+ * @see {@link UpdateHybridADCommandOutput} for command's `response` shape.
+ * @see {@link DirectoryServiceClientResolvedConfig | config} for DirectoryServiceClient's `config` shape.
+ *
+ * @throws {@link ADAssessmentLimitExceededException} (client fault)
+ *  <p>A directory assessment is automatically created when you create a hybrid directory.
+ *             There are two types of assessments: <code>CUSTOMER</code> and <code>SYSTEM</code>. Your
+ *             Amazon Web Services account has a limit of 100 <code>CUSTOMER</code> directory assessments.</p>
+ *          <p>If you attempt to create a hybrid directory; and you already have 100
+ *                 <code>CUSTOMER</code> directory assessments;, you will encounter an error. Delete
+ *             assessments to free up capacity before trying again.</p>
+ *          <p>You can request an increase to your <code>CUSTOMER</code> directory assessment quota
+ *             by contacting customer support or delete existing CUSTOMER directory assessments; to
+ *             free up capacity.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>A client exception has occurred.</p>
+ *
+ * @throws {@link DirectoryDoesNotExistException} (client fault)
+ *  <p>The specified directory does not exist in the system.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more parameters are not valid.</p>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>An exception has occurred in Directory Service.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The operation is not supported.</p>
+ *
+ * @throws {@link DirectoryServiceServiceException}
+ * <p>Base exception class for all service exceptions from DirectoryService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateHybridADCommand extends UpdateHybridADCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateHybridADRequest;
+            output: UpdateHybridADResult;
+        };
+        sdk: {
+            input: UpdateHybridADCommandInput;
+            output: UpdateHybridADCommandOutput;
+        };
+    };
+}

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

@@ -8,10 +8,12 @@ export * from "./CreateAliasCommand";
 export * from "./CreateComputerCommand";
 export * from "./CreateConditionalForwarderCommand";
 export * from "./CreateDirectoryCommand";
+export * from "./CreateHybridADCommand";
 export * from "./CreateLogSubscriptionCommand";
 export * from "./CreateMicrosoftADCommand";
 export * from "./CreateSnapshotCommand";
 export * from "./CreateTrustCommand";
+export * from "./DeleteADAssessmentCommand";
 export * from "./DeleteConditionalForwarderCommand";
 export * from "./DeleteDirectoryCommand";
 export * from "./DeleteLogSubscriptionCommand";
@@ -19,6 +21,7 @@ export * from "./DeleteSnapshotCommand";
 export * from "./DeleteTrustCommand";
 export * from "./DeregisterCertificateCommand";
 export * from "./DeregisterEventTopicCommand";
+export * from "./DescribeADAssessmentCommand";
 export * from "./DescribeCertificateCommand";
 export * from "./DescribeClientAuthenticationSettingsCommand";
 export * from "./DescribeConditionalForwardersCommand";
@@ -26,6 +29,7 @@ export * from "./DescribeDirectoriesCommand";
 export * from "./DescribeDirectoryDataAccessCommand";
 export * from "./DescribeDomainControllersCommand";
 export * from "./DescribeEventTopicsCommand";
+export * from "./DescribeHybridADUpdateCommand";
 export * from "./DescribeLDAPSSettingsCommand";
 export * from "./DescribeRegionsCommand";
 export * from "./DescribeSettingsCommand";
@@ -45,6 +49,7 @@ export * from "./EnableRadiusCommand";
 export * from "./EnableSsoCommand";
 export * from "./GetDirectoryLimitsCommand";
 export * from "./GetSnapshotLimitsCommand";
+export * from "./ListADAssessmentsCommand";
 export * from "./ListCertificatesCommand";
 export * from "./ListIpRoutesCommand";
 export * from "./ListLogSubscriptionsCommand";
@@ -59,10 +64,12 @@ export * from "./RemoveTagsFromResourceCommand";
 export * from "./ResetUserPasswordCommand";
 export * from "./RestoreFromSnapshotCommand";
 export * from "./ShareDirectoryCommand";
+export * from "./StartADAssessmentCommand";
 export * from "./StartSchemaExtensionCommand";
 export * from "./UnshareDirectoryCommand";
 export * from "./UpdateConditionalForwarderCommand";
 export * from "./UpdateDirectorySetupCommand";
+export * from "./UpdateHybridADCommand";
 export * from "./UpdateNumberOfDomainControllersCommand";
 export * from "./UpdateRadiusCommand";
 export * from "./UpdateSettingsCommand";

package/dist-types/index.d.ts

@@ -23,5 +23,6 @@ export type { RuntimeExtension } from "./runtimeExtensions";
 export type { DirectoryServiceExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
+export * from "./waiters";
 export * from "./models";
 export { DirectoryServiceServiceException } from "./models/DirectoryServiceServiceException";