@aws-sdk/client-transfer 3.839.0 → 3.844.0

package/dist-cjs/index.js

@@ -87,6 +87,7 @@ __export(index_exports, {
   InternalServiceError: () => InternalServiceError,
   InvalidNextTokenException: () => InvalidNextTokenException,
   InvalidRequestException: () => InvalidRequestException,
+  IpAddressType: () => IpAddressType,
   ListAccessesCommand: () => ListAccessesCommand,
   ListAgreementsCommand: () => ListAgreementsCommand,
   ListCertificatesCommand: () => ListCertificatesCommand,
@@ -641,6 +642,10 @@ var IdentityProviderType = {
   AWS_LAMBDA: "AWS_LAMBDA",
   SERVICE_MANAGED: "SERVICE_MANAGED"
 };
+var IpAddressType = {
+  DUALSTACK: "DUALSTACK",
+  IPV4: "IPV4"
+};
 var SetStatOption = {
   DEFAULT: "DEFAULT",
   ENABLE_NO_OP: "ENABLE_NO_OP"
@@ -3807,6 +3812,7 @@ var waitUntilServerOnline = /* @__PURE__ */ __name(async (params, input) => {
   EndpointType,
   SftpAuthenticationMethods,
   IdentityProviderType,
+  IpAddressType,
   SetStatOption,
   TlsSessionResumptionMode,
   Protocol,

package/dist-es/models/models_0.js

@@ -240,6 +240,10 @@ export const IdentityProviderType = {
     AWS_LAMBDA: "AWS_LAMBDA",
     SERVICE_MANAGED: "SERVICE_MANAGED",
 };
+export const IpAddressType = {
+    DUALSTACK: "DUALSTACK",
+    IPV4: "IPV4",
+};
 export const SetStatOption = {
     DEFAULT: "DEFAULT",
     ENABLE_NO_OP: "ENABLE_NO_OP",

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

@@ -101,6 +101,7 @@ declare const CreateServerCommand_base: {
  *   S3StorageOptions: { // S3StorageOptions
  *     DirectoryListingOptimization: "ENABLED" || "DISABLED",
  *   },
+ *   IpAddressType: "IPV4" || "DUALSTACK",
  * };
  * const command = new CreateServerCommand(input);
  * const response = await client.send(command);

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

@@ -114,6 +114,7 @@ declare const DescribeServerCommand_base: {
  * //     As2ServiceManagedEgressIpAddresses: [ // ServiceManagedEgressIpAddresses
  * //       "STRING_VALUE",
  * //     ],
+ * //     IpAddressType: "IPV4" || "DUALSTACK",
  * //   },
  * // };
  *

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

@@ -94,6 +94,7 @@ declare const UpdateServerCommand_base: {
  *   S3StorageOptions: { // S3StorageOptions
  *     DirectoryListingOptimization: "ENABLED" || "DISABLED",
  *   },
+ *   IpAddressType: "IPV4" || "DUALSTACK",
  * };
  * const command = new UpdateServerCommand(input);
  * const response = await client.send(command);

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

@@ -1445,7 +1445,7 @@ export interface PosixProfile {
  */
 export interface CreateAccessRequest {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -1565,7 +1565,7 @@ export type Domain = (typeof Domain)[keyof typeof Domain];
  */
 export interface EndpointDetails {
     /**
-     * <p>A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.</p> <p>An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the <code>allocationId</code> field from the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html">Address</a> data type. One way to retrieve this value is by calling the EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html">DescribeAddresses</a> API.</p> <p>This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint">Create an internet-facing endpoint for your server</a>.</p> <note> <p>This property can only be set as follows:</p> <ul> <li> <p> <code>EndpointType</code> must be set to <code>VPC</code> </p> </li> <li> <p>The Transfer Family server must be offline.</p> </li> <li> <p>You cannot set this parameter for Transfer Family servers that use the FTP protocol.</p> </li> <li> <p>The server must already have <code>SubnetIds</code> populated (<code>SubnetIds</code> and <code>AddressAllocationIds</code> cannot be updated simultaneously).</p> </li> <li> <p> <code>AddressAllocationIds</code> can't contain duplicates, and must be equal in length to <code>SubnetIds</code>. For example, if you have three subnet IDs, you must also specify three address allocation IDs.</p> </li> <li> <p>Call the <code>UpdateServer</code> API to set or change this parameter.</p> </li> </ul> </note>
+     * <p>A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.</p> <p>An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the <code>allocationId</code> field from the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html">Address</a> data type. One way to retrieve this value is by calling the EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html">DescribeAddresses</a> API.</p> <p>This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint">Create an internet-facing endpoint for your server</a>.</p> <note> <p>This property can only be set as follows:</p> <ul> <li> <p> <code>EndpointType</code> must be set to <code>VPC</code> </p> </li> <li> <p>The Transfer Family server must be offline.</p> </li> <li> <p>You cannot set this parameter for Transfer Family servers that use the FTP protocol.</p> </li> <li> <p>The server must already have <code>SubnetIds</code> populated (<code>SubnetIds</code> and <code>AddressAllocationIds</code> cannot be updated simultaneously).</p> </li> <li> <p> <code>AddressAllocationIds</code> can't contain duplicates, and must be equal in length to <code>SubnetIds</code>. For example, if you have three subnet IDs, you must also specify three address allocation IDs.</p> </li> <li> <p>Call the <code>UpdateServer</code> API to set or change this parameter.</p> </li> <li> <p>You can't set address allocation IDs for servers that have an <code>IpAddressType</code> set to <code>DUALSTACK</code> You can only set this property if <code>IpAddressType</code> is set to <code>IPV4</code>.</p> </li> </ul> </note>
      * @public
      */
     AddressAllocationIds?: string[] | undefined;
@@ -1662,6 +1662,18 @@ export declare const IdentityProviderType: {
  * @public
  */
 export type IdentityProviderType = (typeof IdentityProviderType)[keyof typeof IdentityProviderType];
+/**
+ * @public
+ * @enum
+ */
+export declare const IpAddressType: {
+    readonly DUALSTACK: "DUALSTACK";
+    readonly IPV4: "IPV4";
+};
+/**
+ * @public
+ */
+export type IpAddressType = (typeof IpAddressType)[keyof typeof IpAddressType];
 /**
  * @public
  * @enum
@@ -1871,6 +1883,11 @@ export interface CreateServerRequest {
      * @public
      */
     S3StorageOptions?: S3StorageOptions | undefined;
+    /**
+     * <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>
+     * @public
+     */
+    IpAddressType?: IpAddressType | undefined;
 }
 /**
  * @public
@@ -1887,7 +1904,7 @@ export interface CreateServerResponse {
  */
 export interface CreateUserRequest {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -2435,7 +2452,7 @@ export interface DescribeAccessRequest {
  */
 export interface DescribedAccess {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -3010,6 +3027,11 @@ export interface DescribedServer {
      * @public
      */
     As2ServiceManagedEgressIpAddresses?: string[] | undefined;
+    /**
+     * <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>
+     * @public
+     */
+    IpAddressType?: IpAddressType | undefined;
 }
 /**
  * <p>Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by <code>ServerId</code>). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.</p>
@@ -3043,7 +3065,7 @@ export interface DescribedUser {
      */
     Arn: string | undefined;
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -3543,7 +3565,7 @@ export interface ListAccessesRequest {
  */
 export interface ListedAccess {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -3728,7 +3750,7 @@ export interface ListedUser {
      */
     Arn: string | undefined;
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -4289,6 +4311,11 @@ export interface UpdateServerRequest {
      * @public
      */
     S3StorageOptions?: S3StorageOptions | undefined;
+    /**
+     * <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>
+     * @public
+     */
+    IpAddressType?: IpAddressType | undefined;
 }
 /**
  * @public
@@ -4591,7 +4618,7 @@ export interface UntagResourceRequest {
  */
 export interface UpdateAccessRequest {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;
@@ -4686,7 +4713,7 @@ export interface UpdateHostKeyResponse {
  */
 export interface UpdateUserRequest {
     /**
-     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code> is set to <code>PATH</code>.</p> </note>
+     * <p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>
      * @public
      */
     HomeDirectory?: string | undefined;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -513,6 +513,11 @@ export declare const IdentityProviderType: {
 };
 export type IdentityProviderType =
   (typeof IdentityProviderType)[keyof typeof IdentityProviderType];
+export declare const IpAddressType: {
+  readonly DUALSTACK: "DUALSTACK";
+  readonly IPV4: "IPV4";
+};
+export type IpAddressType = (typeof IpAddressType)[keyof typeof IpAddressType];
 export declare const SetStatOption: {
   readonly DEFAULT: "DEFAULT";
   readonly ENABLE_NO_OP: "ENABLE_NO_OP";
@@ -573,6 +578,7 @@ export interface CreateServerRequest {
   WorkflowDetails?: WorkflowDetails | undefined;
   StructuredLogDestinations?: string[] | undefined;
   S3StorageOptions?: S3StorageOptions | undefined;
+  IpAddressType?: IpAddressType | undefined;
 }
 export interface CreateServerResponse {
   ServerId: string | undefined;
@@ -906,6 +912,7 @@ export interface DescribedServer {
   StructuredLogDestinations?: string[] | undefined;
   S3StorageOptions?: S3StorageOptions | undefined;
   As2ServiceManagedEgressIpAddresses?: string[] | undefined;
+  IpAddressType?: IpAddressType | undefined;
 }
 export interface SshPublicKey {
   DateImported: Date | undefined;
@@ -1237,6 +1244,7 @@ export interface UpdateServerRequest {
   WorkflowDetails?: WorkflowDetails | undefined;
   StructuredLogDestinations?: string[] | undefined;
   S3StorageOptions?: S3StorageOptions | undefined;
+  IpAddressType?: IpAddressType | undefined;
 }
 export interface UpdateServerResponse {
   ServerId: string | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-transfer",
   "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
-  "version": "3.839.0",
+  "version": "3.844.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-transfer",
@@ -20,38 +20,38 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.839.0",
-    "@aws-sdk/credential-provider-node": "3.839.0",
-    "@aws-sdk/middleware-host-header": "3.821.0",
-    "@aws-sdk/middleware-logger": "3.821.0",
-    "@aws-sdk/middleware-recursion-detection": "3.821.0",
-    "@aws-sdk/middleware-user-agent": "3.839.0",
-    "@aws-sdk/region-config-resolver": "3.821.0",
-    "@aws-sdk/types": "3.821.0",
-    "@aws-sdk/util-endpoints": "3.828.0",
-    "@aws-sdk/util-user-agent-browser": "3.821.0",
-    "@aws-sdk/util-user-agent-node": "3.839.0",
+    "@aws-sdk/core": "3.844.0",
+    "@aws-sdk/credential-provider-node": "3.844.0",
+    "@aws-sdk/middleware-host-header": "3.840.0",
+    "@aws-sdk/middleware-logger": "3.840.0",
+    "@aws-sdk/middleware-recursion-detection": "3.840.0",
+    "@aws-sdk/middleware-user-agent": "3.844.0",
+    "@aws-sdk/region-config-resolver": "3.840.0",
+    "@aws-sdk/types": "3.840.0",
+    "@aws-sdk/util-endpoints": "3.844.0",
+    "@aws-sdk/util-user-agent-browser": "3.840.0",
+    "@aws-sdk/util-user-agent-node": "3.844.0",
     "@smithy/config-resolver": "^4.1.4",
-    "@smithy/core": "^3.6.0",
-    "@smithy/fetch-http-handler": "^5.0.4",
+    "@smithy/core": "^3.7.0",
+    "@smithy/fetch-http-handler": "^5.1.0",
     "@smithy/hash-node": "^4.0.4",
     "@smithy/invalid-dependency": "^4.0.4",
     "@smithy/middleware-content-length": "^4.0.4",
-    "@smithy/middleware-endpoint": "^4.1.13",
-    "@smithy/middleware-retry": "^4.1.14",
+    "@smithy/middleware-endpoint": "^4.1.14",
+    "@smithy/middleware-retry": "^4.1.15",
     "@smithy/middleware-serde": "^4.0.8",
     "@smithy/middleware-stack": "^4.0.4",
     "@smithy/node-config-provider": "^4.1.3",
-    "@smithy/node-http-handler": "^4.0.6",
+    "@smithy/node-http-handler": "^4.1.0",
     "@smithy/protocol-http": "^5.1.2",
-    "@smithy/smithy-client": "^4.4.5",
+    "@smithy/smithy-client": "^4.4.6",
     "@smithy/types": "^4.3.1",
     "@smithy/url-parser": "^4.0.4",
     "@smithy/util-base64": "^4.0.0",
     "@smithy/util-body-length-browser": "^4.0.0",
     "@smithy/util-body-length-node": "^4.0.0",
-    "@smithy/util-defaults-mode-browser": "^4.0.21",
-    "@smithy/util-defaults-mode-node": "^4.0.21",
+    "@smithy/util-defaults-mode-browser": "^4.0.22",
+    "@smithy/util-defaults-mode-node": "^4.0.22",
     "@smithy/util-endpoints": "^3.0.6",
     "@smithy/util-middleware": "^4.0.4",
     "@smithy/util-retry": "^4.0.6",