diff --git a/apis/transfer-2018-11-05.normal.json b/apis/transfer-2018-11-05.normal.json index 20d5b46e59..408e9df4ca 100644 --- a/apis/transfer-2018-11-05.normal.json +++ b/apis/transfer-2018-11-05.normal.json @@ -1788,7 +1788,7 @@ }, "EncryptionAlgorithm": { "shape": "EncryptionAlg", - "documentation": "

The algorithm that is used to encrypt the file.

" + "documentation": "

The algorithm that is used to encrypt the file.

You can only specify NONE if the URL for your connector uses HTTPS. This ensures that no traffic is sent in clear text.

" }, "SigningAlgorithm": { "shape": "SigningAlg", @@ -1796,7 +1796,7 @@ }, "MdnSigningAlgorithm": { "shape": "MdnSigningAlg", - "documentation": "

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.

" + "documentation": "

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

" }, "MdnResponse": { "shape": "MdnResponse", @@ -1914,15 +1914,15 @@ }, "DestinationFileLocation": { "shape": "InputFileLocation", - "documentation": "

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

" + "documentation": "

Specifies the location for the file being copied. Use ${Transfer:username} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

" }, "OverwriteExisting": { "shape": "OverwriteExisting", - "documentation": "

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

" + "documentation": "

A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

" }, "SourceFileLocation": { "shape": "SourceFileLocation", - "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" + "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" } }, "documentation": "

Each step type has its own StepDetails structure.

" @@ -2013,7 +2013,7 @@ }, "BaseDirectory": { "shape": "HomeDirectory", - "documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is DOC-EXAMPLE-BUCKET/home/mydirectory.

" + "documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

" }, "AccessRole": { "shape": "Role", @@ -2141,7 +2141,7 @@ }, "HostKey": { "shape": "HostKey", - "documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.

" + "documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" }, "IdentityProviderDetails": { "shape": "IdentityProviderDetails", @@ -2165,7 +2165,7 @@ }, "Protocols": { "shape": "Protocols", - "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" + "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" }, "ProtocolDetails": { "shape": "ProtocolDetails", @@ -2181,7 +2181,7 @@ }, "WorkflowDetails": { "shape": "WorkflowDetails", - "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" + "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" } } }, @@ -2235,7 +2235,7 @@ }, "SshPublicKeyBody": { "shape": "SshPublicKeyBody", - "documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

" + "documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

" }, "Tags": { "shape": "Tags", @@ -2276,7 +2276,7 @@ }, "Steps": { "shape": "WorkflowSteps", - "documentation": "

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.

" + "documentation": "

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

Currently, copying and tagging are supported only on S3.

For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.

" }, "OnExceptionSteps": { "shape": "WorkflowSteps", @@ -2317,7 +2317,7 @@ }, "SourceFileLocation": { "shape": "SourceFileLocation", - "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" + "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" } }, "documentation": "

Each step type has its own StepDetails structure.

" @@ -2350,21 +2350,26 @@ ], "members": { "Name": { - "shape": "WorkflowStepName" + "shape": "WorkflowStepName", + "documentation": "

The name of the step, used as an identifier.

" }, "Type": { - "shape": "EncryptionType" + "shape": "EncryptionType", + "documentation": "

The type of encryption used. Currently, this value must be PGP.

" }, "SourceFileLocation": { - "shape": "SourceFileLocation" + "shape": "SourceFileLocation", + "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" }, "OverwriteExisting": { - "shape": "OverwriteExisting" + "shape": "OverwriteExisting", + "documentation": "

A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

" }, "DestinationFileLocation": { "shape": "InputFileLocation" } - } + }, + "documentation": "

Each step type has its own StepDetails structure.

" }, "DeleteAccessRequest": { "type": "structure", @@ -2496,7 +2501,7 @@ }, "SourceFileLocation": { "shape": "SourceFileLocation", - "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" + "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" } }, "documentation": "

The name of the step, used to identify the delete step.

" @@ -3214,7 +3219,7 @@ }, "Protocols": { "shape": "Protocols", - "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" + "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" }, "SecurityPolicyName": { "shape": "SecurityPolicyName", @@ -3238,7 +3243,7 @@ }, "WorkflowDetails": { "shape": "WorkflowDetails", - "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" + "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" } }, "documentation": "

Describes the properties of a file transfer protocol-enabled server that was specified.

" @@ -3356,7 +3361,7 @@ "documentation": "

The pathname for the folder being used by a workflow.

" } }, - "documentation": "

Reserved for future use.

" + "documentation": "

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.

" }, "EfsFileSystemId": { "type": "string", @@ -3486,7 +3491,7 @@ "members": { "StepType": { "shape": "WorkflowStepType", - "documentation": "

One of the available step types.

" + "documentation": "

One of the available step types.

" }, "Outputs": { "shape": "StepResultOutputsJson", @@ -3656,7 +3661,7 @@ }, "Certificate": { "shape": "CertificateBodyType", - "documentation": "

The file that contains the certificate to import.

" + "documentation": "" }, "CertificateChain": { "shape": "CertificateChainType", @@ -3664,7 +3669,7 @@ }, "PrivateKey": { "shape": "PrivateKeyType", - "documentation": "

The file that contains the private key for the certificate that's being imported.

" + "documentation": "" }, "ActiveDate": { "shape": "CertDate", @@ -3709,7 +3714,7 @@ }, "HostKeyBody": { "shape": "HostKey", - "documentation": "

The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

" + "documentation": "

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

" }, "Description": { "shape": "HostKeyDescription", @@ -3788,14 +3793,14 @@ "members": { "S3FileLocation": { "shape": "S3InputFileLocation", - "documentation": "

Specifies the details for the S3 file being copied.

" + "documentation": "

Specifies the details for the Amazon S3 file that's being copied or decrypted.

" }, "EfsFileLocation": { "shape": "EfsFileLocation", - "documentation": "

Reserved for future use.

" + "documentation": "

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

" } }, - "documentation": "

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

" + "documentation": "

Specifies the location for the file that's being processed.

" }, "ListAccessesRequest": { "type": "structure", @@ -4805,7 +4810,7 @@ "documentation": "

The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.

" } }, - "documentation": "

Specifies the customer input S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is \"/\", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

" + "documentation": "

Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is \"/\", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

" }, "S3Key": { "type": "string", @@ -5163,7 +5168,7 @@ }, "SourceFileLocation": { "shape": "SourceFileLocation", - "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" + "documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

" } }, "documentation": "

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

" @@ -5542,7 +5547,7 @@ }, "HostKey": { "shape": "HostKey", - "documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.

" + "documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" }, "IdentityProviderDetails": { "shape": "IdentityProviderDetails", @@ -5562,7 +5567,7 @@ }, "Protocols": { "shape": "Protocols", - "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" + "documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

" }, "SecurityPolicyName": { "shape": "SecurityPolicyName", @@ -5574,7 +5579,7 @@ }, "WorkflowDetails": { "shape": "WorkflowDetails", - "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'

" + "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'

" } } }, @@ -5719,7 +5724,7 @@ "documentation": "

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

" } }, - "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" + "documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

" }, "WorkflowDetails": { "type": "structure", @@ -5746,15 +5751,15 @@ "members": { "Type": { "shape": "WorkflowStepType", - "documentation": "

Currently, the following step types are supported.

" + "documentation": "

Currently, the following step types are supported.

" }, "CopyStepDetails": { "shape": "CopyStepDetails", - "documentation": "

Details for a step that performs a file copy.

Consists of the following values:

" + "documentation": "

Details for a step that performs a file copy.

Consists of the following values:

" }, "CustomStepDetails": { "shape": "CustomStepDetails", - "documentation": "

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

" + "documentation": "

Details for a step that invokes an Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

" }, "DeleteStepDetails": { "shape": "DeleteStepDetails", @@ -5762,10 +5767,11 @@ }, "TagStepDetails": { "shape": "TagStepDetails", - "documentation": "

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

" + "documentation": "

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

" }, "DecryptStepDetails": { - "shape": "DecryptStepDetails" + "shape": "DecryptStepDetails", + "documentation": "

Details for a step that decrypts an encrypted file.

Consists of the following values:

" } }, "documentation": "

The basic building block of a workflow.

"