@aws-sdk/client-transfer 3.696.0 → 3.703.0

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

@@ -0,0 +1,93 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DescribeWebAppCustomizationRequest, DescribeWebAppCustomizationResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeWebAppCustomizationCommand}.
+ */
+export interface DescribeWebAppCustomizationCommandInput extends DescribeWebAppCustomizationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeWebAppCustomizationCommand}.
+ */
+export interface DescribeWebAppCustomizationCommandOutput extends DescribeWebAppCustomizationResponse, __MetadataBearer {
+}
+declare const DescribeWebAppCustomizationCommand_base: {
+    new (input: DescribeWebAppCustomizationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeWebAppCustomizationCommandInput, DescribeWebAppCustomizationCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DescribeWebAppCustomizationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeWebAppCustomizationCommandInput, DescribeWebAppCustomizationCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Describes the web app customization object that's identified by <code>WebAppId</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, DescribeWebAppCustomizationCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, DescribeWebAppCustomizationCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // DescribeWebAppCustomizationRequest
+ *   WebAppId: "STRING_VALUE", // required
+ * };
+ * const command = new DescribeWebAppCustomizationCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeWebAppCustomizationResponse
+ * //   WebAppCustomization: { // DescribedWebAppCustomization
+ * //     Arn: "STRING_VALUE", // required
+ * //     WebAppId: "STRING_VALUE", // required
+ * //     Title: "STRING_VALUE",
+ * //     LogoFile: new Uint8Array(),
+ * //     FaviconFile: new Uint8Array(),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeWebAppCustomizationCommandInput - {@link DescribeWebAppCustomizationCommandInput}
+ * @returns {@link DescribeWebAppCustomizationCommandOutput}
+ * @see {@link DescribeWebAppCustomizationCommandInput} for command's `input` shape.
+ * @see {@link DescribeWebAppCustomizationCommandOutput} for command's `response` shape.
+ * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>This exception is thrown when the client submits a malformed request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
+ *       service.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ * @public
+ */
+export declare class DescribeWebAppCustomizationCommand extends DescribeWebAppCustomizationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeWebAppCustomizationRequest;
+            output: DescribeWebAppCustomizationResponse;
+        };
+        sdk: {
+            input: DescribeWebAppCustomizationCommandInput;
+            output: DescribeWebAppCustomizationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListWebAppsRequest, ListWebAppsResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListWebAppsCommand}.
+ */
+export interface ListWebAppsCommandInput extends ListWebAppsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListWebAppsCommand}.
+ */
+export interface ListWebAppsCommandOutput extends ListWebAppsResponse, __MetadataBearer {
+}
+declare const ListWebAppsCommand_base: {
+    new (input: ListWebAppsCommandInput): import("@smithy/smithy-client").CommandImpl<ListWebAppsCommandInput, ListWebAppsCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListWebAppsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListWebAppsCommandInput, ListWebAppsCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all web apps associated with your Amazon Web Services account for your current region.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, ListWebAppsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, ListWebAppsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // ListWebAppsRequest
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListWebAppsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListWebAppsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   WebApps: [ // ListedWebApps // required
+ * //     { // ListedWebApp
+ * //       Arn: "STRING_VALUE", // required
+ * //       WebAppId: "STRING_VALUE", // required
+ * //       AccessEndpoint: "STRING_VALUE",
+ * //       WebAppEndpoint: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListWebAppsCommandInput - {@link ListWebAppsCommandInput}
+ * @returns {@link ListWebAppsCommandOutput}
+ * @see {@link ListWebAppsCommandInput} for command's `input` shape.
+ * @see {@link ListWebAppsCommandOutput} for command's `response` shape.
+ * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
+ *
+ * @throws {@link InvalidNextTokenException} (client fault)
+ *  <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>This exception is thrown when the client submits a malformed request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ * @public
+ */
+export declare class ListWebAppsCommand extends ListWebAppsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListWebAppsRequest;
+            output: ListWebAppsResponse;
+        };
+        sdk: {
+            input: ListWebAppsCommandInput;
+            output: ListWebAppsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateWebAppRequest, UpdateWebAppResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateWebAppCommand}.
+ */
+export interface UpdateWebAppCommandInput extends UpdateWebAppRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateWebAppCommand}.
+ */
+export interface UpdateWebAppCommandOutput extends UpdateWebAppResponse, __MetadataBearer {
+}
+declare const UpdateWebAppCommand_base: {
+    new (input: UpdateWebAppCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWebAppCommandInput, UpdateWebAppCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateWebAppCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWebAppCommandInput, UpdateWebAppCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, UpdateWebAppCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, UpdateWebAppCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // UpdateWebAppRequest
+ *   WebAppId: "STRING_VALUE", // required
+ *   IdentityProviderDetails: { // UpdateWebAppIdentityProviderDetails Union: only one key present
+ *     IdentityCenterConfig: { // UpdateWebAppIdentityCenterConfig
+ *       Role: "STRING_VALUE",
+ *     },
+ *   },
+ *   AccessEndpoint: "STRING_VALUE",
+ *   WebAppUnits: { // WebAppUnits Union: only one key present
+ *     Provisioned: Number("int"),
+ *   },
+ * };
+ * const command = new UpdateWebAppCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateWebAppResponse
+ * //   WebAppId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateWebAppCommandInput - {@link UpdateWebAppCommandInput}
+ * @returns {@link UpdateWebAppCommandOutput}
+ * @see {@link UpdateWebAppCommandInput} for command's `input` shape.
+ * @see {@link UpdateWebAppCommandOutput} for command's `response` shape.
+ * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
+ *       protocol-enabled server that has VPC as the endpoint type and the server's
+ *         <code>VpcEndpointID</code> is not in the available state.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>This exception is thrown when the client submits a malformed request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
+ *       service.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ * @public
+ */
+export declare class UpdateWebAppCommand extends UpdateWebAppCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateWebAppRequest;
+            output: UpdateWebAppResponse;
+        };
+        sdk: {
+            input: UpdateWebAppCommandInput;
+            output: UpdateWebAppCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,95 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateWebAppCustomizationRequest, UpdateWebAppCustomizationResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateWebAppCustomizationCommand}.
+ */
+export interface UpdateWebAppCustomizationCommandInput extends UpdateWebAppCustomizationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateWebAppCustomizationCommand}.
+ */
+export interface UpdateWebAppCustomizationCommandOutput extends UpdateWebAppCustomizationResponse, __MetadataBearer {
+}
+declare const UpdateWebAppCustomizationCommand_base: {
+    new (input: UpdateWebAppCustomizationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWebAppCustomizationCommandInput, UpdateWebAppCustomizationCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateWebAppCustomizationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWebAppCustomizationCommandInput, UpdateWebAppCustomizationCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, UpdateWebAppCustomizationCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, UpdateWebAppCustomizationCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // UpdateWebAppCustomizationRequest
+ *   WebAppId: "STRING_VALUE", // required
+ *   Title: "STRING_VALUE",
+ *   LogoFile: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *   FaviconFile: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ * };
+ * const command = new UpdateWebAppCustomizationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateWebAppCustomizationResponse
+ * //   WebAppId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateWebAppCustomizationCommandInput - {@link UpdateWebAppCustomizationCommandInput}
+ * @returns {@link UpdateWebAppCustomizationCommandOutput}
+ * @see {@link UpdateWebAppCustomizationCommandInput} for command's `input` shape.
+ * @see {@link UpdateWebAppCustomizationCommandOutput} for command's `response` shape.
+ * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
+ *       protocol-enabled server that has VPC as the endpoint type and the server's
+ *         <code>VpcEndpointID</code> is not in the available state.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>This exception is thrown when the client submits a malformed request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
+ *       service.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ * @public
+ */
+export declare class UpdateWebAppCustomizationCommand extends UpdateWebAppCustomizationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateWebAppCustomizationRequest;
+            output: UpdateWebAppCustomizationResponse;
+        };
+        sdk: {
+            input: UpdateWebAppCustomizationCommandInput;
+            output: UpdateWebAppCustomizationCommandOutput;
+        };
+    };
+}

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

