@aws-sdk/client-datasync 3.504.0 → 3.509.0

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

@@ -26,7 +26,9 @@ declare const CreateLocationAzureBlobCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.</p>
+ * <p>Creates a transfer <i>location</i> for a Microsoft Azure Blob Storage
+ *       container. DataSync can use this location as a transfer source or
+ *       destination.</p>
  *          <p>Before you begin, make sure you know <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access">how DataSync accesses Azure Blob Storage</a> and works with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">access tiers</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types">blob types</a>. You also need a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent">DataSync agent</a> that can connect to your
  *       container.</p>
  * @example

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

@@ -26,8 +26,12 @@ declare const CreateLocationEfsCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an Amazon EFS file system that DataSync
- *       can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html">Creating a location for Amazon EFS</a>.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon EFS file system.
+ *         DataSync can use this location as a source or destination for transferring
+ *       data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access">accesses
+ *           Amazon EFS file systems</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,11 @@ declare const CreateLocationFsxLustreCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an Amazon FSx for Lustre file system.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon FSx for Lustre file system.
+ *       DataSync can use this location as a source or destination for transferring
+ *       data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access">accesses FSx for Lustre file systems</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,9 +26,11 @@ declare const CreateLocationFsxOntapCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon FSx for NetApp ONTAP file
+ *       system. DataSync can use this location as a source or destination for
+ *       transferring data.</p>
  *          <p>Before you begin, make sure that you understand how DataSync
- *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">accesses an FSx for ONTAP file system</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">accesses FSx for ONTAP file systems</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,11 @@ declare const CreateLocationFsxOpenZfsCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html">Creating a location for FSx for OpenZFS</a>.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon FSx for OpenZFS file system.
+ *       DataSync can use this location as a source or destination for transferring
+ *       data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access">accesses FSx for OpenZFS file systems</a>.</p>
  *          <note>
  *             <p>Request parameters related to <code>SMB</code> aren't supported with the
  *           <code>CreateLocationFsxOpenZfs</code> operation.</p>

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

@@ -26,8 +26,12 @@ declare const CreateLocationFsxWindowsCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.</p>
- *          <p>Before you begin, make sure that you understand how DataSync <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access">accesses an FSx for Windows File Server</a>.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon FSx for Windows File Server file
+ *       system. DataSync can use this location as a source or destination for
+ *       transferring data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access">accesses
+ *           FSx for Windows File Server file systems</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,12 @@ declare const CreateLocationHdfsCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for a Hadoop Distributed File System (HDFS). </p>
+ * <p>Creates a transfer <i>location</i> for a Hadoop Distributed File System
+ *       (HDFS). DataSync can use this location as a source or destination for
+ *       transferring data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs">accesses
+ *         HDFS clusters</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,9 +26,12 @@ declare const CreateLocationNfsCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html">Configuring transfers to or from an NFS file
- *         server</a>.</p>
+ * <p>Creates a transfer <i>location</i> for a Network File System (NFS) file
+ *       server. DataSync can use this location as a source or destination for
+ *       transferring data.</p>
+ *          <p>Before you begin, make sure that you understand how DataSync
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs">accesses
+ *         NFS file servers</a>.</p>
  *          <note>
  *             <p>If you're copying data to or from an Snowcone device, you can also use
  *           <code>CreateLocationNfs</code> to create your transfer location. For more information, see

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

