@aws-sdk/client-transfer 3.899.0 → 3.901.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,7 +27,7 @@ declare const DescribeCertificateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the certificate that's identified by the <code>CertificateId</code>.</p>
30
+ * <p>Describes the certificate that's identified by the <code>CertificateId</code>.</p> <note> <p>Transfer Family automatically publishes a Amazon CloudWatch metric called <code>DaysUntilExpiry</code> for imported certificates. This metric tracks the number of days until the certificate expires based on the <code>InactiveDate</code>. The metric is available in the <code>AWS/Transfer</code> namespace and includes the <code>CertificateId</code> as a dimension.</p> </note>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const ImportCertificateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.</p> <p>You can import both the certificate and its chain in the <code>Certificate</code> parameter.</p> <note> <p>If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.</p> </note>
30
+ * <p>Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.</p> <p>You can import both the certificate and its chain in the <code>Certificate</code> parameter.</p> <p>After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called <code>DaysUntilExpiry</code> that tracks the number of days until the certificate expires. The metric is based on the <code>InactiveDate</code> parameter and is published daily in the <code>AWS/Transfer</code> namespace.</p> <important> <p>It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account.</p> </important> <note> <p>If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.</p> </note> <p> <b>CloudWatch monitoring</b> </p> <p>The <code>DaysUntilExpiry</code> metric includes the following specifications:</p> <ul> <li> <p> <b>Units:</b> Count (days)</p> </li> <li> <p> <b>Dimensions:</b> <code>CertificateId</code> (always present), <code>Description</code> (if provided during certificate import)</p> </li> <li> <p> <b>Statistics:</b> Minimum, Maximum, Average</p> </li> <li> <p> <b>Frequency:</b> Published daily</p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -97,6 +97,7 @@ declare const UpdateServerCommand_base: {
97
97
  * DirectoryListingOptimization: "ENABLED" || "DISABLED",
98
98
  * },
99
99
  * IpAddressType: "IPV4" || "DUALSTACK",
100
+ * IdentityProviderType: "SERVICE_MANAGED" || "API_GATEWAY" || "AWS_DIRECTORY_SERVICE" || "AWS_LAMBDA",
100
101
  * };
101
102
  * const command = new UpdateServerCommand(input);
102
103
  * const response = await client.send(command);