@@ -4,6 +4,7 @@ export * from "./CreateConnectorCommand";
 export * from "./CreateProfileCommand";
 export * from "./CreateServerCommand";
 export * from "./CreateUserCommand";
+export * from "./CreateWebAppCommand";
 export * from "./CreateWorkflowCommand";
 export * from "./DeleteAccessCommand";
 export * from "./DeleteAgreementCommand";
@@ -14,6 +15,8 @@ export * from "./DeleteProfileCommand";
 export * from "./DeleteServerCommand";
 export * from "./DeleteSshPublicKeyCommand";
 export * from "./DeleteUserCommand";
+export * from "./DeleteWebAppCommand";
+export * from "./DeleteWebAppCustomizationCommand";
 export * from "./DeleteWorkflowCommand";
 export * from "./DescribeAccessCommand";
 export * from "./DescribeAgreementCommand";
@@ -25,6 +28,8 @@ export * from "./DescribeProfileCommand";
 export * from "./DescribeSecurityPolicyCommand";
 export * from "./DescribeServerCommand";
 export * from "./DescribeUserCommand";
+export * from "./DescribeWebAppCommand";
+export * from "./DescribeWebAppCustomizationCommand";
 export * from "./DescribeWorkflowCommand";
 export * from "./ImportCertificateCommand";
 export * from "./ImportHostKeyCommand";
@@ -41,6 +46,7 @@ export * from "./ListSecurityPoliciesCommand";
 export * from "./ListServersCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListUsersCommand";
+export * from "./ListWebAppsCommand";
 export * from "./ListWorkflowsCommand";
 export * from "./SendWorkflowStepStateCommand";
 export * from "./StartDirectoryListingCommand";
@@ -59,3 +65,5 @@ export * from "./UpdateHostKeyCommand";
 export * from "./UpdateProfileCommand";
 export * from "./UpdateServerCommand";
 export * from "./UpdateUserCommand";
+export * from "./UpdateWebAppCommand";
+export * from "./UpdateWebAppCustomizationCommand";