docs(client-transfer): Documentation updates for AWS Transfer Family

aws · Oct 2, 2023 · a896848 · a896848
1 parent 679fd29
commit a896848
Show file tree

Hide file tree

Showing 61 changed files with 213 additions and 129 deletions.
diff --git a/clients/client-transfer/src/commands/CreateAccessCommand.ts b/clients/client-transfer/src/commands/CreateAccessCommand.ts
@@ -86,13 +86,13 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family

diff --git a/clients/client-transfer/src/commands/CreateAgreementCommand.ts b/clients/client-transfer/src/commands/CreateAgreementCommand.ts
@@ -79,13 +79,13 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family

diff --git a/clients/client-transfer/src/commands/CreateConnectorCommand.ts b/clients/client-transfer/src/commands/CreateConnectorCommand.ts
@@ -92,13 +92,13 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family

diff --git a/clients/client-transfer/src/commands/CreateProfileCommand.ts b/clients/client-transfer/src/commands/CreateProfileCommand.ts
@@ -72,7 +72,7 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/CreateServerCommand.ts b/clients/client-transfer/src/commands/CreateServerCommand.ts
@@ -130,13 +130,13 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family

diff --git a/clients/client-transfer/src/commands/CreateUserCommand.ts b/clients/client-transfer/src/commands/CreateUserCommand.ts
@@ -94,13 +94,13 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family

diff --git a/clients/client-transfer/src/commands/CreateWorkflowCommand.ts b/clients/client-transfer/src/commands/CreateWorkflowCommand.ts
@@ -186,13 +186,13 @@ export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __M
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>
  *
  * @throws {@link ResourceExistsException} (client fault)
- *  <p>The requested resource does not exist.</p>
+ *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

diff --git a/clients/client-transfer/src/commands/DeleteAccessCommand.ts b/clients/client-transfer/src/commands/DeleteAccessCommand.ts
@@ -62,7 +62,7 @@ export interface DeleteAccessCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteAgreementCommand.ts b/clients/client-transfer/src/commands/DeleteAgreementCommand.ts
@@ -61,7 +61,7 @@ export interface DeleteAgreementCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteCertificateCommand.ts b/clients/client-transfer/src/commands/DeleteCertificateCommand.ts
@@ -61,7 +61,7 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteConnectorCommand.ts b/clients/client-transfer/src/commands/DeleteConnectorCommand.ts
@@ -60,7 +60,7 @@ export interface DeleteConnectorCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteHostKeyCommand.ts b/clients/client-transfer/src/commands/DeleteHostKeyCommand.ts
@@ -61,7 +61,7 @@ export interface DeleteHostKeyCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteProfileCommand.ts b/clients/client-transfer/src/commands/DeleteProfileCommand.ts
@@ -60,7 +60,7 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteServerCommand.ts b/clients/client-transfer/src/commands/DeleteServerCommand.ts
@@ -64,7 +64,7 @@ export interface DeleteServerCommandOutput extends __MetadataBearer {}
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteSshPublicKeyCommand.ts b/clients/client-transfer/src/commands/DeleteSshPublicKeyCommand.ts
@@ -62,7 +62,7 @@ export interface DeleteSshPublicKeyCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteUserCommand.ts b/clients/client-transfer/src/commands/DeleteUserCommand.ts
@@ -65,7 +65,7 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {}
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DeleteWorkflowCommand.ts b/clients/client-transfer/src/commands/DeleteWorkflowCommand.ts
@@ -63,7 +63,7 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {}
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeAccessCommand.ts b/clients/client-transfer/src/commands/DescribeAccessCommand.ts
@@ -87,7 +87,7 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __M
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeAgreementCommand.ts b/clients/client-transfer/src/commands/DescribeAgreementCommand.ts
@@ -79,7 +79,7 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeCertificateCommand.ts b/clients/client-transfer/src/commands/DescribeCertificateCommand.ts
@@ -86,7 +86,7 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeConnectorCommand.ts b/clients/client-transfer/src/commands/DescribeConnectorCommand.ts
@@ -92,7 +92,7 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeExecutionCommand.ts b/clients/client-transfer/src/commands/DescribeExecutionCommand.ts
@@ -126,7 +126,7 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeHostKeyCommand.ts b/clients/client-transfer/src/commands/DescribeHostKeyCommand.ts
@@ -76,7 +76,7 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeProfileCommand.ts b/clients/client-transfer/src/commands/DescribeProfileCommand.ts
@@ -76,7 +76,7 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeSecurityPolicyCommand.ts b/clients/client-transfer/src/commands/DescribeSecurityPolicyCommand.ts
@@ -80,7 +80,7 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeServerCommand.ts b/clients/client-transfer/src/commands/DescribeServerCommand.ts
@@ -134,7 +134,7 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeUserCommand.ts b/clients/client-transfer/src/commands/DescribeUserCommand.ts
@@ -100,7 +100,7 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/DescribeWorkflowCommand.ts b/clients/client-transfer/src/commands/DescribeWorkflowCommand.ts
@@ -184,7 +184,7 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>

diff --git a/clients/client-transfer/src/commands/ImportCertificateCommand.ts b/clients/client-transfer/src/commands/ImportCertificateCommand.ts
@@ -80,7 +80,7 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
  *
  * @throws {@link InternalServiceError} (server fault)
- *  <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
+ *  <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>This exception is thrown when the client submits a malformed request.</p>