@aws-sdk/client-workspaces-web 3.342.0 → 3.344.0

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

@@ -0,0 +1,102 @@
+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 { GetIpAccessSettingsRequest, GetIpAccessSettingsResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetIpAccessSettingsCommand}.
+ */
+export interface GetIpAccessSettingsCommandInput extends GetIpAccessSettingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetIpAccessSettingsCommand}.
+ */
+export interface GetIpAccessSettingsCommandOutput extends GetIpAccessSettingsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Gets the IP access settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, GetIpAccessSettingsCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, GetIpAccessSettingsCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // GetIpAccessSettingsRequest
+ *   ipAccessSettingsArn: "STRING_VALUE", // required
+ * };
+ * const command = new GetIpAccessSettingsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetIpAccessSettingsResponse
+ * //   ipAccessSettings: { // IpAccessSettings
+ * //     ipAccessSettingsArn: "STRING_VALUE", // required
+ * //     associatedPortalArns: [ // ArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ipRules: [ // IpRuleList
+ * //       { // IpRule
+ * //         ipRange: "STRING_VALUE", // required
+ * //         description: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     displayName: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     creationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetIpAccessSettingsCommandInput - {@link GetIpAccessSettingsCommandInput}
+ * @returns {@link GetIpAccessSettingsCommandOutput}
+ * @see {@link GetIpAccessSettingsCommandInput} for command's `input` shape.
+ * @see {@link GetIpAccessSettingsCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ */
+export declare class GetIpAccessSettingsCommand extends $Command<GetIpAccessSettingsCommandInput, GetIpAccessSettingsCommandOutput, WorkSpacesWebClientResolvedConfig> {
+    readonly input: GetIpAccessSettingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetIpAccessSettingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesWebClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIpAccessSettingsCommandInput, GetIpAccessSettingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -51,6 +51,7 @@ export interface GetPortalCommandOutput extends GetPortalResponse, __MetadataBea
  * //     statusReason: "STRING_VALUE",
  * //     userAccessLoggingSettingsArn: "STRING_VALUE",
  * //     authenticationType: "STRING_VALUE",
+ * //     ipAccessSettingsArn: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -0,0 +1,94 @@
+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 { ListIpAccessSettingsRequest, ListIpAccessSettingsResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListIpAccessSettingsCommand}.
+ */
+export interface ListIpAccessSettingsCommandInput extends ListIpAccessSettingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListIpAccessSettingsCommand}.
+ */
+export interface ListIpAccessSettingsCommandOutput extends ListIpAccessSettingsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves a list of IP access settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, ListIpAccessSettingsCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, ListIpAccessSettingsCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // ListIpAccessSettingsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListIpAccessSettingsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListIpAccessSettingsResponse
+ * //   ipAccessSettings: [ // IpAccessSettingsList
+ * //     { // IpAccessSettingsSummary
+ * //       ipAccessSettingsArn: "STRING_VALUE",
+ * //       displayName: "STRING_VALUE",
+ * //       description: "STRING_VALUE",
+ * //       creationDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListIpAccessSettingsCommandInput - {@link ListIpAccessSettingsCommandInput}
+ * @returns {@link ListIpAccessSettingsCommandOutput}
+ * @see {@link ListIpAccessSettingsCommandInput} for command's `input` shape.
+ * @see {@link ListIpAccessSettingsCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ */
+export declare class ListIpAccessSettingsCommand extends $Command<ListIpAccessSettingsCommandInput, ListIpAccessSettingsCommandOutput, WorkSpacesWebClientResolvedConfig> {
+    readonly input: ListIpAccessSettingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListIpAccessSettingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesWebClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListIpAccessSettingsCommandInput, ListIpAccessSettingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -52,6 +52,7 @@ export interface ListPortalsCommandOutput extends ListPortalsResponse, __Metadat
  * //       trustStoreArn: "STRING_VALUE",
  * //       userAccessLoggingSettingsArn: "STRING_VALUE",
  * //       authenticationType: "STRING_VALUE",
+ * //       ipAccessSettingsArn: "STRING_VALUE",
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

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

@@ -0,0 +1,111 @@
+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 { UpdateIpAccessSettingsRequest, UpdateIpAccessSettingsResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateIpAccessSettingsCommand}.
+ */
+export interface UpdateIpAccessSettingsCommandInput extends UpdateIpAccessSettingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateIpAccessSettingsCommand}.
+ */
+export interface UpdateIpAccessSettingsCommandOutput extends UpdateIpAccessSettingsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates IP access settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, UpdateIpAccessSettingsCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, UpdateIpAccessSettingsCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // UpdateIpAccessSettingsRequest
+ *   ipAccessSettingsArn: "STRING_VALUE", // required
+ *   displayName: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   ipRules: [ // IpRuleList
+ *     { // IpRule
+ *       ipRange: "STRING_VALUE", // required
+ *       description: "STRING_VALUE",
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateIpAccessSettingsCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateIpAccessSettingsResponse
+ * //   ipAccessSettings: { // IpAccessSettings
+ * //     ipAccessSettingsArn: "STRING_VALUE", // required
+ * //     associatedPortalArns: [ // ArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ipRules: [ // IpRuleList
+ * //       { // IpRule
+ * //         ipRange: "STRING_VALUE", // required
+ * //         description: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     displayName: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     creationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateIpAccessSettingsCommandInput - {@link UpdateIpAccessSettingsCommandInput}
+ * @returns {@link UpdateIpAccessSettingsCommandOutput}
+ * @see {@link UpdateIpAccessSettingsCommandInput} for command's `input` shape.
+ * @see {@link UpdateIpAccessSettingsCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ */
+export declare class UpdateIpAccessSettingsCommand extends $Command<UpdateIpAccessSettingsCommandInput, UpdateIpAccessSettingsCommandOutput, WorkSpacesWebClientResolvedConfig> {
+    readonly input: UpdateIpAccessSettingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateIpAccessSettingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesWebClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIpAccessSettingsCommandInput, UpdateIpAccessSettingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -53,6 +53,7 @@ export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __Metad
  * //     statusReason: "STRING_VALUE",
  * //     userAccessLoggingSettingsArn: "STRING_VALUE",
  * //     authenticationType: "STRING_VALUE",
+ * //     ipAccessSettingsArn: "STRING_VALUE",
  * //   },
  * // };
  *
@@ -67,6 +68,9 @@ export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __Metad
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>Access is denied.</p>
  *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict.</p>
+ *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is an internal server error.</p>
  *

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

@@ -1,10 +1,12 @@
 export * from "./AssociateBrowserSettingsCommand";
+export * from "./AssociateIpAccessSettingsCommand";
 export * from "./AssociateNetworkSettingsCommand";
 export * from "./AssociateTrustStoreCommand";
 export * from "./AssociateUserAccessLoggingSettingsCommand";
 export * from "./AssociateUserSettingsCommand";
 export * from "./CreateBrowserSettingsCommand";
 export * from "./CreateIdentityProviderCommand";
+export * from "./CreateIpAccessSettingsCommand";
 export * from "./CreateNetworkSettingsCommand";
 export * from "./CreatePortalCommand";
 export * from "./CreateTrustStoreCommand";
@@ -12,18 +14,21 @@ export * from "./CreateUserAccessLoggingSettingsCommand";
 export * from "./CreateUserSettingsCommand";
 export * from "./DeleteBrowserSettingsCommand";
 export * from "./DeleteIdentityProviderCommand";
+export * from "./DeleteIpAccessSettingsCommand";
 export * from "./DeleteNetworkSettingsCommand";
 export * from "./DeletePortalCommand";
 export * from "./DeleteTrustStoreCommand";
 export * from "./DeleteUserAccessLoggingSettingsCommand";
 export * from "./DeleteUserSettingsCommand";
 export * from "./DisassociateBrowserSettingsCommand";
+export * from "./DisassociateIpAccessSettingsCommand";
 export * from "./DisassociateNetworkSettingsCommand";
 export * from "./DisassociateTrustStoreCommand";
 export * from "./DisassociateUserAccessLoggingSettingsCommand";
 export * from "./DisassociateUserSettingsCommand";
 export * from "./GetBrowserSettingsCommand";
 export * from "./GetIdentityProviderCommand";
+export * from "./GetIpAccessSettingsCommand";
 export * from "./GetNetworkSettingsCommand";
 export * from "./GetPortalCommand";
 export * from "./GetPortalServiceProviderMetadataCommand";
@@ -33,6 +38,7 @@ export * from "./GetUserAccessLoggingSettingsCommand";
 export * from "./GetUserSettingsCommand";
 export * from "./ListBrowserSettingsCommand";
 export * from "./ListIdentityProvidersCommand";
+export * from "./ListIpAccessSettingsCommand";
 export * from "./ListNetworkSettingsCommand";
 export * from "./ListPortalsCommand";
 export * from "./ListTagsForResourceCommand";
@@ -44,6 +50,7 @@ export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateBrowserSettingsCommand";
 export * from "./UpdateIdentityProviderCommand";
+export * from "./UpdateIpAccessSettingsCommand";
 export * from "./UpdateNetworkSettingsCommand";
 export * from "./UpdatePortalCommand";
 export * from "./UpdateTrustStoreCommand";

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

@@ -13,7 +13,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;