The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
+ *The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.
*/ UserSecretId?: string; @@ -925,17 +925,17 @@ export interface SftpConnectorConfig { * @public *The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.
* You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional : do not enter the
The three standard SSH public key format elements are <key type>,
+ * <body base64>, and an optional <comment>, with spaces
+ * between each element. Specify only the <key type> and <body
+ * base64>: do not enter the <comment> portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
*For RSA keys, the ssh-rsa.
For RSA keys, the <key type> string is ssh-rsa.
For ECDSA keys, the
For ECDSA keys, the <key type> string is either
* ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or
* ecdsa-sha2-nistp521, depending on the size of the key you generated.
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 , and an optional
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.
*The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } @@ -1017,7 +989,7 @@ "SshPublicKeyBody": { "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { - "smithy.api#documentation": "The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
\nThe three standard SSH public key format elements are , and an optional
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
\nFor 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,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
\nThe three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
\nFor 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,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
Describes the agreement that's identified by the AgreementId.
Describes the agreement that's identified by the AgreementId.
Describes the certificate that's identified by the CertificateId.
Describes the certificate that's identified by the CertificateId.
Describes the connector that's identified by the ConnectorId.\n
Describes the connector that's identified by the ConnectorId.\n
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
\n\n If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a\n ResourceNotFound exception.
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
\n\n If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a\n ResourceNotFound exception.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
Returns the details of the profile that's specified by the ProfileId.
Returns the details of the profile that's specified by the ProfileId.
Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
" + "smithy.api#documentation": "Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
", + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#DescribeSecurityPolicyRequest": { @@ -2249,6 +2229,7 @@ ], "traits": { "smithy.api#documentation": "Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.
The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.
Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
Describes the specified workflow.
" + "smithy.api#documentation": "Describes the specified workflow.
", + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#DescribeWorkflowRequest": { @@ -2978,7 +2963,7 @@ } }, "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "target": "com.amazonaws.transfer#NullableRole", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } @@ -4125,7 +4110,8 @@ "outputToken": "NextToken", "items": "Accesses", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#ListAccessesRequest": { @@ -4215,7 +4201,8 @@ "outputToken": "NextToken", "items": "Agreements", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#ListAgreementsRequest": { @@ -4298,7 +4285,8 @@ "outputToken": "NextToken", "items": "Certificates", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#ListCertificatesRequest": { @@ -4374,7 +4362,8 @@ "outputToken": "NextToken", "items": "Connectors", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#ListConnectorsRequest": { @@ -4450,7 +4439,8 @@ "outputToken": "NextToken", "items": "Executions", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#ListExecutionsRequest": { @@ -4534,7 +4524,8 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of host keys for the server that's specified by the ServerId\n parameter.
Returns a list of host keys for the server that's specified by the ServerId\n parameter.
The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
" + "smithy.api#documentation": "The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.
" } }, "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the ssh-rsa.
For ECDSA keys, the ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the <key type> string is ssh-rsa.
For ECDSA keys, the <key type> string is either\n ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.