Skip to content

Commit

Permalink
feat(client-datasync): Added support for self-signed certificates whe…
Browse files Browse the repository at this point in the history
…n using object storage locations; added BytesCompressed to the TaskExecution response.
  • Loading branch information
awstools committed Oct 24, 2022
1 parent d70854b commit dfc62aa
Show file tree
Hide file tree
Showing 14 changed files with 1,055 additions and 832 deletions.
12 changes: 7 additions & 5 deletions clients/client-datasync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ AWS SDK for JavaScript DataSync Client for Node.js, Browser and React Native.

<fullname>DataSync</fullname>

<p>DataSync is a managed data transfer service that makes it simpler for you to
automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3)
or Amazon Elastic File System (Amazon EFS). </p>
<p>This API interface reference for DataSync contains documentation for a
programming interface that you can use to manage DataSync.</p>
<p>DataSync is a managed data transfer service that makes it simpler for you
to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
<p>This API interface reference includes documentation for using DataSync
programmatically. For complete information, see the <i>
<a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
Guide</a>
</i>.</p>

## Installing

Expand Down
68 changes: 40 additions & 28 deletions clients/client-datasync/src/DataSync.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,22 +190,23 @@ import { DataSyncClient } from "./DataSyncClient";
/**
* <fullname>DataSync</fullname>
*
* <p>DataSync is a managed data transfer service that makes it simpler for you to
* automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3)
* or Amazon Elastic File System (Amazon EFS). </p>
* <p>This API interface reference for DataSync contains documentation for a
* programming interface that you can use to manage DataSync.</p>
* <p>DataSync is a managed data transfer service that makes it simpler for you
* to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
* <p>This API interface reference includes documentation for using DataSync
* programmatically. For complete information, see the <i>
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
* Guide</a>
* </i>.</p>
*/
export class DataSync extends DataSyncClient {
/**
* <p>Cancels execution of a task. </p>
* <p>When you cancel a task execution, the transfer of some files is abruptly interrupted.
* The contents of files that are transferred to the destination might be incomplete or
* inconsistent with the source files. However, if you start a new task execution on the same
* task and you allow the task execution to complete, file content on the destination is complete
* and consistent. This applies to other unexpected failures that interrupt a task execution. In
* all of these cases, DataSync successfully complete the transfer when you start the next
* task execution.</p>
* <p>Stops an DataSync task execution that's in progress. The transfer of some
* files are abruptly interrupted. File contents that're transferred to the destination might be
* incomplete or inconsistent with the source files.</p>
* <p>However, if you start a new task execution using the same task and allow it to finish,
* file content on the destination will be complete and consistent. This applies to other
* unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task
* execution.</p>
*/
public cancelTaskExecution(
args: CancelTaskExecutionCommandInput,
Expand Down Expand Up @@ -237,11 +238,11 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Activates an DataSync agent that you have deployed on your host. The activation
* process associates your agent with your account. In the activation process, you specify
* information such as the Amazon Web Services Region that you want to activate the agent in. You activate the
* agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your
* tasks are created in this Amazon Web Services Region.</p>
* <p>Activates an DataSync agent that you have deployed in your storage
* environment. The activation process associates your agent with your account. In the activation
* process, you specify information such as the Amazon Web Services Region that you want to
* activate the agent in. You activate the agent in the Amazon Web Services Region where your
* target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.</p>
* <p>You can activate the agent in a VPC (virtual private cloud) or provide the agent access to
* a VPC endpoint so you can run tasks without going over the public internet.</p>
* <p>You can use an agent for more than one location. If a task uses multiple agents, all of
Expand All @@ -251,7 +252,6 @@ export class DataSync extends DataSyncClient {
*
* <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that
* ensures minimal interruption to your tasks.</p>
* <p></p>
*/
public createAgent(args: CreateAgentCommandInput, options?: __HttpHandlerOptions): Promise<CreateAgentCommandOutput>;
public createAgent(args: CreateAgentCommandInput, cb: (err: any, data?: CreateAgentCommandOutput) => void): void;
Expand Down Expand Up @@ -375,7 +375,12 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Creates an endpoint for an Amazon FSx for OpenZFS file system.</p>
* <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>
* <note>
* <p>Request parameters related to <code>SMB</code> aren't supported with the
* <code>CreateLocationFsxOpenZfs</code> operation.</p>
* </note>
*/
public createLocationFsxOpenZfs(
args: CreateLocationFsxOpenZfsCommandInput,
Expand Down Expand Up @@ -536,7 +541,7 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Creates an endpoint for an Amazon S3 bucket.</p>
* <p>Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.</p>
*
*
* <p>For
Expand Down Expand Up @@ -806,8 +811,7 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Returns metadata about an Amazon FSx for Lustre
* location, such as information about its path.</p>
* <p>Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.</p>
*/
public describeLocationFsxLustre(
args: DescribeLocationFsxLustreCommandInput,
Expand Down Expand Up @@ -840,6 +844,10 @@ export class DataSync extends DataSyncClient {

/**
* <p>Provides details about how an DataSync 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>
* </note>
*/
public describeLocationFsxOntap(
args: DescribeLocationFsxOntapCommandInput,
Expand Down Expand Up @@ -871,8 +879,11 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Returns metadata about an Amazon FSx for OpenZFS
* location, such as information about its path.</p>
* <p>Provides details about how an DataSync 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>
* </note>
*/
public describeLocationFsxOpenZfs(
args: DescribeLocationFsxOpenZfsCommandInput,
Expand Down Expand Up @@ -1507,9 +1518,10 @@ export class DataSync extends DataSyncClient {
}

/**
* <p>Updates some of the parameters of a previously created location for self-managed object
* storage server access. For information about creating a self-managed object storage location,
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>.</p>
* <p>Updates some parameters of an existing object storage location that DataSync
* accesses for a transfer. For information about creating a self-managed object storage
* location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object
* storage</a>.</p>
*/
public updateLocationObjectStorage(
args: UpdateLocationObjectStorageCommandInput,
Expand Down
12 changes: 7 additions & 5 deletions clients/client-datasync/src/DataSyncClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -400,11 +400,13 @@ export interface DataSyncClientResolvedConfig extends DataSyncClientResolvedConf
/**
* <fullname>DataSync</fullname>
*
* <p>DataSync is a managed data transfer service that makes it simpler for you to
* automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3)
* or Amazon Elastic File System (Amazon EFS). </p>
* <p>This API interface reference for DataSync contains documentation for a
* programming interface that you can use to manage DataSync.</p>
* <p>DataSync is a managed data transfer service that makes it simpler for you
* to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
* <p>This API interface reference includes documentation for using DataSync
* programmatically. For complete information, see the <i>
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
* Guide</a>
* </i>.</p>
*/
export class DataSyncClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,13 @@ export interface CancelTaskExecutionCommandInput extends CancelTaskExecutionRequ
export interface CancelTaskExecutionCommandOutput extends CancelTaskExecutionResponse, __MetadataBearer {}

/**
* <p>Cancels execution of a task. </p>
* <p>When you cancel a task execution, the transfer of some files is abruptly interrupted.
* The contents of files that are transferred to the destination might be incomplete or
* inconsistent with the source files. However, if you start a new task execution on the same
* task and you allow the task execution to complete, file content on the destination is complete
* and consistent. This applies to other unexpected failures that interrupt a task execution. In
* all of these cases, DataSync successfully complete the transfer when you start the next
* task execution.</p>
* <p>Stops an DataSync task execution that's in progress. The transfer of some
* files are abruptly interrupted. File contents that're transferred to the destination might be
* incomplete or inconsistent with the source files.</p>
* <p>However, if you start a new task execution using the same task and allow it to finish,
* file content on the destination will be complete and consistent. This applies to other
* unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task
* execution.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
11 changes: 5 additions & 6 deletions clients/client-datasync/src/commands/CreateAgentCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ export interface CreateAgentCommandInput extends CreateAgentRequest {}
export interface CreateAgentCommandOutput extends CreateAgentResponse, __MetadataBearer {}

/**
* <p>Activates an DataSync agent that you have deployed on your host. The activation
* process associates your agent with your account. In the activation process, you specify
* information such as the Amazon Web Services Region that you want to activate the agent in. You activate the
* agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your
* tasks are created in this Amazon Web Services Region.</p>
* <p>Activates an DataSync agent that you have deployed in your storage
* environment. The activation process associates your agent with your account. In the activation
* process, you specify information such as the Amazon Web Services Region that you want to
* activate the agent in. You activate the agent in the Amazon Web Services Region where your
* target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.</p>
* <p>You can activate the agent in a VPC (virtual private cloud) or provide the agent access to
* a VPC endpoint so you can run tasks without going over the public internet.</p>
* <p>You can use an agent for more than one location. If a task uses multiple agents, all of
Expand All @@ -43,7 +43,6 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat
*
* <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that
* ensures minimal interruption to your tasks.</p>
* <p></p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ export interface CreateLocationFsxOpenZfsCommandInput extends CreateLocationFsxO
export interface CreateLocationFsxOpenZfsCommandOutput extends CreateLocationFsxOpenZfsResponse, __MetadataBearer {}

/**
* <p>Creates an endpoint for an Amazon FSx for OpenZFS file system.</p>
* <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>
* <note>
* <p>Request parameters related to <code>SMB</code> aren't supported with the
* <code>CreateLocationFsxOpenZfs</code> operation.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CreateLocationS3CommandInput extends CreateLocationS3Request {}
export interface CreateLocationS3CommandOutput extends CreateLocationS3Response, __MetadataBearer {}

/**
* <p>Creates an endpoint for an Amazon S3 bucket.</p>
* <p>Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.</p>
*
*
* <p>For
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ export interface DescribeLocationFsxLustreCommandInput extends DescribeLocationF
export interface DescribeLocationFsxLustreCommandOutput extends DescribeLocationFsxLustreResponse, __MetadataBearer {}

/**
* <p>Returns metadata about an Amazon FSx for Lustre
* location, such as information about its path.</p>
* <p>Provides details about how an DataSync 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ export interface DescribeLocationFsxOntapCommandOutput extends DescribeLocationF

/**
* <p>Provides details about how an DataSync 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>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ export interface DescribeLocationFsxOpenZfsCommandInput extends DescribeLocation
export interface DescribeLocationFsxOpenZfsCommandOutput extends DescribeLocationFsxOpenZfsResponse, __MetadataBearer {}

/**
* <p>Returns metadata about an Amazon FSx for OpenZFS
* location, such as information about its path.</p>
* <p>Provides details about how an DataSync 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>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ export interface UpdateLocationObjectStorageCommandOutput
__MetadataBearer {}

/**
* <p>Updates some of the parameters of a previously created location for self-managed object
* storage server access. For information about creating a self-managed object storage location,
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>.</p>
* <p>Updates some parameters of an existing object storage location that DataSync
* accesses for a transfer. For information about creating a self-managed object storage
* location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object
* storage</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit dfc62aa

Please sign in to comment.