lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.66.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.67.0

- old
+ new

@@ -559,12 +559,11 @@ # # @option params [required, String] :base_directory # The landing directory (folder) for files transferred by using the AS2 # protocol. # - # A `BaseDirectory` example is - # *DOC-EXAMPLE-BUCKET*/*home*/*mydirectory*. + # A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory`. # # @option params [required, String] :access_role # With AS2, you can send files by calling `StartFileTransfer` and # specifying the file paths in the request parameter, `SendFilePaths`. # We use the file’s parent directory (for example, for @@ -880,11 +879,11 @@ # # 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 + # For more information, see [Manage host keys for your SFTP-enabled # server][1] in the *Transfer Family User Guide*. # # # # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key @@ -963,18 +962,19 @@ # Certificate Manager (ACM) which is used to identify your server when # clients connect to it over FTPS. # # * If `Protocol` includes either `FTP` or `FTPS`, then the # `EndpointType` must be `VPC` and the `IdentityProviderType` must be - # `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`. + # either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. # # * If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be # associated. # # * If `Protocol` is set only to `SFTP`, the `EndpointType` can be set - # to `PUBLIC` and the `IdentityProviderType` can be set to - # `SERVICE_MANAGED`. + # to `PUBLIC` and the `IdentityProviderType` can be set any of the + # supported identity types: `SERVICE_MANAGED`, + # `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. # # * If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, # and domain must be Amazon S3. # # </note> @@ -1012,12 +1012,12 @@ # # @option params [Types::WorkflowDetails] :workflow_details # 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 + # 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. # # @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1189,12 +1189,24 @@ # # @option params [String] :ssh_public_key_body # 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. # + # * For RSA keys, the key type is `ssh-rsa`. + # + # * For ED25519 keys, the key type is `ssh-ed25519`. + # + # * For ECDSA keys, the key type is either `ecdsa-sha2-nistp256`, + # `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`, depending on the + # size of the key you generated. + # # @option params [Array<Types::Tag>] :tags # Key-value pairs that can be used to group and search for users. Tags # are metadata attached to users for any purpose. # # @option params [required, String] :user_name @@ -1266,24 +1278,28 @@ # workflow. # # The `TYPE` specifies which of the following actions is being taken for # this step. # - # * *COPY*\: Copy the file to another location. + # * <b> <code>COPY</code> </b> - Copy the file to another location. # - # * *CUSTOM*\: Perform a custom step with an Lambda function target. + # * <b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda + # function target. # - # * *DELETE*\: Delete the file. + # * <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted + # before it was uploaded. # - # * *TAG*\: Add a tag to the file. + # * <b> <code>DELETE</code> </b> - Delete the file. # + # * <b> <code>TAG</code> </b> - Add a tag to the file. + # # <note markdown="1"> Currently, copying and tagging are supported only on S3. # # </note> # - # For file location, you specify either the S3 bucket and key, or the - # EFS file system ID and path. + # For file location, you specify either the Amazon S3 bucket and key, or + # the Amazon EFS file system ID and path. # # @option params [Array<Types::WorkflowStep>] :on_exception_steps # Specifies the steps (actions) to take if errors are encountered during # execution of the workflow. # @@ -2335,20 +2351,29 @@ # # @option params [required, String] :usage # Specifies whether this certificate is used for signing or encryption. # # @option params [required, String] :certificate - # The file that contains the certificate to import. + # * For the CLI, provide a file path for a certificate in URI format. + # For example, `--certificate file://encryption-cert.pem`. + # Alternatively, you can provide the raw content. # + # * For the SDK, specify the raw content of a certificate file. For + # example, `` --certificate "`cat encryption-cert.pem`" ``. + # # @option params [String] :certificate_chain # An optional list of certificates that make up the chain for the # certificate that's being imported. # # @option params [String] :private_key - # The file that contains the private key for the certificate that's - # being imported. + # * For the CLI, provide a file path for a private key in URI format.For + # example, `--private-key file://encryption-key.pem`. Alternatively, + # you can provide the raw content of the private key file. # + # * For the SDK, specify the raw content of a private key file. For + # example, `` --private-key "`cat encryption-key.pem`" `` + # # @option params [Time,DateTime,Date,Integer,String] :active_date # An optional date that specifies when the certificate becomes active. # # @option params [Time,DateTime,Date,Integer,String] :inactive_date # An optional date that specifies when the certificate becomes inactive. @@ -2400,11 +2425,11 @@ # @option params [required, String] :server_id # The identifier of the server that contains the host key that you are # importing. # # @option params [required, String] :host_key_body - # The public key portion of an SSH key pair. + # The private key portion of an SSH key pair. # # Transfer Family accepts RSA, ECDSA, and ED25519 keys. # # @option params [String] :description # The text description that identifies this host key. @@ -3954,11 +3979,11 @@ # # 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 + # For more information, see [Manage host keys for your SFTP-enabled # server][1] in the *Transfer Family User Guide*. # # # # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key @@ -4012,18 +4037,19 @@ # Certificate Manager (ACM) which is used to identify your server when # clients connect to it over FTPS. # # * If `Protocol` includes either `FTP` or `FTPS`, then the # `EndpointType` must be `VPC` and the `IdentityProviderType` must be - # `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`. + # either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. # # * If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be # associated. # # * If `Protocol` is set only to `SFTP`, the `EndpointType` can be set - # to `PUBLIC` and the `IdentityProviderType` can be set to - # `SERVICE_MANAGED`. + # to `PUBLIC` and the `IdentityProviderType` can be set any of the + # supported identity types: `SERVICE_MANAGED`, + # `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. # # * If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, # and domain must be Amazon S3. # # </note> @@ -4038,12 +4064,12 @@ # # @option params [Types::WorkflowDetails] :workflow_details # 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 + # 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. @@ -4271,10 +4297,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transfer' - context[:gem_version] = '1.66.0' + context[:gem_version] = '1.67.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #