Before you begin, make sure that you understand how DataSync * accesses * NFS file servers.
- *If you're copying data to or from an Snowcone device, you can also use
- * CreateLocationNfs to create your transfer location. For more information, see
- * Configuring transfers with Snowcone.
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
+ *Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with Azure Blob Storage.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-datasync/src/commands/UpdateLocationEfsCommand.ts b/clients/client-datasync/src/commands/UpdateLocationEfsCommand.ts new file mode 100644 index 0000000000000..1220473ce8a6b --- /dev/null +++ b/clients/client-datasync/src/commands/UpdateLocationEfsCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateLocationEfsRequest, UpdateLocationEfsResponse } from "../models/models_0"; +import { de_UpdateLocationEfsCommand, se_UpdateLocationEfsCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateLocationEfsCommand}. + */ +export interface UpdateLocationEfsCommandInput extends UpdateLocationEfsRequest {} +/** + * @public + * + * The output of {@link UpdateLocationEfsCommand}. + */ +export interface UpdateLocationEfsCommandOutput extends UpdateLocationEfsResponse, __MetadataBearer {} + +/** + *Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with Amazon EFS.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const input = { // UpdateLocationEfsRequest + * LocationArn: "STRING_VALUE", // required + * Subdirectory: "STRING_VALUE", + * AccessPointArn: "STRING_VALUE", + * FileSystemAccessRoleArn: "STRING_VALUE", + * InTransitEncryption: "NONE" || "TLS1_2", + * }; + * const command = new UpdateLocationEfsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateLocationEfsCommandInput - {@link UpdateLocationEfsCommandInput} + * @returns {@link UpdateLocationEfsCommandOutput} + * @see {@link UpdateLocationEfsCommandInput} for command's `input` shape. + * @see {@link UpdateLocationEfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape. + * + * @throws {@link InternalException} (server fault) + *This exception is thrown when an error occurs in the DataSync + * service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *This exception is thrown when the client submits a malformed request.
+ * + * @throws {@link DataSyncServiceException} + *Base exception class for all service exceptions from DataSync service.
+ * + * @public + */ +export class UpdateLocationEfsCommand extends $Command + .classBuilder< + UpdateLocationEfsCommandInput, + UpdateLocationEfsCommandOutput, + DataSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("FmrsService", "UpdateLocationEfs", {}) + .n("DataSyncClient", "UpdateLocationEfsCommand") + .f(void 0, void 0) + .ser(se_UpdateLocationEfsCommand) + .de(de_UpdateLocationEfsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateLocationEfsRequest; + output: {}; + }; + sdk: { + input: UpdateLocationEfsCommandInput; + output: UpdateLocationEfsCommandOutput; + }; + }; +} diff --git a/clients/client-datasync/src/commands/UpdateLocationFsxLustreCommand.ts b/clients/client-datasync/src/commands/UpdateLocationFsxLustreCommand.ts new file mode 100644 index 0000000000000..8f9ca7e930ebf --- /dev/null +++ b/clients/client-datasync/src/commands/UpdateLocationFsxLustreCommand.ts @@ -0,0 +1,99 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateLocationFsxLustreRequest, UpdateLocationFsxLustreResponse } from "../models/models_0"; +import { de_UpdateLocationFsxLustreCommand, se_UpdateLocationFsxLustreCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateLocationFsxLustreCommand}. + */ +export interface UpdateLocationFsxLustreCommandInput extends UpdateLocationFsxLustreRequest {} +/** + * @public + * + * The output of {@link UpdateLocationFsxLustreCommand}. + */ +export interface UpdateLocationFsxLustreCommandOutput extends UpdateLocationFsxLustreResponse, __MetadataBearer {} + +/** + *Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with FSx for Lustre.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationFsxLustreCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationFsxLustreCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const input = { // UpdateLocationFsxLustreRequest + * LocationArn: "STRING_VALUE", // required + * Subdirectory: "STRING_VALUE", + * }; + * const command = new UpdateLocationFsxLustreCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateLocationFsxLustreCommandInput - {@link UpdateLocationFsxLustreCommandInput} + * @returns {@link UpdateLocationFsxLustreCommandOutput} + * @see {@link UpdateLocationFsxLustreCommandInput} for command's `input` shape. + * @see {@link UpdateLocationFsxLustreCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape. + * + * @throws {@link InternalException} (server fault) + *This exception is thrown when an error occurs in the DataSync + * service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *This exception is thrown when the client submits a malformed request.
+ * + * @throws {@link DataSyncServiceException} + *Base exception class for all service exceptions from DataSync service.
+ * + * @public + */ +export class UpdateLocationFsxLustreCommand extends $Command + .classBuilder< + UpdateLocationFsxLustreCommandInput, + UpdateLocationFsxLustreCommandOutput, + DataSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("FmrsService", "UpdateLocationFsxLustre", {}) + .n("DataSyncClient", "UpdateLocationFsxLustreCommand") + .f(void 0, void 0) + .ser(se_UpdateLocationFsxLustreCommand) + .de(de_UpdateLocationFsxLustreCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateLocationFsxLustreRequest; + output: {}; + }; + sdk: { + input: UpdateLocationFsxLustreCommandInput; + output: UpdateLocationFsxLustreCommandOutput; + }; + }; +} diff --git a/clients/client-datasync/src/commands/UpdateLocationFsxOntapCommand.ts b/clients/client-datasync/src/commands/UpdateLocationFsxOntapCommand.ts new file mode 100644 index 0000000000000..8fe61fcc1c242 --- /dev/null +++ b/clients/client-datasync/src/commands/UpdateLocationFsxOntapCommand.ts @@ -0,0 +1,118 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + UpdateLocationFsxOntapRequest, + UpdateLocationFsxOntapRequestFilterSensitiveLog, + UpdateLocationFsxOntapResponse, +} from "../models/models_0"; +import { de_UpdateLocationFsxOntapCommand, se_UpdateLocationFsxOntapCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateLocationFsxOntapCommand}. + */ +export interface UpdateLocationFsxOntapCommandInput extends UpdateLocationFsxOntapRequest {} +/** + * @public + * + * The output of {@link UpdateLocationFsxOntapCommand}. + */ +export interface UpdateLocationFsxOntapCommandOutput extends UpdateLocationFsxOntapResponse, __MetadataBearer {} + +/** + *Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with FSx for ONTAP.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationFsxOntapCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationFsxOntapCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const input = { // UpdateLocationFsxOntapRequest + * LocationArn: "STRING_VALUE", // required + * Protocol: { // FsxUpdateProtocol + * NFS: { // FsxProtocolNfs + * MountOptions: { // NfsMountOptions + * Version: "AUTOMATIC" || "NFS3" || "NFS4_0" || "NFS4_1", + * }, + * }, + * SMB: { // FsxUpdateProtocolSmb + * Domain: "STRING_VALUE", + * MountOptions: { // SmbMountOptions + * Version: "AUTOMATIC" || "SMB2" || "SMB3" || "SMB1" || "SMB2_0", + * }, + * Password: "STRING_VALUE", + * User: "STRING_VALUE", + * }, + * }, + * Subdirectory: "STRING_VALUE", + * }; + * const command = new UpdateLocationFsxOntapCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateLocationFsxOntapCommandInput - {@link UpdateLocationFsxOntapCommandInput} + * @returns {@link UpdateLocationFsxOntapCommandOutput} + * @see {@link UpdateLocationFsxOntapCommandInput} for command's `input` shape. + * @see {@link UpdateLocationFsxOntapCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape. + * + * @throws {@link InternalException} (server fault) + *This exception is thrown when an error occurs in the DataSync + * service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *This exception is thrown when the client submits a malformed request.
+ * + * @throws {@link DataSyncServiceException} + *Base exception class for all service exceptions from DataSync service.
+ * + * @public + */ +export class UpdateLocationFsxOntapCommand extends $Command + .classBuilder< + UpdateLocationFsxOntapCommandInput, + UpdateLocationFsxOntapCommandOutput, + DataSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("FmrsService", "UpdateLocationFsxOntap", {}) + .n("DataSyncClient", "UpdateLocationFsxOntapCommand") + .f(UpdateLocationFsxOntapRequestFilterSensitiveLog, void 0) + .ser(se_UpdateLocationFsxOntapCommand) + .de(de_UpdateLocationFsxOntapCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateLocationFsxOntapRequest; + output: {}; + }; + sdk: { + input: UpdateLocationFsxOntapCommandInput; + output: UpdateLocationFsxOntapCommandOutput; + }; + }; +} diff --git a/clients/client-datasync/src/commands/UpdateLocationFsxOpenZfsCommand.ts b/clients/client-datasync/src/commands/UpdateLocationFsxOpenZfsCommand.ts new file mode 100644 index 0000000000000..e120679fe7ca7 --- /dev/null +++ b/clients/client-datasync/src/commands/UpdateLocationFsxOpenZfsCommand.ts @@ -0,0 +1,122 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + UpdateLocationFsxOpenZfsRequest, + UpdateLocationFsxOpenZfsRequestFilterSensitiveLog, + UpdateLocationFsxOpenZfsResponse, +} from "../models/models_0"; +import { de_UpdateLocationFsxOpenZfsCommand, se_UpdateLocationFsxOpenZfsCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateLocationFsxOpenZfsCommand}. + */ +export interface UpdateLocationFsxOpenZfsCommandInput extends UpdateLocationFsxOpenZfsRequest {} +/** + * @public + * + * The output of {@link UpdateLocationFsxOpenZfsCommand}. + */ +export interface UpdateLocationFsxOpenZfsCommandOutput extends UpdateLocationFsxOpenZfsResponse, __MetadataBearer {} + +/** + *Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with FSx for OpenZFS.
+ *Request parameters related to SMB aren't supported with the
+ * UpdateLocationFsxOpenZfs operation.
This exception is thrown when an error occurs in the DataSync + * service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *This exception is thrown when the client submits a malformed request.
+ * + * @throws {@link DataSyncServiceException} + *Base exception class for all service exceptions from DataSync service.
+ * + * @public + */ +export class UpdateLocationFsxOpenZfsCommand extends $Command + .classBuilder< + UpdateLocationFsxOpenZfsCommandInput, + UpdateLocationFsxOpenZfsCommandOutput, + DataSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("FmrsService", "UpdateLocationFsxOpenZfs", {}) + .n("DataSyncClient", "UpdateLocationFsxOpenZfsCommand") + .f(UpdateLocationFsxOpenZfsRequestFilterSensitiveLog, void 0) + .ser(se_UpdateLocationFsxOpenZfsCommand) + .de(de_UpdateLocationFsxOpenZfsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateLocationFsxOpenZfsRequest; + output: {}; + }; + sdk: { + input: UpdateLocationFsxOpenZfsCommandInput; + output: UpdateLocationFsxOpenZfsCommandOutput; + }; + }; +} diff --git a/clients/client-datasync/src/commands/UpdateLocationFsxWindowsCommand.ts b/clients/client-datasync/src/commands/UpdateLocationFsxWindowsCommand.ts new file mode 100644 index 0000000000000..ed88fa9f9f327 --- /dev/null +++ b/clients/client-datasync/src/commands/UpdateLocationFsxWindowsCommand.ts @@ -0,0 +1,106 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + UpdateLocationFsxWindowsRequest, + UpdateLocationFsxWindowsRequestFilterSensitiveLog, + UpdateLocationFsxWindowsResponse, +} from "../models/models_0"; +import { de_UpdateLocationFsxWindowsCommand, se_UpdateLocationFsxWindowsCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateLocationFsxWindowsCommand}. + */ +export interface UpdateLocationFsxWindowsCommandInput extends UpdateLocationFsxWindowsRequest {} +/** + * @public + * + * The output of {@link UpdateLocationFsxWindowsCommand}. + */ +export interface UpdateLocationFsxWindowsCommandOutput extends UpdateLocationFsxWindowsResponse, __MetadataBearer {} + +/** + *Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with FSx for Windows File Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationFsxWindowsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationFsxWindowsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const input = { // UpdateLocationFsxWindowsRequest + * LocationArn: "STRING_VALUE", // required + * Subdirectory: "STRING_VALUE", + * Domain: "STRING_VALUE", + * User: "STRING_VALUE", + * Password: "STRING_VALUE", + * }; + * const command = new UpdateLocationFsxWindowsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateLocationFsxWindowsCommandInput - {@link UpdateLocationFsxWindowsCommandInput} + * @returns {@link UpdateLocationFsxWindowsCommandOutput} + * @see {@link UpdateLocationFsxWindowsCommandInput} for command's `input` shape. + * @see {@link UpdateLocationFsxWindowsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape. + * + * @throws {@link InternalException} (server fault) + *This exception is thrown when an error occurs in the DataSync + * service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *This exception is thrown when the client submits a malformed request.
+ * + * @throws {@link DataSyncServiceException} + *Base exception class for all service exceptions from DataSync service.
+ * + * @public + */ +export class UpdateLocationFsxWindowsCommand extends $Command + .classBuilder< + UpdateLocationFsxWindowsCommandInput, + UpdateLocationFsxWindowsCommandOutput, + DataSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("FmrsService", "UpdateLocationFsxWindows", {}) + .n("DataSyncClient", "UpdateLocationFsxWindowsCommand") + .f(UpdateLocationFsxWindowsRequestFilterSensitiveLog, void 0) + .ser(se_UpdateLocationFsxWindowsCommand) + .de(de_UpdateLocationFsxWindowsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateLocationFsxWindowsRequest; + output: {}; + }; + sdk: { + input: UpdateLocationFsxWindowsCommandInput; + output: UpdateLocationFsxWindowsCommandOutput; + }; + }; +} diff --git a/clients/client-datasync/src/commands/UpdateLocationHdfsCommand.ts b/clients/client-datasync/src/commands/UpdateLocationHdfsCommand.ts index 99dd3c191a3f3..c0754f93c56fd 100644 --- a/clients/client-datasync/src/commands/UpdateLocationHdfsCommand.ts +++ b/clients/client-datasync/src/commands/UpdateLocationHdfsCommand.ts @@ -28,8 +28,9 @@ export interface UpdateLocationHdfsCommandInput extends UpdateLocationHdfsReques export interface UpdateLocationHdfsCommandOutput extends UpdateLocationHdfsResponse, __MetadataBearer {} /** - *Updates some parameters of a previously created location for a Hadoop Distributed File - * System cluster.
+ *Modifies the following configuration parameters of the Hadoop Distributed File + * System (HDFS) transfer location that you're using with DataSync.
+ *For more information, see Configuring DataSync transfers with an HDFS cluster.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-datasync/src/commands/UpdateLocationNfsCommand.ts b/clients/client-datasync/src/commands/UpdateLocationNfsCommand.ts index f8a2c087bdf57..6ca1aed96b39d 100644 --- a/clients/client-datasync/src/commands/UpdateLocationNfsCommand.ts +++ b/clients/client-datasync/src/commands/UpdateLocationNfsCommand.ts @@ -28,9 +28,8 @@ export interface UpdateLocationNfsCommandInput extends UpdateLocationNfsRequest export interface UpdateLocationNfsCommandOutput extends UpdateLocationNfsResponse, __MetadataBearer {} /** - *Modifies some configurations of the Network File System (NFS) transfer location that - * you're using with DataSync.
- *For more information, see Configuring transfers to or from an
+ * Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see Configuring transfers with an
* NFS file server. Updates some parameters of an existing DataSync location for an object
- * storage system. Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an object storage system. Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync. Before you begin, make sure that you read the following topics:
+ * Storage
+ * class considerations with Amazon S3 locations
+ * This exception is thrown when an error occurs in the DataSync
+ * service. This exception is thrown when the client submits a malformed request. Base exception class for all service exceptions from DataSync service. Updates some of the parameters of a Server Message Block
- * (SMB) file server location that you can use for DataSync transfers. Modifies the following configuration parameters of the Server Message Block
+ * (SMB) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an SMB file server. Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location)
- * on your file system. Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location). By default, DataSync uses the root directory (or access point if you provide one by using
* The Amazon Resource Name (ARN) for the FSx for Lustre file system. Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system. The Amazon Resource Names (ARNs) of the security groups that are used to configure the
+ * Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide access to your
* FSx for Lustre file system. The security groups must be able to access the file system's ports. The file system must
+ * also allow access from the security groups. For information about file system access, see the
+ *
+ * Amazon FSx for Lustre User Guide
+ * . A subdirectory in the location's path. This subdirectory in the FSx for Lustre
- * file system is used to read data from the FSx for Lustre source location or write
- * data to the FSx for Lustre destination. Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories. When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( The key-value pair that represents a tag that you want to add to the resource. The value
- * can be an empty string. This value helps you manage, filter, and search for your resources. We
- * recommend that you create a name tag for your location. Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location. The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's
- * created. The Amazon Resource Name (ARN) of the FSx for Lustre file system location that
+ * you created. Specifies the Network File System (NFS) protocol configuration that DataSync
- * uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file
- * system.
+ *
+ * AccessPointArn). You can also include subdirectories using forward slashes (for
* example, /path/to/folder)./).
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see - * Accessing FSx for ONTAP file systems.
+ *Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see + * Providing DataSync access to FSx for ONTAP file systems.
* @public */ export interface FsxProtocolSmb { /** - *Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that - * your storage virtual machine (SVM) belongs to.
+ *Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
*If you have multiple domains in your environment, configuring this setting makes sure that * DataSync connects to the right SVM.
+ *If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
* @public */ Domain?: string | undefined; @@ -930,7 +931,7 @@ export interface CreateLocationFsxOntapRequest { StorageVirtualMachineArn: string | undefined; /** - *Specifies a path to the file share in the SVM where you'll copy your data.
+ *Specifies a path to the file share in the SVM where you want to transfer data to or from.
*You can specify a junction path (also known as a mount point), qtree path (for NFS file
* shares), or share name (for SMB file shares). For example, your mount path might be
* /vol1, /vol1/tree1, or /share1.
Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
+ *Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
*If you have multiple Active Directory domains in your environment, configuring this * parameter makes sure that DataSync connects to the right file system.
* @public @@ -1515,8 +1516,7 @@ export interface CreateLocationObjectStorageResponse { /** *Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
- *For more information, see Accessing - * S3 buckets.
+ *For more information, see Providing DataSync access to S3 buckets.
* @public */ export interface S3Config { @@ -1612,8 +1612,7 @@ export interface CreateLocationS3Request { /** *Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
- *For more information, see Accessing - * S3 buckets.
+ *For more information, see Providing DataSync access to S3 buckets.
* @public */ S3Config: S3Config | undefined; @@ -3661,8 +3660,7 @@ export interface DescribeLocationS3Response { /** *Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
- *For more information, see Accessing - * S3 buckets.
+ *For more information, see Providing DataSync access to S3 buckets.
* @public */ S3Config?: S3Config | undefined; @@ -6193,6 +6191,247 @@ export interface UpdateLocationAzureBlobRequest { */ export interface UpdateLocationAzureBlobResponse {} +/** + * @public + */ +export interface UpdateLocationEfsRequest { + /** + *Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
+ *By default, DataSync uses the root directory (or access point if you provide one by using
+ * AccessPointArn). You can also include subdirectories using forward slashes (for
+ * example, /path/to/folder).
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses + * to mount your Amazon EFS file system.
+ *For more information, see Accessing restricted Amazon EFS file systems.
+ * @public + */ + AccessPointArn?: string | undefined; + + /** + *Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
+ *For information on creating this role, see Creating a DataSync IAM role for Amazon EFS file system access.
+ * @public + */ + FileSystemAccessRoleArn?: string | undefined; + + /** + *Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 + * encryption when it transfers data to or from your Amazon EFS file system.
+ *If you specify an access point using AccessPointArn or an IAM
+ * role using FileSystemAccessRoleArn, you must set this parameter to
+ * TLS1_2.
Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
+ *When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see + * Providing DataSync access to FSx for ONTAP file systems.
+ * @public + */ +export interface FsxUpdateProtocolSmb { + /** + *Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
+ *If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
+ * @public + */ + Domain?: string | undefined; + + /** + *Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.
+ * @public + */ + MountOptions?: SmbMountOptions | undefined; + + /** + *Specifies the password of a user who has permission to access your SVM.
+ * @public + */ + Password?: string | undefined; + + /** + *Specifies a user that can mount and access the files, folders, and metadata in your SVM.
+ *For information about choosing a user with the right level of access for your transfer, see Using + * the SMB protocol.
+ * @public + */ + User?: string | undefined; +} + +/** + *Specifies the data transfer protocol that DataSync uses to access your + * Amazon FSx file system.
+ *You can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with this location type.
+ *Specifies the Network File System (NFS) protocol configuration that DataSync + * uses to access your FSx for OpenZFS file system or FSx for ONTAP file + * system's storage virtual machine (SVM).
+ * @public + */ + NFS?: FsxProtocolNfs | undefined; + + /** + *Specifies the Server Message Block (SMB) protocol configuration that DataSync + * uses to access your FSx for ONTAP file system's storage virtual machine (SVM).
+ * @public + */ + SMB?: FsxUpdateProtocolSmb | undefined; +} + +/** + * @public + */ +export interface UpdateLocationFsxOntapRequest { + /** + *Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
+ * @public + */ + Protocol?: FsxUpdateProtocol | undefined; + + /** + *Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.
+ *You can specify a junction path (also known as a mount point), qtree path (for NFS file
+ * shares), or share name (for SMB file shares). For example, your mount path might be
+ * /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
+ *Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies the data transfer protocol that DataSync uses to access your + * Amazon FSx file system.
+ * @public + */ + Protocol?: FsxProtocol | undefined; + + /** + *Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file
+ * system is a source or destination location).
Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file + * system is a source or destination location).
+ * @public + */ + Subdirectory?: string | undefined; + + /** + *Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.
+ *If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
+ * @public + */ + Domain?: string | undefined; + + /** + *Specifies the user with the permissions to mount and access the files, folders, and file + * metadata in your FSx for Windows File Server file system.
+ *For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
+ * @public + */ + User?: string | undefined; + + /** + *Specifies the password of the user with the permissions to mount and access the files, + * folders, and file metadata in your FSx for Windows File Server file system.
+ * @public + */ + Password?: string | undefined; +} + +/** + * @public + */ +export interface UpdateLocationFsxWindowsResponse {} + /** * @public */ @@ -6419,6 +6658,75 @@ export interface UpdateLocationObjectStorageRequest { */ export interface UpdateLocationObjectStorageResponse {} +/** + * @public + */ +export interface UpdateLocationS3Request { + /** + *Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.
+ * @public + */ + LocationArn: string | undefined; + + /** + *Specifies a prefix in the S3 bucket that DataSync reads from or writes to + * (depending on whether the bucket is a source or destination location).
+ *DataSync can't transfer objects with a prefix that begins with a slash
+ * (/) or includes //, /./, or
+ * /../ patterns. For example:
+ * /photos
+ *
+ * photos//2006/January
+ *
+ * photos/./2006/February
+ *
+ * photos/../2006/March
+ *
Specifies the storage class that you want your objects to use when Amazon S3 is a + * transfer destination.
+ *For buckets in Amazon Web Services Regions, the storage class defaults to
+ * STANDARD. For buckets on Outposts, the storage class defaults to
+ * OUTPOSTS.
For more information, see Storage class + * considerations with Amazon S3 transfers.
+ * @public + */ + S3StorageClass?: S3StorageClass | undefined; + + /** + *Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
+ *For more information, see Providing DataSync access to S3 buckets.
+ * @public + */ + S3Config?: S3Config | undefined; +} + +/** + * @public + */ +export interface UpdateLocationS3Response {} + /** * @public */ @@ -6760,6 +7068,46 @@ export const UpdateLocationAzureBlobRequestFilterSensitiveLog = (obj: UpdateLoca ...(obj.SasConfiguration && { SasConfiguration: AzureBlobSasConfigurationFilterSensitiveLog(obj.SasConfiguration) }), }); +/** + * @internal + */ +export const FsxUpdateProtocolSmbFilterSensitiveLog = (obj: FsxUpdateProtocolSmb): any => ({ + ...obj, + ...(obj.Password && { Password: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FsxUpdateProtocolFilterSensitiveLog = (obj: FsxUpdateProtocol): any => ({ + ...obj, + ...(obj.SMB && { SMB: FsxUpdateProtocolSmbFilterSensitiveLog(obj.SMB) }), +}); + +/** + * @internal + */ +export const UpdateLocationFsxOntapRequestFilterSensitiveLog = (obj: UpdateLocationFsxOntapRequest): any => ({ + ...obj, + ...(obj.Protocol && { Protocol: FsxUpdateProtocolFilterSensitiveLog(obj.Protocol) }), +}); + +/** + * @internal + */ +export const UpdateLocationFsxOpenZfsRequestFilterSensitiveLog = (obj: UpdateLocationFsxOpenZfsRequest): any => ({ + ...obj, + ...(obj.Protocol && { Protocol: FsxProtocolFilterSensitiveLog(obj.Protocol) }), +}); + +/** + * @internal + */ +export const UpdateLocationFsxWindowsRequestFilterSensitiveLog = (obj: UpdateLocationFsxWindowsRequest): any => ({ + ...obj, + ...(obj.Password && { Password: SENSITIVE_STRING }), +}); + /** * @internal */ diff --git a/clients/client-datasync/src/protocols/Aws_json1_1.ts b/clients/client-datasync/src/protocols/Aws_json1_1.ts index c9bbc82bdf5b4..4447c086bd2c7 100644 --- a/clients/client-datasync/src/protocols/Aws_json1_1.ts +++ b/clients/client-datasync/src/protocols/Aws_json1_1.ts @@ -159,12 +159,30 @@ import { UpdateLocationAzureBlobCommandInput, UpdateLocationAzureBlobCommandOutput, } from "../commands/UpdateLocationAzureBlobCommand"; +import { UpdateLocationEfsCommandInput, UpdateLocationEfsCommandOutput } from "../commands/UpdateLocationEfsCommand"; +import { + UpdateLocationFsxLustreCommandInput, + UpdateLocationFsxLustreCommandOutput, +} from "../commands/UpdateLocationFsxLustreCommand"; +import { + UpdateLocationFsxOntapCommandInput, + UpdateLocationFsxOntapCommandOutput, +} from "../commands/UpdateLocationFsxOntapCommand"; +import { + UpdateLocationFsxOpenZfsCommandInput, + UpdateLocationFsxOpenZfsCommandOutput, +} from "../commands/UpdateLocationFsxOpenZfsCommand"; +import { + UpdateLocationFsxWindowsCommandInput, + UpdateLocationFsxWindowsCommandOutput, +} from "../commands/UpdateLocationFsxWindowsCommand"; import { UpdateLocationHdfsCommandInput, UpdateLocationHdfsCommandOutput } from "../commands/UpdateLocationHdfsCommand"; import { UpdateLocationNfsCommandInput, UpdateLocationNfsCommandOutput } from "../commands/UpdateLocationNfsCommand"; import { UpdateLocationObjectStorageCommandInput, UpdateLocationObjectStorageCommandOutput, } from "../commands/UpdateLocationObjectStorageCommand"; +import { UpdateLocationS3CommandInput, UpdateLocationS3CommandOutput } from "../commands/UpdateLocationS3Command"; import { UpdateLocationSmbCommandInput, UpdateLocationSmbCommandOutput } from "../commands/UpdateLocationSmbCommand"; import { UpdateStorageSystemCommandInput, @@ -240,6 +258,8 @@ import { FsxProtocol, FsxProtocolNfs, FsxProtocolSmb, + FsxUpdateProtocol, + FsxUpdateProtocolSmb, GenerateRecommendationsRequest, HdfsNameNode, InternalException, @@ -289,9 +309,15 @@ import { UpdateAgentRequest, UpdateDiscoveryJobRequest, UpdateLocationAzureBlobRequest, + UpdateLocationEfsRequest, + UpdateLocationFsxLustreRequest, + UpdateLocationFsxOntapRequest, + UpdateLocationFsxOpenZfsRequest, + UpdateLocationFsxWindowsRequest, UpdateLocationHdfsRequest, UpdateLocationNfsRequest, UpdateLocationObjectStorageRequest, + UpdateLocationS3Request, UpdateLocationSmbRequest, UpdateStorageSystemRequest, UpdateTaskExecutionRequest, @@ -1071,6 +1097,71 @@ export const se_UpdateLocationAzureBlobCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1UpdateLocationEfsCommand + */ +export const se_UpdateLocationEfsCommand = async ( + input: UpdateLocationEfsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationEfs"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1UpdateLocationFsxLustreCommand + */ +export const se_UpdateLocationFsxLustreCommand = async ( + input: UpdateLocationFsxLustreCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationFsxLustre"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1UpdateLocationFsxOntapCommand + */ +export const se_UpdateLocationFsxOntapCommand = async ( + input: UpdateLocationFsxOntapCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationFsxOntap"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1UpdateLocationFsxOpenZfsCommand + */ +export const se_UpdateLocationFsxOpenZfsCommand = async ( + input: UpdateLocationFsxOpenZfsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationFsxOpenZfs"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1UpdateLocationFsxWindowsCommand + */ +export const se_UpdateLocationFsxWindowsCommand = async ( + input: UpdateLocationFsxWindowsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationFsxWindows"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1UpdateLocationHdfsCommand */ @@ -1110,6 +1201,19 @@ export const se_UpdateLocationObjectStorageCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1UpdateLocationS3Command + */ +export const se_UpdateLocationS3Command = async ( + input: UpdateLocationS3CommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateLocationS3"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1UpdateLocationSmbCommand */ @@ -2229,6 +2333,106 @@ export const de_UpdateLocationAzureBlobCommand = async ( return response; }; +/** + * deserializeAws_json1_1UpdateLocationEfsCommand + */ +export const de_UpdateLocationEfsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseSpecifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location)\n on your file system.
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
The Amazon Resource Name (ARN) for the FSx for Lustre file system.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
", "smithy.api#required": {} } }, "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are used to configure the\n FSx for Lustre file system.
", + "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide access to your\n FSx for Lustre file system.
\nThe security groups must be able to access the file system's ports. The file system must\n also allow access from the security groups. For information about file system access, see the\n \n Amazon FSx for Lustre User Guide\n .
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#FsxLustreSubdirectory", "traits": { - "smithy.api#documentation": "A subdirectory in the location's path. This subdirectory in the FSx for Lustre\n file system is used to read data from the FSx for Lustre source location or write\n data to the FSx for Lustre destination.
" + "smithy.api#documentation": "Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).
The key-value pair that represents a tag that you want to add to the resource. The value\n can be an empty string. This value helps you manage, filter, and search for your resources. We\n recommend that you create a name tag for your location.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
" } } }, @@ -748,7 +748,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's\n created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FSx for Lustre file system location that\n you created.
" } } }, @@ -802,7 +802,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#FsxOntapSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a path to the file share in the SVM where you'll copy your data.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nSpecifies a path to the file share in the SVM where you want to transfer data to or from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nSpecifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.
" } }, "Password": { @@ -1133,7 +1133,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for a Network File System (NFS) file\n server. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses\n NFS file servers.
\nIf you're copying data to or from an Snowcone device, you can also use\n CreateLocationNfs to create your transfer location. For more information, see\n Configuring transfers with Snowcone.
Creates a transfer location for a Network File System (NFS) file\n server. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses\n NFS file servers.
" } }, "com.amazonaws.datasync#CreateLocationNfsRequest": { @@ -4112,6 +4112,21 @@ { "target": "com.amazonaws.datasync#UpdateLocationAzureBlob" }, + { + "target": "com.amazonaws.datasync#UpdateLocationEfs" + }, + { + "target": "com.amazonaws.datasync#UpdateLocationFsxLustre" + }, + { + "target": "com.amazonaws.datasync#UpdateLocationFsxOntap" + }, + { + "target": "com.amazonaws.datasync#UpdateLocationFsxOpenZfs" + }, + { + "target": "com.amazonaws.datasync#UpdateLocationFsxWindows" + }, { "target": "com.amazonaws.datasync#UpdateLocationHdfs" }, @@ -4121,6 +4136,9 @@ { "target": "com.amazonaws.datasync#UpdateLocationObjectStorage" }, + { + "target": "com.amazonaws.datasync#UpdateLocationS3" + }, { "target": "com.amazonaws.datasync#UpdateLocationSmb" }, @@ -5197,7 +5215,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the Network File System (NFS) protocol configuration that DataSync\n uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file\n system.
" + "smithy.api#documentation": "Specifies the Network File System (NFS) protocol configuration that DataSync\n uses to access your FSx for OpenZFS file system or FSx for ONTAP file\n system's storage virtual machine (SVM).
" } }, "com.amazonaws.datasync#FsxProtocolSmb": { @@ -5206,7 +5224,7 @@ "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that\n your storage virtual machine (SVM) belongs to.
\nIf you have multiple domains in your environment, configuring this setting makes sure that\n DataSync connects to the right SVM.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
\nIf you have multiple domains in your environment, configuring this setting makes sure that\n DataSync connects to the right SVM.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
" } }, "MountOptions": { @@ -5228,7 +5246,63 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see\n Accessing FSx for ONTAP file systems.
" + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see\n Providing DataSync access to FSx for ONTAP file systems.
" + } + }, + "com.amazonaws.datasync#FsxUpdateProtocol": { + "type": "structure", + "members": { + "NFS": { + "target": "com.amazonaws.datasync#FsxProtocolNfs" + }, + "SMB": { + "target": "com.amazonaws.datasync#FsxUpdateProtocolSmb", + "traits": { + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync\n uses to access your FSx for ONTAP file system's storage virtual machine (SVM).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the data transfer protocol that DataSync uses to access your\n Amazon FSx file system.
\nYou can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with this location type.
\nSpecifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
" + } + }, + "MountOptions": { + "target": "com.amazonaws.datasync#SmbMountOptions" + }, + "Password": { + "target": "com.amazonaws.datasync#SmbPassword", + "traits": { + "smithy.api#documentation": "Specifies the password of a user who has permission to access your SVM.
" + } + }, + "User": { + "target": "com.amazonaws.datasync#SmbUser", + "traits": { + "smithy.api#documentation": "Specifies a user that can mount and access the files, folders, and metadata in your SVM.
\nFor information about choosing a user with the right level of access for your transfer, see Using\n the SMB protocol.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see\n Providing DataSync access to FSx for ONTAP file systems.
" + } + }, + "com.amazonaws.datasync#FsxUpdateSmbDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 253 + }, + "smithy.api#pattern": "^([A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252})?$" } }, "com.amazonaws.datasync#FsxWindowsSubdirectory": { @@ -7750,7 +7824,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
\nFor more information, see Accessing\n S3 buckets.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
\nFor more information, see Providing DataSync access to S3 buckets.
" } }, "com.amazonaws.datasync#S3ManifestConfig": { @@ -9174,7 +9248,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
" + "smithy.api#documentation": "Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with Azure Blob Storage.
" } }, "com.amazonaws.datasync#UpdateLocationAzureBlobRequest": { @@ -9235,6 +9309,291 @@ "smithy.api#output": {} } }, + "com.amazonaws.datasync#UpdateLocationEfs": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#UpdateLocationEfsRequest" + }, + "output": { + "target": "com.amazonaws.datasync#UpdateLocationEfsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with Amazon EFS.
" + } + }, + "com.amazonaws.datasync#UpdateLocationEfsRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#EfsSubdirectory", + "traits": { + "smithy.api#documentation": "Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing restricted Amazon EFS file systems.
" + } + }, + "FileSystemAccessRoleArn": { + "target": "com.amazonaws.datasync#UpdatedEfsIamRoleArn", + "traits": { + "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync IAM role for Amazon EFS file system access.
" + } + }, + "InTransitEncryption": { + "target": "com.amazonaws.datasync#EfsInTransitEncryption", + "traits": { + "smithy.api#documentation": "Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\n encryption when it transfers data to or from your Amazon EFS file system.
\nIf you specify an access point using AccessPointArn or an IAM\n role using FileSystemAccessRoleArn, you must set this parameter to\n TLS1_2.
Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for Lustre.
" + } + }, + "com.amazonaws.datasync#UpdateLocationFsxLustreRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#SmbSubdirectory", + "traits": { + "smithy.api#documentation": "Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).
Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for ONTAP.
" + } + }, + "com.amazonaws.datasync#UpdateLocationFsxOntapRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.datasync#FsxUpdateProtocol", + "traits": { + "smithy.api#documentation": "Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
" + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxOntapSubdirectory", + "traits": { + "smithy.api#documentation": "Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nModifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for OpenZFS.
\nRequest parameters related to SMB aren't supported with the\n UpdateLocationFsxOpenZfs operation.
Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.datasync#FsxProtocol" + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#SmbSubdirectory", + "traits": { + "smithy.api#documentation": "Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file\n system is a source or destination location).
Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for Windows File Server.
" + } + }, + "com.amazonaws.datasync#UpdateLocationFsxWindowsRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", + "traits": { + "smithy.api#documentation": "Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file\n system is a source or destination location).
" + } + }, + "Domain": { + "target": "com.amazonaws.datasync#FsxUpdateSmbDomain", + "traits": { + "smithy.api#documentation": "Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
" + } + }, + "User": { + "target": "com.amazonaws.datasync#SmbUser", + "traits": { + "smithy.api#documentation": "Specifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.
\nFor information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
" + } + }, + "Password": { + "target": "com.amazonaws.datasync#SmbPassword", + "traits": { + "smithy.api#documentation": "Specifies the password of the user with the permissions to mount and access the files,\n folders, and file metadata in your FSx for Windows File Server file system.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datasync#UpdateLocationFsxWindowsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datasync#UpdateLocationHdfs": { "type": "operation", "input": { @@ -9252,7 +9611,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates some parameters of a previously created location for a Hadoop Distributed File\n System cluster.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Hadoop Distributed File\n System (HDFS) transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an HDFS cluster.
" } }, "com.amazonaws.datasync#UpdateLocationHdfsRequest": { @@ -9366,7 +9725,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies some configurations of the Network File System (NFS) transfer location that\n you're using with DataSync.
\nFor more information, see Configuring transfers to or from an\n NFS file server.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.
\nFor more information, see Configuring transfers with an\n NFS file server.
" } }, "com.amazonaws.datasync#UpdateLocationNfsRequest": { @@ -9420,7 +9779,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates some parameters of an existing DataSync location for an object\n storage system.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an object storage system.
" } }, "com.amazonaws.datasync#UpdateLocationObjectStorageRequest": { @@ -9487,6 +9846,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.datasync#UpdateLocationS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#UpdateLocationS3Request" + }, + "output": { + "target": "com.amazonaws.datasync#UpdateLocationS3Response" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.
\nBefore you begin, make sure that you read the following topics:
\n\n Storage\n class considerations with Amazon S3 locations\n
\nSpecifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.
", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#S3Subdirectory", + "traits": { + "smithy.api#documentation": "Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).
\nDataSync can't transfer objects with a prefix that begins with a slash\n (/) or includes //, /./, or\n /../ patterns. For example:
\n /photos\n
\n photos//2006/January\n
\n photos/./2006/February\n
\n photos/../2006/March\n
Specifies the storage class that you want your objects to use when Amazon S3 is a\n transfer destination.
\nFor buckets in Amazon Web Services Regions, the storage class defaults to\n STANDARD. For buckets on Outposts, the storage class defaults to\n OUTPOSTS.
For more information, see Storage class\n considerations with Amazon S3 transfers.
" + } + }, + "S3Config": { + "target": "com.amazonaws.datasync#S3Config" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datasync#UpdateLocationS3Response": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datasync#UpdateLocationSmb": { "type": "operation", "input": { @@ -9504,7 +9920,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates some of the parameters of a Server Message Block\n (SMB) file server location that you can use for DataSync transfers.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Server Message Block\n (SMB) transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an SMB file server.
" } }, "com.amazonaws.datasync#UpdateLocationSmbRequest": { @@ -9773,6 +10189,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.datasync#UpdatedEfsAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^(^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$)|(^$)$" + } + }, + "com.amazonaws.datasync#UpdatedEfsIamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^(^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$)|(^$)$" + } + }, "com.amazonaws.datasync#VerifyMode": { "type": "enum", "members": {