@@ -26,9 +26,10 @@ declare const CreateLocationObjectStorageCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for an object storage system that DataSync can access
- *       for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object
- *         storage</a>.</p>
+ * <p>Creates a transfer <i>location</i> for an object storage system. DataSync can use this location as a source or destination for transferring
+ *       data.</p>
+ *          <p>Before you begin, make sure that you understand the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites">prerequisites</a>
+ *       for DataSync to work with object storage systems.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,9 +26,10 @@ declare const CreateLocationS3Command_base: {
 };
 /**
  * @public
- * <p>A <i>location</i> is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.</p>
+ * <p>Creates a transfer <i>location</i> for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring
+ *       data.</p>
  *          <important>
- *             <p>Before you create your location, make sure that you read the following sections:</p>
+ *             <p>Before you begin, make sure that you read the following topics:</p>
  *             <ul>
  *                <li>
  *                   <p>
@@ -43,7 +44,7 @@ declare const CreateLocationS3Command_base: {
  *                </li>
  *             </ul>
  *          </important>
- *          <p> For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli">Creating an Amazon S3 location</a>.</p>
+ *          <p> For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html">Configuring transfers with Amazon S3</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,9 +26,12 @@ declare const CreateLocationSmbCommand_base: {
 };
 /**
  * @public
- * <p>Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.</p>
+ * <p>Creates a transfer <i>location</i> for a Server Message Block (SMB) file
+ *       server. DataSync can use this location as a source or destination for
+ *       transferring data.</p>
  *          <p>Before you begin, make sure that you understand how DataSync
- *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">accesses an SMB file server</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb">accesses
+ *         SMB file servers</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -86,6 +86,18 @@ declare const CreateTaskCommand_base: {
  *       Value: "STRING_VALUE",
  *     },
  *   ],
+ *   ManifestConfig: { // ManifestConfig
+ *     Action: "TRANSFER",
+ *     Format: "CSV",
+ *     Source: { // SourceManifestConfig
+ *       S3: { // S3ManifestConfig
+ *         ManifestObjectPath: "STRING_VALUE", // required
+ *         BucketAccessRoleArn: "STRING_VALUE", // required
+ *         S3BucketArn: "STRING_VALUE", // required
+ *         ManifestObjectVersionId: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
  *   TaskReportConfig: { // TaskReportConfig
  *     Destination: { // ReportDestination
  *       S3: { // ReportDestinationS3

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

@@ -26,7 +26,7 @@ declare const DeleteLocationCommand_base: {
 };
 /**
  * @public
- * <p>Deletes the configuration of a location used by DataSync. </p>
+ * <p>Deletes a transfer location resource from DataSync. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const DeleteTaskCommand_base: {
 };
 /**
  * @public
- * <p>Deletes an DataSync transfer task.</p>
+ * <p>Deletes a transfer task resource from DataSync.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,7 @@ declare const DescribeLocationEfsCommand_base: {
 };
 /**
  * @public
- * <p>Returns metadata about your DataSync location for an Amazon EFS
- *       file system.</p>
+ * <p>Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const DescribeLocationFsxLustreCommand_base: {
 };
 /**
  * @public
- * <p>Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.</p>
+ * <p>Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const DescribeLocationFsxOntapCommand_base: {
 };
 /**
  * @public
- * <p>Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.</p>
+ * <p>Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.</p>
  *          <note>
  *             <p>If your location uses SMB, the <code>DescribeLocationFsxOntap</code> operation doesn't
  *         actually return a <code>Password</code>.</p>

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

@@ -26,7 +26,7 @@ declare const DescribeLocationFsxOpenZfsCommand_base: {
 };
 /**
  * @public
- * <p>Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.</p>
+ * <p>Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.</p>
  *          <note>
  *             <p>Response elements related to <code>SMB</code> aren't supported with the
  *           <code>DescribeLocationFsxOpenZfs</code> operation.</p>

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

@@ -26,8 +26,7 @@ declare const DescribeLocationFsxWindowsCommand_base: {
 };
 /**
  * @public
- * <p>Returns metadata about an Amazon FSx for Windows File Server location, such as information
- *       about its path.</p>
+ * <p>Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,8 @@ declare const DescribeLocationHdfsCommand_base: {
 };
 /**
  * @public
- * <p>Returns metadata, such as the authentication information about the Hadoop Distributed File
- *       System (HDFS) location. </p>
+ * <p>Provides details about how an DataSync transfer location for a Hadoop
+ *       Distributed File System (HDFS) is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,8 @@ declare const DescribeLocationObjectStorageCommand_base: {
 };
 /**
  * @public
- * <p>Returns metadata about your DataSync location for an object storage
- *       system.</p>
+ * <p>Provides details about how an DataSync transfer location for an object
+ *       storage system is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,8 @@ declare const DescribeLocationS3Command_base: {
 };
 /**
  * @public
- * <p>Returns metadata, such as bucket name, about an Amazon S3 bucket location.</p>
+ * <p>Provides details about how an DataSync transfer location for an S3 bucket
+ *       is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,8 @@ declare const DescribeLocationSmbCommand_base: {
 };
 /**
  * @public
- * <p>Returns metadata, such as the path and user information about an SMB location.</p>
+ * <p>Provides details about how an DataSync transfer location for a Server
+ *       Message Block (SMB) file server is configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -87,6 +87,18 @@ declare const DescribeTaskCommand_base: {
  * //       Value: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   ManifestConfig: { // ManifestConfig
+ * //     Action: "TRANSFER",
+ * //     Format: "CSV",
+ * //     Source: { // SourceManifestConfig
+ * //       S3: { // S3ManifestConfig
+ * //         ManifestObjectPath: "STRING_VALUE", // required
+ * //         BucketAccessRoleArn: "STRING_VALUE", // required
+ * //         S3BucketArn: "STRING_VALUE", // required
+ * //         ManifestObjectVersionId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
  * //   TaskReportConfig: { // TaskReportConfig
  * //     Destination: { // ReportDestination
  * //       S3: { // ReportDestinationS3

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

@@ -72,12 +72,25 @@ declare const DescribeTaskExecutionCommand_base: {
  * //       Value: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   ManifestConfig: { // ManifestConfig
+ * //     Action: "TRANSFER",
+ * //     Format: "CSV",
+ * //     Source: { // SourceManifestConfig
+ * //       S3: { // S3ManifestConfig
+ * //         ManifestObjectPath: "STRING_VALUE", // required
+ * //         BucketAccessRoleArn: "STRING_VALUE", // required
+ * //         S3BucketArn: "STRING_VALUE", // required
+ * //         ManifestObjectVersionId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
  * //   StartTime: new Date("TIMESTAMP"),
  * //   EstimatedFilesToTransfer: Number("long"),
  * //   EstimatedBytesToTransfer: Number("long"),
  * //   FilesTransferred: Number("long"),
  * //   BytesWritten: Number("long"),
  * //   BytesTransferred: Number("long"),
+ * //   BytesCompressed: Number("long"),
  * //   Result: { // TaskExecutionResultDetail
  * //     PrepareDuration: Number("long"),
  * //     PrepareStatus: "PENDING" || "SUCCESS" || "ERROR",
@@ -89,7 +102,6 @@ declare const DescribeTaskExecutionCommand_base: {
  * //     ErrorCode: "STRING_VALUE",
  * //     ErrorDetail: "STRING_VALUE",
  * //   },
- * //   BytesCompressed: Number("long"),
  * //   TaskReportConfig: { // TaskReportConfig
  * //     Destination: { // ReportDestination
  * //       S3: { // ReportDestinationS3

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

@@ -26,7 +26,7 @@ declare const ListTaskExecutionsCommand_base: {
 };
 /**
  * @public
- * <p>Returns a list of executed tasks.</p>
+ * <p>Returns a list of executions for an DataSync transfer task.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -72,12 +72,18 @@ declare const StartTaskExecutionCommand_base: {
  *       Value: "STRING_VALUE",
  *     },
  *   ],
- *   Tags: [ // InputTagList
- *     { // TagListEntry
- *       Key: "STRING_VALUE", // required
- *       Value: "STRING_VALUE",
+ *   ManifestConfig: { // ManifestConfig
+ *     Action: "TRANSFER",
+ *     Format: "CSV",
+ *     Source: { // SourceManifestConfig
+ *       S3: { // S3ManifestConfig
+ *         ManifestObjectPath: "STRING_VALUE", // required
+ *         BucketAccessRoleArn: "STRING_VALUE", // required
+ *         S3BucketArn: "STRING_VALUE", // required
+ *         ManifestObjectVersionId: "STRING_VALUE",
+ *       },
  *     },
- *   ],
+ *   },
  *   TaskReportConfig: { // TaskReportConfig
  *     Destination: { // ReportDestination
  *       S3: { // ReportDestinationS3
@@ -104,6 +110,12 @@ declare const StartTaskExecutionCommand_base: {
  *       },
  *     },
  *   },
+ *   Tags: [ // InputTagList
+ *     { // TagListEntry
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
  * };
  * const command = new StartTaskExecutionCommand(input);
  * const response = await client.send(command);

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

@@ -26,7 +26,7 @@ declare const UpdateTaskCommand_base: {
 };
 /**
  * @public
- * <p>Updates the configuration of a DataSync transfer task.</p>
+ * <p>Updates the configuration of an DataSync transfer task.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,6 +69,18 @@ declare const UpdateTaskCommand_base: {
  *       Value: "STRING_VALUE",
  *     },
  *   ],
+ *   ManifestConfig: { // ManifestConfig
+ *     Action: "TRANSFER",
+ *     Format: "CSV",
+ *     Source: { // SourceManifestConfig
+ *       S3: { // S3ManifestConfig
+ *         ManifestObjectPath: "STRING_VALUE", // required
+ *         BucketAccessRoleArn: "STRING_VALUE", // required
+ *         S3BucketArn: "STRING_VALUE", // required
+ *         ManifestObjectVersionId: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
  *   TaskReportConfig: { // TaskReportConfig
  *     Destination: { // ReportDestination
  *       S3: { // ReportDestinationS3