@@ -1046,7 +1046,7 @@ export interface SftpConnectorConfig {
1046
1046
  */
1047
1047
  TrustedHostKeys?: string[] | undefined;
1048
1048
  /**
1049
- * <p>Specify the number of concurrent connections that your connector creates to the remote server. The default value is <code>5</code> (this is also the maximum value allowed).</p> <p>This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.</p>
1049
+ * <p>Specify the number of concurrent connections that your connector creates to the remote server. The default value is <code>1</code>. The maximum values is <code>5</code>.</p> <note> <p>If you are using the Amazon Web Services Management Console, the default value is <code>5</code>.</p> </note> <p>This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.</p>
1050
1050
  * @public
1051
1051
  */
1052
1052
  MaxConcurrentConnections?: number | undefined;
@@ -1585,7 +1585,7 @@ export interface EndpointDetails {
1585
1585
  */
1586
1586
  VpcId?: string | undefined;
1587
1587
  /**
1588
- * <p>A list of security groups IDs that are available to attach to your server's endpoint.</p> <note> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>.</p> <p>You can edit the <code>SecurityGroupIds</code> property in the <a href="https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html">UpdateServer</a> API only if you are changing the <code>EndpointType</code> from <code>PUBLIC</code> or <code>VPC_ENDPOINT</code> to <code>VPC</code>. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html">ModifyVpcEndpoint</a> API.</p> </note>
1588
+ * <p>A list of security groups IDs that are available to attach to your server's endpoint.</p> <note> <p>While <code>SecurityGroupIds</code> appears in the response syntax for consistency with <code>CreateServer</code> and <code>UpdateServer</code> operations, this field is not populated in <code>DescribeServer</code> responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 <code>DescribeVpcEndpoints</code> API with the <code>VpcEndpointId</code> returned in the response.</p> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>.</p> <p>You can edit the <code>SecurityGroupIds</code> property in the <a href="https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html">UpdateServer</a> API only if you are changing the <code>EndpointType</code> from <code>PUBLIC</code> or <code>VPC_ENDPOINT</code> to <code>VPC</code>. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html">ModifyVpcEndpoint</a> API.</p> </note>
1589
1589
  * @public
1590
1590
  */
1591
1591
  SecurityGroupIds?: string[] | undefined;
@@ -1757,7 +1757,7 @@ export type DirectoryListingOptimization = (typeof DirectoryListingOptimization)
1757
1757
  */
1758
1758
  export interface S3StorageOptions {
1759
1759
  /**
1760
- * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
1760
+ * <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
1761
1761
  * @public
1762
1762
  */
1763
1763
  DirectoryListingOptimization?: DirectoryListingOptimization | undefined;
@@ -1879,7 +1879,7 @@ export interface CreateServerRequest {
1879
1879
  */
1880
1880
  StructuredLogDestinations?: string[] | undefined;
1881
1881
  /**
1882
- * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
1882
+ * <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
1883
1883
  * @public
1884
1884
  */
1885
1885
  S3StorageOptions?: S3StorageOptions | undefined;
@@ -3018,7 +3018,7 @@ export interface DescribedServer {
3018
3018
  */
3019
3019
  StructuredLogDestinations?: string[] | undefined;
3020
3020
  /**
3021
- * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
3021
+ * <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
3022
3022
  * @public
3023
3023
  */
3024
3024
  S3StorageOptions?: S3StorageOptions | undefined;
@@ -4307,7 +4307,7 @@ export interface UpdateServerRequest {
4307
4307
  */
4308
4308
  StructuredLogDestinations?: string[] | undefined;
4309
4309
  /**
4310
- * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
4310
+ * <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
4311
4311
  * @public
4312
4312
  */
4313
4313
  S3StorageOptions?: S3StorageOptions | undefined;
@@ -4316,6 +4316,11 @@ export interface UpdateServerRequest {
4316
4316
  * @public
4317
4317
  */
4318
4318
  IpAddressType?: IpAddressType | undefined;
4319
+ /**
4320
+ * <p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>
4321
+ * @public
4322
+ */
4323
+ IdentityProviderType?: IdentityProviderType | undefined;
4319
4324
  }
4320
4325
  /**
4321
4326
  * @public
@@ -1245,6 +1245,7 @@ export interface UpdateServerRequest {
1245
1245
  StructuredLogDestinations?: string[] | undefined;
1246
1246
  S3StorageOptions?: S3StorageOptions | undefined;
1247
1247
  IpAddressType?: IpAddressType | undefined;
1248
+ IdentityProviderType?: IdentityProviderType | undefined;
1248
1249
  }
1249
1250
  export interface UpdateServerResponse {
1250
1251
  ServerId: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transfer",
3
3
  "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
4
- "version": "3.899.0",
4
+ "version": "3.901.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-transfer",
@@ -20,43 +20,43 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.899.0",
24
- "@aws-sdk/credential-provider-node": "3.899.0",
25
- "@aws-sdk/middleware-host-header": "3.893.0",
26
- "@aws-sdk/middleware-logger": "3.893.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.893.0",
28
- "@aws-sdk/middleware-user-agent": "3.899.0",
29
- "@aws-sdk/region-config-resolver": "3.893.0",
30
- "@aws-sdk/types": "3.893.0",
31
- "@aws-sdk/util-endpoints": "3.895.0",
32
- "@aws-sdk/util-user-agent-browser": "3.893.0",
33
- "@aws-sdk/util-user-agent-node": "3.899.0",
34
- "@smithy/config-resolver": "^4.2.2",
35
- "@smithy/core": "^3.13.0",
36
- "@smithy/fetch-http-handler": "^5.2.1",
37
- "@smithy/hash-node": "^4.1.1",
38
- "@smithy/invalid-dependency": "^4.1.1",
39
- "@smithy/middleware-content-length": "^4.1.1",
40
- "@smithy/middleware-endpoint": "^4.2.5",
41
- "@smithy/middleware-retry": "^4.3.1",
42
- "@smithy/middleware-serde": "^4.1.1",
43
- "@smithy/middleware-stack": "^4.1.1",
44
- "@smithy/node-config-provider": "^4.2.2",
45
- "@smithy/node-http-handler": "^4.2.1",
46
- "@smithy/protocol-http": "^5.2.1",
47
- "@smithy/smithy-client": "^4.6.5",
48
- "@smithy/types": "^4.5.0",
49
- "@smithy/url-parser": "^4.1.1",
50
- "@smithy/util-base64": "^4.1.0",
51
- "@smithy/util-body-length-browser": "^4.1.0",
52
- "@smithy/util-body-length-node": "^4.1.0",
53
- "@smithy/util-defaults-mode-browser": "^4.1.5",
54
- "@smithy/util-defaults-mode-node": "^4.1.5",
55
- "@smithy/util-endpoints": "^3.1.2",
56
- "@smithy/util-middleware": "^4.1.1",
57
- "@smithy/util-retry": "^4.1.2",
58
- "@smithy/util-utf8": "^4.1.0",
59
- "@smithy/util-waiter": "^4.1.1",
23
+ "@aws-sdk/core": "3.901.0",
24
+ "@aws-sdk/credential-provider-node": "3.901.0",
25
+ "@aws-sdk/middleware-host-header": "3.901.0",
26
+ "@aws-sdk/middleware-logger": "3.901.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.901.0",
28
+ "@aws-sdk/middleware-user-agent": "3.901.0",
29
+ "@aws-sdk/region-config-resolver": "3.901.0",
30
+ "@aws-sdk/types": "3.901.0",
31
+ "@aws-sdk/util-endpoints": "3.901.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.901.0",
33
+ "@aws-sdk/util-user-agent-node": "3.901.0",
34
+ "@smithy/config-resolver": "^4.3.0",
35
+ "@smithy/core": "^3.14.0",
36
+ "@smithy/fetch-http-handler": "^5.3.0",
37
+ "@smithy/hash-node": "^4.2.0",
38
+ "@smithy/invalid-dependency": "^4.2.0",
39
+ "@smithy/middleware-content-length": "^4.2.0",
40
+ "@smithy/middleware-endpoint": "^4.3.0",
41
+ "@smithy/middleware-retry": "^4.4.0",
42
+ "@smithy/middleware-serde": "^4.2.0",
43
+ "@smithy/middleware-stack": "^4.2.0",
44
+ "@smithy/node-config-provider": "^4.3.0",
45
+ "@smithy/node-http-handler": "^4.3.0",
46
+ "@smithy/protocol-http": "^5.3.0",
47
+ "@smithy/smithy-client": "^4.7.0",
48
+ "@smithy/types": "^4.6.0",
49
+ "@smithy/url-parser": "^4.2.0",
50
+ "@smithy/util-base64": "^4.2.0",
51
+ "@smithy/util-body-length-browser": "^4.2.0",
52
+ "@smithy/util-body-length-node": "^4.2.0",
53
+ "@smithy/util-defaults-mode-browser": "^4.2.0",
54
+ "@smithy/util-defaults-mode-node": "^4.2.0",
55
+ "@smithy/util-endpoints": "^3.2.0",
56
+ "@smithy/util-middleware": "^4.2.0",
57
+ "@smithy/util-retry": "^4.2.0",
58
+ "@smithy/util-utf8": "^4.2.0",
59
+ "@smithy/util-waiter": "^4.2.0",
60
60
  "tslib": "^2.6.2"
61
61
  },
62
62
  "devDependencies": {