# Data Types
<a name="API_Types"></a>

The AWS Transfer Family API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [As2AsyncMdnConnectorConfig](API_As2AsyncMdnConnectorConfig.md) 
+  [As2ConnectorConfig](API_As2ConnectorConfig.md) 
+  [ConnectorEgressConfig](API_ConnectorEgressConfig.md) 
+  [ConnectorFileTransferResult](API_ConnectorFileTransferResult.md) 
+  [ConnectorVpcLatticeEgressConfig](API_ConnectorVpcLatticeEgressConfig.md) 
+  [CopyStepDetails](API_CopyStepDetails.md) 
+  [CustomDirectoriesType](API_CustomDirectoriesType.md) 
+  [CustomHttpHeader](API_CustomHttpHeader.md) 
+  [CustomStepDetails](API_CustomStepDetails.md) 
+  [DecryptStepDetails](API_DecryptStepDetails.md) 
+  [DeleteStepDetails](API_DeleteStepDetails.md) 
+  [DescribedAccess](API_DescribedAccess.md) 
+  [DescribedAgreement](API_DescribedAgreement.md) 
+  [DescribedCertificate](API_DescribedCertificate.md) 
+  [DescribedConnector](API_DescribedConnector.md) 
+  [DescribedConnectorEgressConfig](API_DescribedConnectorEgressConfig.md) 
+  [DescribedConnectorVpcLatticeEgressConfig](API_DescribedConnectorVpcLatticeEgressConfig.md) 
+  [DescribedExecution](API_DescribedExecution.md) 
+  [DescribedHostKey](API_DescribedHostKey.md) 
+  [DescribedIdentityCenterConfig](API_DescribedIdentityCenterConfig.md) 
+  [DescribedProfile](API_DescribedProfile.md) 
+  [DescribedSecurityPolicy](API_DescribedSecurityPolicy.md) 
+  [DescribedServer](API_DescribedServer.md) 
+  [DescribedUser](API_DescribedUser.md) 
+  [DescribedWebApp](API_DescribedWebApp.md) 
+  [DescribedWebAppCustomization](API_DescribedWebAppCustomization.md) 
+  [DescribedWebAppEndpointDetails](API_DescribedWebAppEndpointDetails.md) 
+  [DescribedWebAppIdentityProviderDetails](API_DescribedWebAppIdentityProviderDetails.md) 
+  [DescribedWebAppVpcConfig](API_DescribedWebAppVpcConfig.md) 
+  [DescribedWorkflow](API_DescribedWorkflow.md) 
+  [EfsFileLocation](API_EfsFileLocation.md) 
+  [EndpointDetails](API_EndpointDetails.md) 
+  [ExecutionError](API_ExecutionError.md) 
+  [ExecutionResults](API_ExecutionResults.md) 
+  [ExecutionStepResult](API_ExecutionStepResult.md) 
+  [FileLocation](API_FileLocation.md) 
+  [HomeDirectoryMapEntry](API_HomeDirectoryMapEntry.md) 
+  [IdentityCenterConfig](API_IdentityCenterConfig.md) 
+  [IdentityProviderDetails](API_IdentityProviderDetails.md) 
+  [InputFileLocation](API_InputFileLocation.md) 
+  [ListedAccess](API_ListedAccess.md) 
+  [ListedAgreement](API_ListedAgreement.md) 
+  [ListedCertificate](API_ListedCertificate.md) 
+  [ListedConnector](API_ListedConnector.md) 
+  [ListedExecution](API_ListedExecution.md) 
+  [ListedHostKey](API_ListedHostKey.md) 
+  [ListedProfile](API_ListedProfile.md) 
+  [ListedServer](API_ListedServer.md) 
+  [ListedUser](API_ListedUser.md) 
+  [ListedWebApp](API_ListedWebApp.md) 
+  [ListedWorkflow](API_ListedWorkflow.md) 
+  [LoggingConfiguration](API_LoggingConfiguration.md) 
+  [PosixProfile](API_PosixProfile.md) 
+  [ProtocolDetails](API_ProtocolDetails.md) 
+  [S3FileLocation](API_S3FileLocation.md) 
+  [S3InputFileLocation](API_S3InputFileLocation.md) 
+  [S3StorageOptions](API_S3StorageOptions.md) 
+  [S3Tag](API_S3Tag.md) 
+  [ServiceMetadata](API_ServiceMetadata.md) 
+  [SftpConnectorConfig](API_SftpConnectorConfig.md) 
+  [SftpConnectorConnectionDetails](API_SftpConnectorConnectionDetails.md) 
+  [SshPublicKey](API_SshPublicKey.md) 
+  [Tag](API_Tag.md) 
+  [TagStepDetails](API_TagStepDetails.md) 
+  [UpdateConnectorEgressConfig](API_UpdateConnectorEgressConfig.md) 
+  [UpdateConnectorVpcLatticeEgressConfig](API_UpdateConnectorVpcLatticeEgressConfig.md) 
+  [UpdateWebAppEndpointDetails](API_UpdateWebAppEndpointDetails.md) 
+  [UpdateWebAppIdentityCenterConfig](API_UpdateWebAppIdentityCenterConfig.md) 
+  [UpdateWebAppIdentityProviderDetails](API_UpdateWebAppIdentityProviderDetails.md) 
+  [UpdateWebAppVpcConfig](API_UpdateWebAppVpcConfig.md) 
+  [UserDetails](API_UserDetails.md) 
+  [WebAppEndpointDetails](API_WebAppEndpointDetails.md) 
+  [WebAppIdentityProviderDetails](API_WebAppIdentityProviderDetails.md) 
+  [WebAppUnits](API_WebAppUnits.md) 
+  [WebAppVpcConfig](API_WebAppVpcConfig.md) 
+  [WorkflowDetail](API_WorkflowDetail.md) 
+  [WorkflowDetails](API_WorkflowDetails.md) 
+  [WorkflowStep](API_WorkflowStep.md) 

# As2AsyncMdnConnectorConfig
<a name="API_As2AsyncMdnConnectorConfig"></a>

Contains the configuration details for asynchronous Message Disposition Notification (MDN) responses in AS2 connectors. This configuration specifies where asynchronous MDN responses should be sent and which servers should handle them.

## Contents
<a name="API_As2AsyncMdnConnectorConfig_Contents"></a>

 ** ServerIds **   <a name="TransferFamily-Type-As2AsyncMdnConnectorConfig-ServerIds"></a>
A list of server identifiers that can handle asynchronous MDN responses. You can specify between 1 and 10 server IDs.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: No

 ** Url **   <a name="TransferFamily-Type-As2AsyncMdnConnectorConfig-Url"></a>
The URL endpoint where asynchronous MDN responses should be sent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

## See Also
<a name="API_As2AsyncMdnConnectorConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/As2AsyncMdnConnectorConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/As2AsyncMdnConnectorConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/As2AsyncMdnConnectorConfig) 

# As2ConnectorConfig
<a name="API_As2ConnectorConfig"></a>

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the AWS Transfer Family customer with the trading partner.

## Contents
<a name="API_As2ConnectorConfig_Contents"></a>

 ** AsyncMdnConfig **   <a name="TransferFamily-Type-As2ConnectorConfig-AsyncMdnConfig"></a>
Configuration settings for asynchronous Message Disposition Notification (MDN) responses. This allows you to configure where asynchronous MDN responses should be sent and which servers should handle them.  
Type: [As2AsyncMdnConnectorConfig](API_As2AsyncMdnConnectorConfig.md) object  
Required: No

 ** BasicAuthSecretId **   <a name="TransferFamily-Type-As2ConnectorConfig-BasicAuthSecretId"></a>
Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in AWS Secrets Manager.  
The default value for this parameter is `null`, which indicates that Basic authentication is not enabled for the connector.  
If the connector should use Basic authentication, the secret needs to be in the following format:  
 `{ "Username": "user-name", "Password": "user-password" }`   
Replace `user-name` and `user-password` with the credentials for the actual user that is being authenticated.  
Note the following:  
+ You are storing these credentials in Secrets Manager, *not passing them directly* into this API.
+ If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the AWS management console, you can have the system create the secret for you.
If you have previously enabled Basic authentication for a connector, you can disable it by using the `UpdateConnector` API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:  
 `update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'`   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** Compression **   <a name="TransferFamily-Type-As2ConnectorConfig-Compression"></a>
Specifies whether the AS2 file is compressed.  
Type: String  
Valid Values: `ZLIB | DISABLED`   
Required: No

 ** EncryptionAlgorithm **   <a name="TransferFamily-Type-As2ConnectorConfig-EncryptionAlgorithm"></a>
The algorithm that is used to encrypt the file.  
Note the following:  
+ Do not use the `DES_EDE3_CBC` algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.
+ You can only specify `NONE` if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.
Type: String  
Valid Values: `AES128_CBC | AES192_CBC | AES256_CBC | DES_EDE3_CBC | NONE`   
Required: No

 ** LocalProfileId **   <a name="TransferFamily-Type-As2ConnectorConfig-LocalProfileId"></a>
A unique identifier for the AS2 local profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** MdnResponse **   <a name="TransferFamily-Type-As2ConnectorConfig-MdnResponse"></a>
Used for outbound requests (from an AWS Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:  
+  `ASYNC`: The system expects an asynchronous MDN response, confirming that the file was transferred successfully (or not).
+  `SYNC`: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
+  `NONE`: Specifies that no MDN response is required.
Type: String  
Valid Values: `SYNC | NONE | ASYNC`   
Required: No

 ** MdnSigningAlgorithm **   <a name="TransferFamily-Type-As2ConnectorConfig-MdnSigningAlgorithm"></a>
The signing algorithm for the MDN response.  
If set to DEFAULT (or not set at all), the value for `SigningAlgorithm` is used.
Type: String  
Valid Values: `SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT`   
Required: No

 ** MessageSubject **   <a name="TransferFamily-Type-As2ConnectorConfig-MessageSubject"></a>
Used as the `Subject` HTTP header attribute in AS2 messages that are being sent with the connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\u0020-\u007E\t]+`   
Required: No

 ** PartnerProfileId **   <a name="TransferFamily-Type-As2ConnectorConfig-PartnerProfileId"></a>
A unique identifier for the partner profile for the connector.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** PreserveContentType **   <a name="TransferFamily-Type-As2ConnectorConfig-PreserveContentType"></a>
Allows you to use the Amazon S3 `Content-Type` that is associated with objects in S3 instead of having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** SigningAlgorithm **   <a name="TransferFamily-Type-As2ConnectorConfig-SigningAlgorithm"></a>
The algorithm that is used to sign the AS2 messages sent with the connector.  
Type: String  
Valid Values: `SHA256 | SHA384 | SHA512 | SHA1 | NONE`   
Required: No

## See Also
<a name="API_As2ConnectorConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/As2ConnectorConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/As2ConnectorConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/As2ConnectorConfig) 

# ConnectorEgressConfig
<a name="API_ConnectorEgressConfig"></a>

Configuration structure that defines how traffic is routed from the connector to the SFTP server. Contains VPC Lattice settings when using VPC\$1LATTICE egress type for private connectivity through customer VPCs.

## Contents
<a name="API_ConnectorEgressConfig_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** VpcLattice **   <a name="TransferFamily-Type-ConnectorEgressConfig-VpcLattice"></a>
VPC\$1LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.  
Type: [ConnectorVpcLatticeEgressConfig](API_ConnectorVpcLatticeEgressConfig.md) object  
Required: No

## See Also
<a name="API_ConnectorEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ConnectorEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ConnectorEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ConnectorEgressConfig) 

# ConnectorFileTransferResult
<a name="API_ConnectorFileTransferResult"></a>

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

## Contents
<a name="API_ConnectorFileTransferResult_Contents"></a>

 ** FilePath **   <a name="TransferFamily-Type-ConnectorFileTransferResult-FilePath"></a>
The filename and path to where the file was sent to or retrieved from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `(.)+`   
Required: Yes

 ** StatusCode **   <a name="TransferFamily-Type-ConnectorFileTransferResult-StatusCode"></a>
The current status for the transfer.  
Type: String  
Valid Values: `QUEUED | IN_PROGRESS | COMPLETED | FAILED`   
Required: Yes

 ** FailureCode **   <a name="TransferFamily-Type-ConnectorFileTransferResult-FailureCode"></a>
For transfers that fail, this parameter contains a code indicating the reason. For example, `RETRIEVE_FILE_NOT_FOUND`   
Type: String  
Required: No

 ** FailureMessage **   <a name="TransferFamily-Type-ConnectorFileTransferResult-FailureMessage"></a>
For transfers that fail, this parameter describes the reason for the failure.  
Type: String  
Required: No

## See Also
<a name="API_ConnectorFileTransferResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ConnectorFileTransferResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ConnectorFileTransferResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ConnectorFileTransferResult) 

# ConnectorVpcLatticeEgressConfig
<a name="API_ConnectorVpcLatticeEgressConfig"></a>

VPC\$1LATTICE egress configuration that specifies the Resource Configuration ARN and port for connecting to SFTP servers through customer VPCs. Requires a valid Resource Configuration with appropriate network access.

## Contents
<a name="API_ConnectorVpcLatticeEgressConfig_Contents"></a>

 ** ResourceConfigurationArn **   <a name="TransferFamily-Type-ConnectorVpcLatticeEgressConfig-ResourceConfigurationArn"></a>
ARN of the VPC\$1LATTICE Resource Configuration that defines the target SFTP server location. Must point to a valid Resource Configuration in the customer's VPC with appropriate network connectivity to the SFTP server.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}`   
Required: Yes

 ** PortNumber **   <a name="TransferFamily-Type-ConnectorVpcLatticeEgressConfig-PortNumber"></a>
Port number for connecting to the SFTP server through VPC\$1LATTICE. Defaults to 22 if not specified. Must match the port on which the target SFTP server is listening.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

## See Also
<a name="API_ConnectorVpcLatticeEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ConnectorVpcLatticeEgressConfig) 

# CopyStepDetails
<a name="API_CopyStepDetails"></a>

Each step type has its own `StepDetails` structure.

## Contents
<a name="API_CopyStepDetails_Contents"></a>

 ** DestinationFileLocation **   <a name="TransferFamily-Type-CopyStepDetails-DestinationFileLocation"></a>
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.  
+ Set the value of `DestinationFileLocation` to `${Transfer:UserName}` to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
+ Set the value of `DestinationFileLocation` to `${Transfer:UploadDate}` to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
**Note**  
The system resolves `UploadDate` to a date format of *YYYY-MM-DD*, based on the date the file is uploaded in UTC.
Type: [InputFileLocation](API_InputFileLocation.md) object  
Required: No

 ** Name **   <a name="TransferFamily-Type-CopyStepDetails-Name"></a>
The name of the step, used as an identifier.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30.  
Pattern: `[\w-]*`   
Required: No

 ** OverwriteExisting **   <a name="TransferFamily-Type-CopyStepDetails-OverwriteExisting"></a>
A flag that indicates whether to overwrite an existing file of the same name. The default is `FALSE`.  
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:  
+ If `OverwriteExisting` is `TRUE`, the existing file is replaced with the file being processed.
+ If `OverwriteExisting` is `FALSE`, nothing happens, and the workflow processing stops.
Type: String  
Valid Values: `TRUE | FALSE`   
Required: No

 ** SourceFileLocation **   <a name="TransferFamily-Type-CopyStepDetails-SourceFileLocation"></a>
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.  
+ To use the previous file as the input, enter `${previous.file}`. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
+ To use the originally uploaded file location as input for this step, enter `${original.file}`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `\$\{(\w+.)+\w+\}`   
Required: No

## See Also
<a name="API_CopyStepDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/CopyStepDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/CopyStepDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/CopyStepDetails) 

# CustomDirectoriesType
<a name="API_CustomDirectoriesType"></a>

Contains Amazon S3 locations for storing specific types of AS2 message files.

## Contents
<a name="API_CustomDirectoriesType_Contents"></a>

 ** FailedFilesDirectory **   <a name="TransferFamily-Type-CustomDirectoriesType-FailedFilesDirectory"></a>
Specifies a location to store failed AS2 message files.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: Yes

 ** MdnFilesDirectory **   <a name="TransferFamily-Type-CustomDirectoriesType-MdnFilesDirectory"></a>
Specifies a location to store MDN files.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: Yes

 ** PayloadFilesDirectory **   <a name="TransferFamily-Type-CustomDirectoriesType-PayloadFilesDirectory"></a>
Specifies a location to store the payload for AS2 message files.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: Yes

 ** StatusFilesDirectory **   <a name="TransferFamily-Type-CustomDirectoriesType-StatusFilesDirectory"></a>
Specifies a location to store AS2 status messages.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: Yes

 ** TemporaryFilesDirectory **   <a name="TransferFamily-Type-CustomDirectoriesType-TemporaryFilesDirectory"></a>
Specifies a location to store temporary AS2 message files.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: Yes

## See Also
<a name="API_CustomDirectoriesType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/CustomDirectoriesType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/CustomDirectoriesType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/CustomDirectoriesType) 

# CustomHttpHeader
<a name="API_CustomHttpHeader"></a>

Represents a custom HTTP header that can be included in AS2 messages. Each header consists of a key-value pair.

## Contents
<a name="API_CustomHttpHeader_Contents"></a>

 ** Key **   <a name="TransferFamily-Type-CustomHttpHeader-Key"></a>
The name of the custom HTTP header.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** Value **   <a name="TransferFamily-Type-CustomHttpHeader-Value"></a>
The value of the custom HTTP header.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 +\-./:=@_]*`   
Required: No

## See Also
<a name="API_CustomHttpHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/CustomHttpHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/CustomHttpHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/CustomHttpHeader) 

# CustomStepDetails
<a name="API_CustomStepDetails"></a>

Each step type has its own `StepDetails` structure.

## Contents
<a name="API_CustomStepDetails_Contents"></a>

 ** Name **   <a name="TransferFamily-Type-CustomStepDetails-Name"></a>
The name of the step, used as an identifier.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30.  
Pattern: `[\w-]*`   
Required: No

 ** SourceFileLocation **   <a name="TransferFamily-Type-CustomStepDetails-SourceFileLocation"></a>
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.  
+ To use the previous file as the input, enter `${previous.file}`. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
+ To use the originally uploaded file location as input for this step, enter `${original.file}`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `\$\{(\w+.)+\w+\}`   
Required: No

 ** Target **   <a name="TransferFamily-Type-CustomStepDetails-Target"></a>
The ARN for the Lambda function that is being called.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 170.  
Pattern: `arn:[a-z-]+:lambda:.*`   
Required: No

 ** TimeoutSeconds **   <a name="TransferFamily-Type-CustomStepDetails-TimeoutSeconds"></a>
Timeout, in seconds, for the step.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1800.  
Required: No

## See Also
<a name="API_CustomStepDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/CustomStepDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/CustomStepDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/CustomStepDetails) 

# DecryptStepDetails
<a name="API_DecryptStepDetails"></a>

Each step type has its own `StepDetails` structure.

## Contents
<a name="API_DecryptStepDetails_Contents"></a>

 ** DestinationFileLocation **   <a name="TransferFamily-Type-DecryptStepDetails-DestinationFileLocation"></a>
Specifies the location for the file being decrypted. Use `${Transfer:UserName}` or `${Transfer:UploadDate}` in this field to parametrize the destination prefix by username or uploaded date.  
+ Set the value of `DestinationFileLocation` to `${Transfer:UserName}` to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
+ Set the value of `DestinationFileLocation` to `${Transfer:UploadDate}` to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
**Note**  
The system resolves `UploadDate` to a date format of *YYYY-MM-DD*, based on the date the file is uploaded in UTC.
Type: [InputFileLocation](API_InputFileLocation.md) object  
Required: Yes

 ** Type **   <a name="TransferFamily-Type-DecryptStepDetails-Type"></a>
The type of encryption used. Currently, this value must be `PGP`.  
Type: String  
Valid Values: `PGP`   
Required: Yes

 ** Name **   <a name="TransferFamily-Type-DecryptStepDetails-Name"></a>
The name of the step, used as an identifier.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30.  
Pattern: `[\w-]*`   
Required: No

 ** OverwriteExisting **   <a name="TransferFamily-Type-DecryptStepDetails-OverwriteExisting"></a>
A flag that indicates whether to overwrite an existing file of the same name. The default is `FALSE`.  
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:  
+ If `OverwriteExisting` is `TRUE`, the existing file is replaced with the file being processed.
+ If `OverwriteExisting` is `FALSE`, nothing happens, and the workflow processing stops.
Type: String  
Valid Values: `TRUE | FALSE`   
Required: No

 ** SourceFileLocation **   <a name="TransferFamily-Type-DecryptStepDetails-SourceFileLocation"></a>
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.  
+ To use the previous file as the input, enter `${previous.file}`. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
+ To use the originally uploaded file location as input for this step, enter `${original.file}`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `\$\{(\w+.)+\w+\}`   
Required: No

## See Also
<a name="API_DecryptStepDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DecryptStepDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DecryptStepDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DecryptStepDetails) 

# DeleteStepDetails
<a name="API_DeleteStepDetails"></a>

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

## Contents
<a name="API_DeleteStepDetails_Contents"></a>

 ** Name **   <a name="TransferFamily-Type-DeleteStepDetails-Name"></a>
The name of the step, used as an identifier.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30.  
Pattern: `[\w-]*`   
Required: No

 ** SourceFileLocation **   <a name="TransferFamily-Type-DeleteStepDetails-SourceFileLocation"></a>
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.  
+ To use the previous file as the input, enter `${previous.file}`. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
+ To use the originally uploaded file location as input for this step, enter `${original.file}`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `\$\{(\w+.)+\w+\}`   
Required: No

## See Also
<a name="API_DeleteStepDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DeleteStepDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DeleteStepDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DeleteStepDetails) 

# DescribedAccess
<a name="API_DescribedAccess"></a>

Describes the properties of the access that was specified.

## Contents
<a name="API_DescribedAccess_Contents"></a>

 ** ExternalId **   <a name="TransferFamily-Type-DescribedAccess-ExternalId"></a>
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.  
 `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid`   
In that command, replace *YourGroupName* with the name of your Active Directory group.  
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `S-1-[\d-]+`   
Required: No

 ** HomeDirectory **   <a name="TransferFamily-Type-DescribedAccess-HomeDirectory"></a>
The landing directory (folder) for a user when they log in to the server using the client.  
A `HomeDirectory` example is `/bucket_name/home/mydirectory`.  
You can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: No

 ** HomeDirectoryMappings **   <a name="TransferFamily-Type-DescribedAccess-HomeDirectoryMappings"></a>
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the `Entry` and `Target` pair, where `Entry` shows how the path is made visible and `Target` is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in `Target`. This value can be set only when `HomeDirectoryType` is set to *LOGICAL*.  
In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("`chroot`"). To do this, you can set `Entry` to '/' and set `Target` to the `HomeDirectory` parameter value.  
Type: Array of [HomeDirectoryMapEntry](API_HomeDirectoryMapEntry.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50000 items.  
Required: No

 ** HomeDirectoryType **   <a name="TransferFamily-Type-DescribedAccess-HomeDirectoryType"></a>
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users.  
If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH`, you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template.
Type: String  
Valid Values: `PATH | LOGICAL`   
Required: No

 ** Policy **   <a name="TransferFamily-Type-DescribedAccess-Policy"></a>
A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** PosixProfile **   <a name="TransferFamily-Type-DescribedAccess-PosixProfile"></a>
The full POSIX identity, including user ID (`Uid`), group ID (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.  
Type: [PosixProfile](API_PosixProfile.md) object  
Required: No

 ** Role **   <a name="TransferFamily-Type-DescribedAccess-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

## See Also
<a name="API_DescribedAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedAccess) 

# DescribedAgreement
<a name="API_DescribedAgreement"></a>

Describes the properties of an agreement.

## Contents
<a name="API_DescribedAgreement_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedAgreement-Arn"></a>
The unique Amazon Resource Name (ARN) for the agreement.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** AccessRole **   <a name="TransferFamily-Type-DescribedAgreement-AccessRole"></a>
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.  
 **For AS2 connectors**   
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 `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`.  
If you are using Basic authentication for your AS2 connector, the access role requires the `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the `kms:Decrypt` permission for that key.  
 **For SFTP connectors**   
Make sure that the access role provides read and write access to the parent directory of the file location that's used in the `StartFileTransfer` request. Additionally, make sure that the role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** AgreementId **   <a name="TransferFamily-Type-DescribedAgreement-AgreementId"></a>
A unique identifier for the agreement. This identifier is returned when you create an agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `a-([0-9a-f]{17})`   
Required: No

 ** BaseDirectory **   <a name="TransferFamily-Type-DescribedAgreement-BaseDirectory"></a>
The landing directory (folder) for files that are transferred by using the AS2 protocol.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: No

 ** CustomDirectories **   <a name="TransferFamily-Type-DescribedAgreement-CustomDirectories"></a>
A `CustomDirectoriesType` structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.  
+ Failed files
+ MDN files
+ Payload files
+ Status files
+ Temporary files
Type: [CustomDirectoriesType](API_CustomDirectoriesType.md) object  
Required: No

 ** Description **   <a name="TransferFamily-Type-DescribedAgreement-Description"></a>
The name or short description that's used to identify the agreement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0021-\u007E]+`   
Required: No

 ** EnforceMessageSigning **   <a name="TransferFamily-Type-DescribedAgreement-EnforceMessageSigning"></a>
 Determines whether or not unsigned messages from your trading partners will be accepted.   
+  `ENABLED`: Transfer Family rejects unsigned messages from your trading partner.
+  `DISABLED` (default value): Transfer Family accepts unsigned messages from your trading partner.
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** LocalProfileId **   <a name="TransferFamily-Type-DescribedAgreement-LocalProfileId"></a>
A unique identifier for the AS2 local profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** PartnerProfileId **   <a name="TransferFamily-Type-DescribedAgreement-PartnerProfileId"></a>
A unique identifier for the partner profile used in the agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** PreserveFilename **   <a name="TransferFamily-Type-DescribedAgreement-PreserveFilename"></a>
 Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.   
+  `ENABLED`: the filename provided by your trading parter is preserved when the file is saved.
+  `DISABLED` (default value): when Transfer Family saves the file, the filename is adjusted, as described in [File names and locations](https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2).
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** ServerId **   <a name="TransferFamily-Type-DescribedAgreement-ServerId"></a>
A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: No

 ** Status **   <a name="TransferFamily-Type-DescribedAgreement-Status"></a>
The current status of the agreement, either `ACTIVE` or `INACTIVE`.  
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedAgreement-Tags"></a>
Key-value pairs that can be used to group and search for agreements.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_DescribedAgreement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedAgreement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedAgreement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedAgreement) 

# DescribedCertificate
<a name="API_DescribedCertificate"></a>

Describes the properties of a certificate.

## Contents
<a name="API_DescribedCertificate_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedCertificate-Arn"></a>
The unique Amazon Resource Name (ARN) for the certificate.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** ActiveDate **   <a name="TransferFamily-Type-DescribedCertificate-ActiveDate"></a>
An optional date that specifies when the certificate becomes active. If you do not specify a value, `ActiveDate` takes the same value as `NotBeforeDate`, which is specified by the CA.   
Type: Timestamp  
Required: No

 ** Certificate **   <a name="TransferFamily-Type-DescribedCertificate-Certificate"></a>
The file name for the certificate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Pattern: `[\t\n\r\u0020-\u00FF]+`   
Required: No

 ** CertificateChain **   <a name="TransferFamily-Type-DescribedCertificate-CertificateChain"></a>
The list of certificates that make up the chain for the certificate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2097152.  
Pattern: `[\t\n\r\u0020-\u00FF]+`   
Required: No

 ** CertificateId **   <a name="TransferFamily-Type-DescribedCertificate-CertificateId"></a>
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `cert-([0-9a-f]{17})`   
Required: No

 ** Description **   <a name="TransferFamily-Type-DescribedCertificate-Description"></a>
The name or description that's used to identity the certificate.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0021-\u007E]+`   
Required: No

 ** InactiveDate **   <a name="TransferFamily-Type-DescribedCertificate-InactiveDate"></a>
An optional date that specifies when the certificate becomes inactive. If you do not specify a value, `InactiveDate` takes the same value as `NotAfterDate`, which is specified by the CA.  
Type: Timestamp  
Required: No

 ** NotAfterDate **   <a name="TransferFamily-Type-DescribedCertificate-NotAfterDate"></a>
The final date that the certificate is valid.  
Type: Timestamp  
Required: No

 ** NotBeforeDate **   <a name="TransferFamily-Type-DescribedCertificate-NotBeforeDate"></a>
The earliest date that the certificate is valid.  
Type: Timestamp  
Required: No

 ** Serial **   <a name="TransferFamily-Type-DescribedCertificate-Serial"></a>
The serial number for the certificate.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 48.  
Pattern: `[0-9a-fA-F{}:?]*`   
Required: No

 ** Status **   <a name="TransferFamily-Type-DescribedCertificate-Status"></a>
A certificate's status can be either `ACTIVE` or `INACTIVE`.  
You can set `ActiveDate` and `InactiveDate` in the `UpdateCertificate` call. If you set values for these parameters, those values are used to determine whether the certificate has a status of `ACTIVE` or `INACTIVE`.  
If you don't set values for `ActiveDate` and `InactiveDate`, we use the `NotBefore` and `NotAfter` date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.  
Type: String  
Valid Values: `ACTIVE | PENDING_ROTATION | INACTIVE`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedCertificate-Tags"></a>
Key-value pairs that can be used to group and search for certificates.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** Type **   <a name="TransferFamily-Type-DescribedCertificate-Type"></a>
If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`. If there is no private key, the type is `CERTIFICATE`.  
Type: String  
Valid Values: `CERTIFICATE | CERTIFICATE_WITH_PRIVATE_KEY`   
Required: No

 ** Usage **   <a name="TransferFamily-Type-DescribedCertificate-Usage"></a>
Specifies how this certificate is used. It can be used in the following ways:  
+  `SIGNING`: For signing AS2 messages
+  `ENCRYPTION`: For encrypting AS2 messages
+  `TLS`: For securing AS2 communications sent over HTTPS
Type: String  
Valid Values: `SIGNING | ENCRYPTION | TLS`   
Required: No

## See Also
<a name="API_DescribedCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedCertificate) 

# DescribedConnector
<a name="API_DescribedConnector"></a>

Describes the parameters for the connector, as identified by the `ConnectorId`.

## Contents
<a name="API_DescribedConnector_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedConnector-Arn"></a>
The unique Amazon Resource Name (ARN) for the connector.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** EgressType **   <a name="TransferFamily-Type-DescribedConnector-EgressType"></a>
Type of egress configuration for the connector. SERVICE\$1MANAGED uses Transfer Family managed NAT gateways, while VPC\$1LATTICE routes traffic through customer VPCs using VPC Lattice.  
Type: String  
Valid Values: `SERVICE_MANAGED | VPC_LATTICE`   
Required: Yes

 ** Status **   <a name="TransferFamily-Type-DescribedConnector-Status"></a>
Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.  
Type: String  
Valid Values: `ACTIVE | ERRORED | PENDING`   
Required: Yes

 ** AccessRole **   <a name="TransferFamily-Type-DescribedConnector-AccessRole"></a>
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.  
 **For AS2 connectors**   
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 `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`.  
If you are using Basic authentication for your AS2 connector, the access role requires the `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the `kms:Decrypt` permission for that key.  
 **For SFTP connectors**   
Make sure that the access role provides read and write access to the parent directory of the file location that's used in the `StartFileTransfer` request. Additionally, make sure that the role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** As2Config **   <a name="TransferFamily-Type-DescribedConnector-As2Config"></a>
A structure that contains the parameters for an AS2 connector object.  
Type: [As2ConnectorConfig](API_As2ConnectorConfig.md) object  
Required: No

 ** ConnectorId **   <a name="TransferFamily-Type-DescribedConnector-ConnectorId"></a>
The unique identifier for the connector.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `c-([0-9a-f]{17})`   
Required: No

 ** EgressConfig **   <a name="TransferFamily-Type-DescribedConnector-EgressConfig"></a>
Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC\$1LATTICE egress type.  
When using the VPC\$1LATTICE egress type, AWS Transfer Family uses a managed Service Network to simplify the resource sharing process.  
Type: [DescribedConnectorEgressConfig](API_DescribedConnectorEgressConfig.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** ErrorMessage **   <a name="TransferFamily-Type-DescribedConnector-ErrorMessage"></a>
Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.  
Type: String  
Required: No

 ** LoggingRole **   <a name="TransferFamily-Type-DescribedConnector-LoggingRole"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** SecurityPolicyName **   <a name="TransferFamily-Type-DescribedConnector-SecurityPolicyName"></a>
The text name of the security policy for the specified connector.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+`   
Required: No

 ** ServiceManagedEgressIpAddresses **   <a name="TransferFamily-Type-DescribedConnector-ServiceManagedEgressIpAddresses"></a>
The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.  
Type: Array of strings  
Pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`   
Required: No

 ** SftpConfig **   <a name="TransferFamily-Type-DescribedConnector-SftpConfig"></a>
A structure that contains the parameters for an SFTP connector object.  
Type: [SftpConnectorConfig](API_SftpConnectorConfig.md) object  
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedConnector-Tags"></a>
Key-value pairs that can be used to group and search for connectors.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** Url **   <a name="TransferFamily-Type-DescribedConnector-Url"></a>
The URL of the partner's AS2 or SFTP endpoint.  
When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

## See Also
<a name="API_DescribedConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedConnector) 

# DescribedConnectorEgressConfig
<a name="API_DescribedConnectorEgressConfig"></a>

Response structure containing the current egress configuration details for the connector. Shows how traffic is currently routed from the connector to the SFTP server.

## Contents
<a name="API_DescribedConnectorEgressConfig_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** VpcLattice **   <a name="TransferFamily-Type-DescribedConnectorEgressConfig-VpcLattice"></a>
VPC\$1LATTICE configuration details in the response, showing the current Resource Configuration ARN and port settings for VPC-based connectivity.  
Type: [DescribedConnectorVpcLatticeEgressConfig](API_DescribedConnectorVpcLatticeEgressConfig.md) object  
Required: No

## See Also
<a name="API_DescribedConnectorEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedConnectorEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedConnectorEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedConnectorEgressConfig) 

# DescribedConnectorVpcLatticeEgressConfig
<a name="API_DescribedConnectorVpcLatticeEgressConfig"></a>

VPC\$1LATTICE egress configuration details in the response, containing the Resource Configuration ARN and port number currently configured for the connector.

## Contents
<a name="API_DescribedConnectorVpcLatticeEgressConfig_Contents"></a>

 ** ResourceConfigurationArn **   <a name="TransferFamily-Type-DescribedConnectorVpcLatticeEgressConfig-ResourceConfigurationArn"></a>
ARN of the VPC\$1LATTICE Resource Configuration currently used by the connector. This Resource Configuration defines the network path to the SFTP server through the customer's VPC.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}`   
Required: Yes

 ** PortNumber **   <a name="TransferFamily-Type-DescribedConnectorVpcLatticeEgressConfig-PortNumber"></a>
Port number currently configured for SFTP connections through VPC\$1LATTICE. Shows the port on which the connector attempts to connect to the target SFTP server.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

## See Also
<a name="API_DescribedConnectorVpcLatticeEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedConnectorVpcLatticeEgressConfig) 

# DescribedExecution
<a name="API_DescribedExecution"></a>

The details for an execution object.

## Contents
<a name="API_DescribedExecution_Contents"></a>

 ** ExecutionId **   <a name="TransferFamily-Type-DescribedExecution-ExecutionId"></a>
A unique identifier for the execution of a workflow.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}`   
Required: No

 ** ExecutionRole **   <a name="TransferFamily-Type-DescribedExecution-ExecutionRole"></a>
The IAM role associated with the execution.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** InitialFileLocation **   <a name="TransferFamily-Type-DescribedExecution-InitialFileLocation"></a>
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.  
Type: [FileLocation](API_FileLocation.md) object  
Required: No

 ** LoggingConfiguration **   <a name="TransferFamily-Type-DescribedExecution-LoggingConfiguration"></a>
The IAM logging role associated with the execution.  
Type: [LoggingConfiguration](API_LoggingConfiguration.md) object  
Required: No

 ** PosixProfile **   <a name="TransferFamily-Type-DescribedExecution-PosixProfile"></a>
The full POSIX identity, including user ID (`Uid`), group ID (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.  
Type: [PosixProfile](API_PosixProfile.md) object  
Required: No

 ** Results **   <a name="TransferFamily-Type-DescribedExecution-Results"></a>
A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the `OnExceptionSteps` structure.  
Type: [ExecutionResults](API_ExecutionResults.md) object  
Required: No

 ** ServiceMetadata **   <a name="TransferFamily-Type-DescribedExecution-ServiceMetadata"></a>
A container object for the session details that are associated with a workflow.  
Type: [ServiceMetadata](API_ServiceMetadata.md) object  
Required: No

 ** Status **   <a name="TransferFamily-Type-DescribedExecution-Status"></a>
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.   
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | EXCEPTION | HANDLING_EXCEPTION`   
Required: No

## See Also
<a name="API_DescribedExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedExecution) 

# DescribedHostKey
<a name="API_DescribedHostKey"></a>

The details for a server host key.

## Contents
<a name="API_DescribedHostKey_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedHostKey-Arn"></a>
The unique Amazon Resource Name (ARN) for the host key.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** DateImported **   <a name="TransferFamily-Type-DescribedHostKey-DateImported"></a>
The date on which the host key was added to the server.  
Type: Timestamp  
Required: No

 ** Description **   <a name="TransferFamily-Type-DescribedHostKey-Description"></a>
The text description for this host key.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `[\p{Print}]*`   
Required: No

 ** HostKeyFingerprint **   <a name="TransferFamily-Type-DescribedHostKey-HostKeyFingerprint"></a>
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.  
Type: String  
Required: No

 ** HostKeyId **   <a name="TransferFamily-Type-DescribedHostKey-HostKeyId"></a>
A unique identifier for the host key.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `hostkey-[0-9a-f]{17}`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedHostKey-Tags"></a>
Key-value pairs that can be used to group and search for host keys.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** Type **   <a name="TransferFamily-Type-DescribedHostKey-Type"></a>
The encryption algorithm that is used for the host key. The `Type` parameter is specified by using one of the following values:  
+  `ssh-rsa` 
+  `ssh-ed25519` 
+  `ecdsa-sha2-nistp256` 
+  `ecdsa-sha2-nistp384` 
+  `ecdsa-sha2-nistp521` 
Type: String  
Required: No

## See Also
<a name="API_DescribedHostKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedHostKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedHostKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedHostKey) 

# DescribedIdentityCenterConfig
<a name="API_DescribedIdentityCenterConfig"></a>

A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to `DescribeWebApp`.

## Contents
<a name="API_DescribedIdentityCenterConfig_Contents"></a>

 ** ApplicationArn **   <a name="TransferFamily-Type-DescribedIdentityCenterConfig-ApplicationArn"></a>
The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[\w-]+:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: No

 ** InstanceArn **   <a name="TransferFamily-Type-DescribedIdentityCenterConfig-InstanceArn"></a>
The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[\w-]+:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** Role **   <a name="TransferFamily-Type-DescribedIdentityCenterConfig-Role"></a>
The IAM role in IAM Identity Center used for the web app.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

## See Also
<a name="API_DescribedIdentityCenterConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedIdentityCenterConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedIdentityCenterConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedIdentityCenterConfig) 

# DescribedProfile
<a name="API_DescribedProfile"></a>

The details for a local or partner AS2 profile. 

## Contents
<a name="API_DescribedProfile_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedProfile-Arn"></a>
The unique Amazon Resource Name (ARN) for the profile.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** As2Id **   <a name="TransferFamily-Type-DescribedProfile-As2Id"></a>
The `As2Id` is the *AS2-name*, as defined in the [RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation. This ID cannot include spaces.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\u0020-\u007E\s]*`   
Required: No

 ** CertificateIds **   <a name="TransferFamily-Type-DescribedProfile-CertificateIds"></a>
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.  
Type: Array of strings  
Length Constraints: Fixed length of 22.  
Pattern: `cert-([0-9a-f]{17})`   
Required: No

 ** ProfileId **   <a name="TransferFamily-Type-DescribedProfile-ProfileId"></a>
A unique identifier for the local or partner AS2 profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** ProfileType **   <a name="TransferFamily-Type-DescribedProfile-ProfileType"></a>
Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles. If not supplied in the request, the command lists all types of profiles.  
Type: String  
Valid Values: `LOCAL | PARTNER`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedProfile-Tags"></a>
Key-value pairs that can be used to group and search for profiles.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_DescribedProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedProfile) 

# DescribedSecurityPolicy
<a name="API_DescribedSecurityPolicy"></a>

Describes the properties of a security policy that you specify. For more information about security policies, see [Working with security policies for servers](https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) or [Working with security policies for SFTP connectors](https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html).

## Contents
<a name="API_DescribedSecurityPolicy_Contents"></a>

 ** SecurityPolicyName **   <a name="TransferFamily-Type-DescribedSecurityPolicy-SecurityPolicyName"></a>
The text name of the specified security policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+`   
Required: Yes

 ** Fips **   <a name="TransferFamily-Type-DescribedSecurityPolicy-Fips"></a>
Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.  
Type: Boolean  
Required: No

 ** Protocols **   <a name="TransferFamily-Type-DescribedSecurityPolicy-Protocols"></a>
Lists the file transfer protocols that the security policy applies to.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Valid Values: `SFTP | FTPS`   
Required: No

 ** SshCiphers **   <a name="TransferFamily-Type-DescribedSecurityPolicy-SshCiphers"></a>
Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

 ** SshHostKeyAlgorithms **   <a name="TransferFamily-Type-DescribedSecurityPolicy-SshHostKeyAlgorithms"></a>
Lists the host key algorithms for the security policy.  
This parameter only applies to security policies for connectors.
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

 ** SshKexs **   <a name="TransferFamily-Type-DescribedSecurityPolicy-SshKexs"></a>
Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

 ** SshMacs **   <a name="TransferFamily-Type-DescribedSecurityPolicy-SshMacs"></a>
Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

 ** TlsCiphers **   <a name="TransferFamily-Type-DescribedSecurityPolicy-TlsCiphers"></a>
Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.  
This parameter only applies to security policies for servers.
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

 ** Type **   <a name="TransferFamily-Type-DescribedSecurityPolicy-Type"></a>
The resource type to which the security policy applies, either server or connector.  
Type: String  
Valid Values: `SERVER | CONNECTOR`   
Required: No

## See Also
<a name="API_DescribedSecurityPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedSecurityPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedSecurityPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedSecurityPolicy) 

# DescribedServer
<a name="API_DescribedServer"></a>

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

## Contents
<a name="API_DescribedServer_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedServer-Arn"></a>
Specifies the unique Amazon Resource Name (ARN) of the server.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** As2ServiceManagedEgressIpAddresses **   <a name="TransferFamily-Type-DescribedServer-As2ServiceManagedEgressIpAddresses"></a>
The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.  
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.  
Type: Array of strings  
Pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`   
Required: No

 ** Certificate **   <a name="TransferFamily-Type-DescribedServer-Certificate"></a>
Specifies the ARN of the AWSCertificate Manager (ACM) certificate. Required when `Protocols` is set to `FTPS`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1600.  
Required: No

 ** Domain **   <a name="TransferFamily-Type-DescribedServer-Domain"></a>
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.  
Type: String  
Valid Values: `S3 | EFS`   
Required: No

 ** EndpointDetails **   <a name="TransferFamily-Type-DescribedServer-EndpointDetails"></a>
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.  
Type: [EndpointDetails](API_EndpointDetails.md) object  
Required: No

 ** EndpointType **   <a name="TransferFamily-Type-DescribedServer-EndpointType"></a>
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.  
Type: String  
Valid Values: `PUBLIC | VPC | VPC_ENDPOINT`   
Required: No

 ** HostKeyFingerprint **   <a name="TransferFamily-Type-DescribedServer-HostKeyFingerprint"></a>
Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the `ssh-keygen -l -f my-new-server-key` command.  
Type: String  
Required: No

 ** IdentityProviderDetails **   <a name="TransferFamily-Type-DescribedServer-IdentityProviderDetails"></a>
Specifies information to call a customer-supplied authentication API. This field is not populated when the `IdentityProviderType` of a server is `AWS_DIRECTORY_SERVICE` or `SERVICE_MANAGED`.  
Type: [IdentityProviderDetails](API_IdentityProviderDetails.md) object  
Required: No

 ** IdentityProviderType **   <a name="TransferFamily-Type-DescribedServer-IdentityProviderType"></a>
The mode of authentication for a server. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service.  
Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter.  
Use the `API_GATEWAY` value to integrate with an identity provider of your choosing. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter.  
Use the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter for the `IdentityProviderDetails` data type.  
Type: String  
Valid Values: `SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA`   
Required: No

 ** IpAddressType **   <a name="TransferFamily-Type-DescribedServer-IpAddressType"></a>
Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint. The default value is `IPV4`.  
The `IpAddressType` parameter has the following limitations:  
+ It cannot be changed while the server is online. You must stop the server before modifying this parameter.
+ It cannot be updated to `DUALSTACK` if the server has `AddressAllocationIds` specified.
When using `DUALSTACK` as the `IpAddressType`, you cannot set the `AddressAllocationIds` parameter for the [EndpointDetails](https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html) for the server.
Type: String  
Valid Values: `IPV4 | DUALSTACK`   
Required: No

 ** LoggingRole **   <a name="TransferFamily-Type-DescribedServer-LoggingRole"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `(|arn:.*role/\S+)`   
Required: No

 ** PostAuthenticationLoginBanner **   <a name="TransferFamily-Type-DescribedServer-PostAuthenticationLoginBanner"></a>
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.  
The SFTP protocol does not support post-authentication display banners.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Pattern: `[\x09-\x0D\x20-\x7E]*`   
Required: No

 ** PreAuthenticationLoginBanner **   <a name="TransferFamily-Type-DescribedServer-PreAuthenticationLoginBanner"></a>
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:  
 `This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.`   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Pattern: `[\x09-\x0D\x20-\x7E]*`   
Required: No

 ** ProtocolDetails **   <a name="TransferFamily-Type-DescribedServer-ProtocolDetails"></a>
The protocol settings that are configured for your server.  
Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of AWS Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see [ Avoid placing NLBs and NATs in front of AWS Transfer Family](https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations).
+  To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. 
+ To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call.
+ To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter.
+  `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Type: [ProtocolDetails](API_ProtocolDetails.md) object  
Required: No

 ** Protocols **   <a name="TransferFamily-Type-DescribedServer-Protocols"></a>
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:  
+  `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
+  `FTPS` (File Transfer Protocol Secure): File transfer with TLS encryption
+  `FTP` (File Transfer Protocol): Unencrypted file transfer
+  `AS2` (Applicability Statement 2): used for transporting structured business-to-business data
+ If you select `FTPS`, you must choose a certificate stored in AWS 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 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 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.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Valid Values: `SFTP | FTP | FTPS | AS2`   
Required: No

 ** S3StorageOptions **   <a name="TransferFamily-Type-DescribedServer-S3StorageOptions"></a>
Specifies whether or not performance for your Amazon S3 directories is optimized.  
+ If using the console, this is enabled by default.
+ If using the API or CLI, this is disabled by default.
By default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target.  
Type: [S3StorageOptions](API_S3StorageOptions.md) object  
Required: No

 ** SecurityPolicyName **   <a name="TransferFamily-Type-DescribedServer-SecurityPolicyName"></a>
Specifies the name of the security policy for the server.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+`   
Required: No

 ** ServerId **   <a name="TransferFamily-Type-DescribedServer-ServerId"></a>
Specifies the unique system-assigned identifier for a server that you instantiate.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: No

 ** State **   <a name="TransferFamily-Type-DescribedServer-State"></a>
The condition of the server that was described. A value of `ONLINE` indicates that the server can accept jobs and transfer files. A `State` value of `OFFLINE` means that the server cannot perform file transfer operations.  
The states of `STARTING` and `STOPPING` indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of `START_FAILED` or `STOP_FAILED` can indicate an error condition.  
Type: String  
Valid Values: `OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED`   
Required: No

 ** StructuredLogDestinations **   <a name="TransferFamily-Type-DescribedServer-StructuredLogDestinations"></a>
Specifies the log groups to which your server logs are sent.  
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:  
 `arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*`   
For example, `arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*`   
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an `update-server` call. For example:  
 `update-server --server-id s-1234567890abcdef0 --structured-log-destinations`   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedServer-Tags"></a>
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** UserCount **   <a name="TransferFamily-Type-DescribedServer-UserCount"></a>
Specifies the number of users that are assigned to a server you specified with the `ServerId`.  
Type: Integer  
Required: No

 ** WorkflowDetails **   <a name="TransferFamily-Type-DescribedServer-WorkflowDetails"></a>
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 the server session disconnects while the file is still being uploaded.  
Type: [WorkflowDetails](API_WorkflowDetails.md) object  
Required: No

## See Also
<a name="API_DescribedServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedServer) 

# DescribedUser
<a name="API_DescribedUser"></a>

Describes the properties of a user that was specified.

## Contents
<a name="API_DescribedUser_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedUser-Arn"></a>
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** HomeDirectory **   <a name="TransferFamily-Type-DescribedUser-HomeDirectory"></a>
The landing directory (folder) for a user when they log in to the server using the client.  
A `HomeDirectory` example is `/bucket_name/home/mydirectory`.  
You can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: No

 ** HomeDirectoryMappings **   <a name="TransferFamily-Type-DescribedUser-HomeDirectoryMappings"></a>
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the `Entry` and `Target` pair, where `Entry` shows how the path is made visible and `Target` is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in `Target`. This value can be set only when `HomeDirectoryType` is set to *LOGICAL*.  
In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("`chroot`"). To do this, you can set `Entry` to '/' and set `Target` to the HomeDirectory parameter value.  
Type: Array of [HomeDirectoryMapEntry](API_HomeDirectoryMapEntry.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50000 items.  
Required: No

 ** HomeDirectoryType **   <a name="TransferFamily-Type-DescribedUser-HomeDirectoryType"></a>
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users.  
If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH`, you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template.
Type: String  
Valid Values: `PATH | LOGICAL`   
Required: No

 ** Policy **   <a name="TransferFamily-Type-DescribedUser-Policy"></a>
A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** PosixProfile **   <a name="TransferFamily-Type-DescribedUser-PosixProfile"></a>
Specifies the full POSIX identity, including user ID (`Uid`), group ID (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.  
Type: [PosixProfile](API_PosixProfile.md) object  
Required: No

 ** Role **   <a name="TransferFamily-Type-DescribedUser-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** SshPublicKeys **   <a name="TransferFamily-Type-DescribedUser-SshPublicKeys"></a>
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.  
To delete the public key body, set its value to zero keys, as shown here:  
 `SshPublicKeys: []` 
Type: Array of [SshPublicKey](API_SshPublicKey.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedUser-Tags"></a>
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** UserName **   <a name="TransferFamily-Type-DescribedUser-UserName"></a>
Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Pattern: `[\w][\w@.-]{2,99}`   
Required: No

## See Also
<a name="API_DescribedUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedUser) 

# DescribedWebApp
<a name="API_DescribedWebApp"></a>

A structure that describes the parameters for the web app, as identified by the `WebAppId`.

## Contents
<a name="API_DescribedWebApp_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedWebApp-Arn"></a>
The Amazon Resource Name (ARN) of the web app.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** WebAppId **   <a name="TransferFamily-Type-DescribedWebApp-WebAppId"></a>
The unique identifier for the web app.  
Type: String  
Length Constraints: Fixed length of 24.  
Pattern: `webapp-[0-9a-f]{17}`   
Required: Yes

 ** AccessEndpoint **   <a name="TransferFamily-Type-DescribedWebApp-AccessEndpoint"></a>
The `AccessEndpoint` is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** DescribedEndpointDetails **   <a name="TransferFamily-Type-DescribedWebApp-DescribedEndpointDetails"></a>
The endpoint configuration details for the web app, including VPC settings if the endpoint is hosted within a VPC.  
Type: [DescribedWebAppEndpointDetails](API_DescribedWebAppEndpointDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** DescribedIdentityProviderDetails **   <a name="TransferFamily-Type-DescribedWebApp-DescribedIdentityProviderDetails"></a>
A structure that contains the details for the identity provider used by the web app.  
Type: [DescribedWebAppIdentityProviderDetails](API_DescribedWebAppIdentityProviderDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** EndpointType **   <a name="TransferFamily-Type-DescribedWebApp-EndpointType"></a>
The type of endpoint hosting the web app. Valid values are `PUBLIC` for publicly accessible endpoints and `VPC` for VPC-hosted endpoints that provide network isolation.  
Type: String  
Valid Values: `PUBLIC | VPC`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedWebApp-Tags"></a>
Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** WebAppEndpoint **   <a name="TransferFamily-Type-DescribedWebApp-WebAppEndpoint"></a>
The `WebAppEndpoint` is the unique URL for your Transfer Family web app. This is the value that you use when you configure **Origins** on CloudFront.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** WebAppEndpointPolicy **   <a name="TransferFamily-Type-DescribedWebApp-WebAppEndpointPolicy"></a>
 Setting for the type of endpoint policy for the web app. The default value is `STANDARD`.   
If your web app was created in an AWS GovCloud (US) Region, the value of this parameter can be `FIPS`, which indicates the web app endpoint is FIPS-compliant.  
Type: String  
Valid Values: `FIPS | STANDARD`   
Required: No

 ** WebAppUnits **   <a name="TransferFamily-Type-DescribedWebApp-WebAppUnits"></a>
A union that contains the value for number of concurrent connections or the user sessions on your web app.  
Type: [WebAppUnits](API_WebAppUnits.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_DescribedWebApp_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWebApp) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWebApp) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWebApp) 

# DescribedWebAppCustomization
<a name="API_DescribedWebAppCustomization"></a>

A structure that contains the customization fields for the web app. You can provide a title, logo, and icon to customize the appearance of your web app.

## Contents
<a name="API_DescribedWebAppCustomization_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedWebAppCustomization-Arn"></a>
Returns the Amazon Resource Name (ARN) for the web app.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** WebAppId **   <a name="TransferFamily-Type-DescribedWebAppCustomization-WebAppId"></a>
Returns the unique identifier for your web app.  
Type: String  
Length Constraints: Fixed length of 24.  
Pattern: `webapp-[0-9a-f]{17}`   
Required: Yes

 ** FaviconFile **   <a name="TransferFamily-Type-DescribedWebAppCustomization-FaviconFile"></a>
Returns an icon file data string (in base64 encoding).  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 20960.  
Required: No

 ** LogoFile **   <a name="TransferFamily-Type-DescribedWebAppCustomization-LogoFile"></a>
Returns a logo file data string (in base64 encoding).  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** Title **   <a name="TransferFamily-Type-DescribedWebAppCustomization-Title"></a>
Returns the page title that you defined for your web app.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: No

## See Also
<a name="API_DescribedWebAppCustomization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWebAppCustomization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWebAppCustomization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWebAppCustomization) 

# DescribedWebAppEndpointDetails
<a name="API_DescribedWebAppEndpointDetails"></a>

Contains the endpoint configuration details for a web app, including VPC configuration when the endpoint is hosted within a VPC.

## Contents
<a name="API_DescribedWebAppEndpointDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** Vpc **   <a name="TransferFamily-Type-DescribedWebAppEndpointDetails-Vpc"></a>
The VPC configuration details when the web app endpoint is hosted within a VPC. This includes the VPC ID, subnet IDs, and VPC endpoint ID.  
Type: [DescribedWebAppVpcConfig](API_DescribedWebAppVpcConfig.md) object  
Required: No

## See Also
<a name="API_DescribedWebAppEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWebAppEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWebAppEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWebAppEndpointDetails) 

# DescribedWebAppIdentityProviderDetails
<a name="API_DescribedWebAppIdentityProviderDetails"></a>

Returns a structure that contains the identity provider details for your web app.

## Contents
<a name="API_DescribedWebAppIdentityProviderDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** IdentityCenterConfig **   <a name="TransferFamily-Type-DescribedWebAppIdentityProviderDetails-IdentityCenterConfig"></a>
Returns a structure for your identity provider details. This structure contains the instance ARN and role being used for the web app.  
Type: [DescribedIdentityCenterConfig](API_DescribedIdentityCenterConfig.md) object  
Required: No

## See Also
<a name="API_DescribedWebAppIdentityProviderDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWebAppIdentityProviderDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWebAppIdentityProviderDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWebAppIdentityProviderDetails) 

# DescribedWebAppVpcConfig
<a name="API_DescribedWebAppVpcConfig"></a>

Contains the VPC configuration details for a web app endpoint, including the VPC identifier, subnet IDs, and VPC endpoint ID used for hosting the endpoint.

## Contents
<a name="API_DescribedWebAppVpcConfig_Contents"></a>

 ** SubnetIds **   <a name="TransferFamily-Type-DescribedWebAppVpcConfig-SubnetIds"></a>
The list of subnet IDs within the VPC where the web app endpoint is deployed. These subnets must be in the same VPC and provide network connectivity for the endpoint.  
Type: Array of strings  
Required: No

 ** VpcEndpointId **   <a name="TransferFamily-Type-DescribedWebAppVpcConfig-VpcEndpointId"></a>
The identifier of the VPC endpoint created for the web app.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `vpce-[0-9a-f]{17}`   
Required: No

 ** VpcId **   <a name="TransferFamily-Type-DescribedWebAppVpcConfig-VpcId"></a>
The identifier of the VPC where the web app endpoint is hosted.  
Type: String  
Required: No

## See Also
<a name="API_DescribedWebAppVpcConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWebAppVpcConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWebAppVpcConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWebAppVpcConfig) 

# DescribedWorkflow
<a name="API_DescribedWorkflow"></a>

Describes the properties of the specified workflow

## Contents
<a name="API_DescribedWorkflow_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-DescribedWorkflow-Arn"></a>
Specifies the unique Amazon Resource Name (ARN) for the workflow.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** Description **   <a name="TransferFamily-Type-DescribedWorkflow-Description"></a>
Specifies the text description for the workflow.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[\w- ]*`   
Required: No

 ** OnExceptionSteps **   <a name="TransferFamily-Type-DescribedWorkflow-OnExceptionSteps"></a>
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.  
Type: Array of [WorkflowStep](API_WorkflowStep.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 8 items.  
Required: No

 ** Steps **   <a name="TransferFamily-Type-DescribedWorkflow-Steps"></a>
Specifies the details for the steps that are in the specified workflow.  
Type: Array of [WorkflowStep](API_WorkflowStep.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 8 items.  
Required: No

 ** Tags **   <a name="TransferFamily-Type-DescribedWorkflow-Tags"></a>
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** WorkflowId **   <a name="TransferFamily-Type-DescribedWorkflow-WorkflowId"></a>
A unique identifier for the workflow.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `w-([a-z0-9]{17})`   
Required: No

## See Also
<a name="API_DescribedWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribedWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribedWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribedWorkflow) 

# EfsFileLocation
<a name="API_EfsFileLocation"></a>

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.

 

## Contents
<a name="API_EfsFileLocation_Contents"></a>

 ** FileSystemId **   <a name="TransferFamily-Type-EfsFileLocation-FileSystemId"></a>
The identifier of the file system, assigned by Amazon EFS.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})`   
Required: No

 ** Path **   <a name="TransferFamily-Type-EfsFileLocation-Path"></a>
The pathname for the folder being used by a workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[^\x00]+`   
Required: No

## See Also
<a name="API_EfsFileLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/EfsFileLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/EfsFileLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/EfsFileLocation) 

# EndpointDetails
<a name="API_EndpointDetails"></a>

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the `UpdateServer` API and attach an Elastic IP address to your server's endpoint.

**Note**  
 After May 19, 2021, you won't be able to create a server using `EndpointType=VPC_ENDPOINT` in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with `EndpointType=VPC_ENDPOINT` in your AWS account on or before May 19, 2021, you will not be affected. After this date, use `EndpointType`=`VPC`.  
For more information, see [Discontinuing the use of VPC\$1ENDPOINT](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint).  
It is recommended that you use `VPC` as the `EndpointType`. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with `EndpointType` set to `VPC_ENDPOINT`.

## Contents
<a name="API_EndpointDetails_Contents"></a>

 ** AddressAllocationIds **   <a name="TransferFamily-Type-EndpointDetails-AddressAllocationIds"></a>
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.  
An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the `allocationId` field from the Amazon EC2 [Address](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) data type. One way to retrieve this value is by calling the EC2 [DescribeAddresses](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) API.  
This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see [Create an internet-facing endpoint for your server](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint).  
This property can only be set as follows:  
+  `EndpointType` must be set to `VPC` 
+ The Transfer Family server must be offline.
+ You cannot set this parameter for Transfer Family servers that use the FTP protocol.
+ The server must already have `SubnetIds` populated (`SubnetIds` and `AddressAllocationIds` cannot be updated simultaneously).
+  `AddressAllocationIds` can't contain duplicates, and must be equal in length to `SubnetIds`. For example, if you have three subnet IDs, you must also specify three address allocation IDs.
+ Call the `UpdateServer` API to set or change this parameter.
+ You can't set address allocation IDs for servers that have an `IpAddressType` set to `DUALSTACK` You can only set this property if `IpAddressType` is set to `IPV4`.
Type: Array of strings  
Required: No

 ** SecurityGroupIds **   <a name="TransferFamily-Type-EndpointDetails-SecurityGroupIds"></a>
A list of security groups IDs that are available to attach to your server's endpoint.  
While `SecurityGroupIds` appears in the response syntax for consistency with `CreateServer` and `UpdateServer` operations, this field is not populated in `DescribeServer` responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 `DescribeVpcEndpoints` API with the `VpcEndpointId` returned in the response.  
This property can only be set when `EndpointType` is set to `VPC`.  
You can edit the `SecurityGroupIds` property in the [UpdateServer](https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) API only if you are changing the `EndpointType` from `PUBLIC` or `VPC_ENDPOINT` to `VPC`. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 [ModifyVpcEndpoint](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) API.
Type: Array of strings  
Length Constraints: Minimum length of 11. Maximum length of 20.  
Pattern: `sg-[0-9a-f]{8,17}`   
Required: No

 ** SubnetIds **   <a name="TransferFamily-Type-EndpointDetails-SubnetIds"></a>
A list of subnet IDs that are required to host your server endpoint in your VPC.  
This property can only be set when `EndpointType` is set to `VPC`.
Type: Array of strings  
Required: No

 ** VpcEndpointId **   <a name="TransferFamily-Type-EndpointDetails-VpcEndpointId"></a>
The identifier of the VPC endpoint.  
This property can only be set when `EndpointType` is set to `VPC_ENDPOINT`.  
For more information, see [Discontinuing the use of VPC\$1ENDPOINT](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint).
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `vpce-[0-9a-f]{17}`   
Required: No

 ** VpcId **   <a name="TransferFamily-Type-EndpointDetails-VpcId"></a>
The VPC identifier of the VPC in which a server's endpoint will be hosted.  
This property can only be set when `EndpointType` is set to `VPC`.
Type: String  
Required: No

## See Also
<a name="API_EndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/EndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/EndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/EndpointDetails) 

# ExecutionError
<a name="API_ExecutionError"></a>

Specifies the error message and type, for an error that occurs during the execution of the workflow.

## Contents
<a name="API_ExecutionError_Contents"></a>

 ** Message **   <a name="TransferFamily-Type-ExecutionError-Message"></a>
Specifies the descriptive message that corresponds to the `ErrorType`.  
Type: String  
Required: Yes

 ** Type **   <a name="TransferFamily-Type-ExecutionError-Type"></a>
Specifies the error type.  
+  `ALREADY_EXISTS`: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
+  `BAD_REQUEST`: a general bad request: for example, a step that attempts to tag an EFS file returns `BAD_REQUEST`, as only S3 files can be tagged.
+  `CUSTOM_STEP_FAILED`: occurs when the custom step provided a callback that indicates failure.
+  `INTERNAL_SERVER_ERROR`: a catch-all error that can occur for a variety of reasons.
+  `NOT_FOUND`: occurs when a requested entity, for example a source file for a copy step, does not exist.
+  `PERMISSION_DENIED`: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
+  `TIMEOUT`: occurs when the execution times out.
**Note**  
 You can set the `TimeoutSeconds` for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). 
+  `THROTTLED`: occurs if you exceed the new execution refill rate of one workflow per second.
Type: String  
Valid Values: `PERMISSION_DENIED | CUSTOM_STEP_FAILED | THROTTLED | ALREADY_EXISTS | NOT_FOUND | BAD_REQUEST | TIMEOUT | INTERNAL_SERVER_ERROR`   
Required: Yes

## See Also
<a name="API_ExecutionError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ExecutionError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ExecutionError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ExecutionError) 

# ExecutionResults
<a name="API_ExecutionResults"></a>

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

## Contents
<a name="API_ExecutionResults_Contents"></a>

 ** OnExceptionSteps **   <a name="TransferFamily-Type-ExecutionResults-OnExceptionSteps"></a>
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.  
Type: Array of [ExecutionStepResult](API_ExecutionStepResult.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** Steps **   <a name="TransferFamily-Type-ExecutionResults-Steps"></a>
Specifies the details for the steps that are in the specified workflow.  
Type: Array of [ExecutionStepResult](API_ExecutionStepResult.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_ExecutionResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ExecutionResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ExecutionResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ExecutionResults) 

# ExecutionStepResult
<a name="API_ExecutionStepResult"></a>

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

## Contents
<a name="API_ExecutionStepResult_Contents"></a>

 ** Error **   <a name="TransferFamily-Type-ExecutionStepResult-Error"></a>
Specifies the details for an error, if it occurred during execution of the specified workflow step.  
Type: [ExecutionError](API_ExecutionError.md) object  
Required: No

 ** Outputs **   <a name="TransferFamily-Type-ExecutionStepResult-Outputs"></a>
The values for the key/value pair applied as a tag to the file. Only applicable if the step type is `TAG`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 65536.  
Required: No

 ** StepType **   <a name="TransferFamily-Type-ExecutionStepResult-StepType"></a>
One of the available step types.  
+  ** `COPY` ** - Copy the file to another location.
+  ** `CUSTOM` ** - Perform a custom step with an AWS Lambda function target.
+  ** `DECRYPT` ** - Decrypt a file that was encrypted before it was uploaded.
+  ** `DELETE` ** - Delete the file.
+  ** `TAG` ** - Add a tag to the file.
Type: String  
Valid Values: `COPY | CUSTOM | TAG | DELETE | DECRYPT`   
Required: No

## See Also
<a name="API_ExecutionStepResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ExecutionStepResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ExecutionStepResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ExecutionStepResult) 

# FileLocation
<a name="API_FileLocation"></a>

Specifies the Amazon S3 or EFS file details to be used in the step.

## Contents
<a name="API_FileLocation_Contents"></a>

 ** EfsFileLocation **   <a name="TransferFamily-Type-FileLocation-EfsFileLocation"></a>
Specifies the Amazon EFS identifier and the path for the file being used.  
Type: [EfsFileLocation](API_EfsFileLocation.md) object  
Required: No

 ** S3FileLocation **   <a name="TransferFamily-Type-FileLocation-S3FileLocation"></a>
Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.  
Type: [S3FileLocation](API_S3FileLocation.md) object  
Required: No

## See Also
<a name="API_FileLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/FileLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/FileLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/FileLocation) 

# HomeDirectoryMapEntry
<a name="API_HomeDirectoryMapEntry"></a>

Represents an object that contains entries and targets for `HomeDirectoryMappings`.

The following is an `Entry` and `Target` pair example for `chroot`.

 `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]` 

## Contents
<a name="API_HomeDirectoryMapEntry_Contents"></a>

 ** Entry **   <a name="TransferFamily-Type-HomeDirectoryMapEntry-Entry"></a>
Represents an entry for `HomeDirectoryMappings`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `/.*`   
Required: Yes

 ** Target **   <a name="TransferFamily-Type-HomeDirectoryMapEntry-Target"></a>
Represents the map target that is used in a `HomeDirectoryMapEntry`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `/.*`   
Required: Yes

 ** Type **   <a name="TransferFamily-Type-HomeDirectoryMapEntry-Type"></a>
Specifies the type of mapping. Set the type to `FILE` if you want the mapping to point to a file, or `DIRECTORY` for the directory to point to a directory.  
By default, home directory mappings have a `Type` of `DIRECTORY` when you create a Transfer Family server. You would need to explicitly set `Type` to `FILE` if you want a mapping to have a file target.
Type: String  
Valid Values: `FILE | DIRECTORY`   
Required: No

## See Also
<a name="API_HomeDirectoryMapEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/HomeDirectoryMapEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/HomeDirectoryMapEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/HomeDirectoryMapEntry) 

# IdentityCenterConfig
<a name="API_IdentityCenterConfig"></a>

A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.

## Contents
<a name="API_IdentityCenterConfig_Contents"></a>

 ** InstanceArn **   <a name="TransferFamily-Type-IdentityCenterConfig-InstanceArn"></a>
The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[\w-]+:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** Role **   <a name="TransferFamily-Type-IdentityCenterConfig-Role"></a>
The IAM role in IAM Identity Center used for the web app.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

## See Also
<a name="API_IdentityCenterConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/IdentityCenterConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/IdentityCenterConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/IdentityCenterConfig) 

# IdentityProviderDetails
<a name="API_IdentityProviderDetails"></a>

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

## Contents
<a name="API_IdentityProviderDetails_Contents"></a>

 ** DirectoryId **   <a name="TransferFamily-Type-IdentityProviderDetails-DirectoryId"></a>
The identifier of the AWS Directory Service directory that you want to use as your identity provider.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `d-[0-9a-f]{10}`   
Required: No

 ** Function **   <a name="TransferFamily-Type-IdentityProviderDetails-Function"></a>
The ARN for a Lambda function to use for the Identity provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 170.  
Pattern: `arn:[a-z-]+:lambda:.*`   
Required: No

 ** InvocationRole **   <a name="TransferFamily-Type-IdentityProviderDetails-InvocationRole"></a>
This parameter is only applicable if your `IdentityProviderType` is `API_GATEWAY`. Provides the type of `InvocationRole` used to authenticate the user account.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** SftpAuthenticationMethods **   <a name="TransferFamily-Type-IdentityProviderDetails-SftpAuthenticationMethods"></a>
For SFTP-enabled servers, and for custom identity providers *only*, you can specify whether to authenticate using a password, SSH key pair, or both.  
+  `PASSWORD` - users must provide their password to connect.
+  `PUBLIC_KEY` - users must provide their private key to connect.
+  `PUBLIC_KEY_OR_PASSWORD` - users can authenticate with either their password or their key. This is the default value.
+  `PUBLIC_KEY_AND_PASSWORD` - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.
Type: String  
Valid Values: `PASSWORD | PUBLIC_KEY | PUBLIC_KEY_OR_PASSWORD | PUBLIC_KEY_AND_PASSWORD`   
Required: No

 ** Url **   <a name="TransferFamily-Type-IdentityProviderDetails-Url"></a>
Provides the location of the service endpoint used to authenticate users.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

## See Also
<a name="API_IdentityProviderDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/IdentityProviderDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/IdentityProviderDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/IdentityProviderDetails) 

# InputFileLocation
<a name="API_InputFileLocation"></a>

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

## Contents
<a name="API_InputFileLocation_Contents"></a>

 ** EfsFileLocation **   <a name="TransferFamily-Type-InputFileLocation-EfsFileLocation"></a>
Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.  
Type: [EfsFileLocation](API_EfsFileLocation.md) object  
Required: No

 ** S3FileLocation **   <a name="TransferFamily-Type-InputFileLocation-S3FileLocation"></a>
Specifies the details for the Amazon S3 file that's being copied or decrypted.  
Type: [S3InputFileLocation](API_S3InputFileLocation.md) object  
Required: No

## See Also
<a name="API_InputFileLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/InputFileLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/InputFileLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/InputFileLocation) 

# ListedAccess
<a name="API_ListedAccess"></a>

Lists the properties for one or more specified associated accesses.

## Contents
<a name="API_ListedAccess_Contents"></a>

 ** ExternalId **   <a name="TransferFamily-Type-ListedAccess-ExternalId"></a>
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.  
 `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid`   
In that command, replace *YourGroupName* with the name of your Active Directory group.  
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `S-1-[\d-]+`   
Required: No

 ** HomeDirectory **   <a name="TransferFamily-Type-ListedAccess-HomeDirectory"></a>
The landing directory (folder) for a user when they log in to the server using the client.  
A `HomeDirectory` example is `/bucket_name/home/mydirectory`.  
You can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: No

 ** HomeDirectoryType **   <a name="TransferFamily-Type-ListedAccess-HomeDirectoryType"></a>
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users.  
If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH`, you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template.
Type: String  
Valid Values: `PATH | LOGICAL`   
Required: No

 ** Role **   <a name="TransferFamily-Type-ListedAccess-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

## See Also
<a name="API_ListedAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedAccess) 

# ListedAgreement
<a name="API_ListedAgreement"></a>

Describes the properties of an agreement.

## Contents
<a name="API_ListedAgreement_Contents"></a>

 ** AgreementId **   <a name="TransferFamily-Type-ListedAgreement-AgreementId"></a>
A unique identifier for the agreement. This identifier is returned when you create an agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `a-([0-9a-f]{17})`   
Required: No

 ** Arn **   <a name="TransferFamily-Type-ListedAgreement-Arn"></a>
The Amazon Resource Name (ARN) of the specified agreement.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** Description **   <a name="TransferFamily-Type-ListedAgreement-Description"></a>
The current description for the agreement. You can change it by calling the `UpdateAgreement` operation and providing a new description.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0021-\u007E]+`   
Required: No

 ** LocalProfileId **   <a name="TransferFamily-Type-ListedAgreement-LocalProfileId"></a>
A unique identifier for the AS2 local profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** PartnerProfileId **   <a name="TransferFamily-Type-ListedAgreement-PartnerProfileId"></a>
A unique identifier for the partner profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** ServerId **   <a name="TransferFamily-Type-ListedAgreement-ServerId"></a>
The unique identifier for the agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: No

 ** Status **   <a name="TransferFamily-Type-ListedAgreement-Status"></a>
The agreement can be either `ACTIVE` or `INACTIVE`.  
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

## See Also
<a name="API_ListedAgreement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedAgreement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedAgreement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedAgreement) 

# ListedCertificate
<a name="API_ListedCertificate"></a>

Describes the properties of a certificate.

## Contents
<a name="API_ListedCertificate_Contents"></a>

 ** ActiveDate **   <a name="TransferFamily-Type-ListedCertificate-ActiveDate"></a>
An optional date that specifies when the certificate becomes active. If you do not specify a value, `ActiveDate` takes the same value as `NotBeforeDate`, which is specified by the CA.   
Type: Timestamp  
Required: No

 ** Arn **   <a name="TransferFamily-Type-ListedCertificate-Arn"></a>
The Amazon Resource Name (ARN) of the specified certificate.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** CertificateId **   <a name="TransferFamily-Type-ListedCertificate-CertificateId"></a>
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `cert-([0-9a-f]{17})`   
Required: No

 ** Description **   <a name="TransferFamily-Type-ListedCertificate-Description"></a>
The name or short description that's used to identify the certificate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0021-\u007E]+`   
Required: No

 ** InactiveDate **   <a name="TransferFamily-Type-ListedCertificate-InactiveDate"></a>
An optional date that specifies when the certificate becomes inactive. If you do not specify a value, `InactiveDate` takes the same value as `NotAfterDate`, which is specified by the CA.  
Type: Timestamp  
Required: No

 ** Status **   <a name="TransferFamily-Type-ListedCertificate-Status"></a>
The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`. `PENDING_ROTATION` means that this certificate will replace the current certificate when it expires.  
Type: String  
Valid Values: `ACTIVE | PENDING_ROTATION | INACTIVE`   
Required: No

 ** Type **   <a name="TransferFamily-Type-ListedCertificate-Type"></a>
The type for the certificate. If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`. If there is no private key, the type is `CERTIFICATE`.  
Type: String  
Valid Values: `CERTIFICATE | CERTIFICATE_WITH_PRIVATE_KEY`   
Required: No

 ** Usage **   <a name="TransferFamily-Type-ListedCertificate-Usage"></a>
Specifies how this certificate is used. It can be used in the following ways:  
+  `SIGNING`: For signing AS2 messages
+  `ENCRYPTION`: For encrypting AS2 messages
+  `TLS`: For securing AS2 communications sent over HTTPS
Type: String  
Valid Values: `SIGNING | ENCRYPTION | TLS`   
Required: No

## See Also
<a name="API_ListedCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedCertificate) 

# ListedConnector
<a name="API_ListedConnector"></a>

Returns details of the connector that is specified.

## Contents
<a name="API_ListedConnector_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedConnector-Arn"></a>
The Amazon Resource Name (ARN) of the specified connector.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** ConnectorId **   <a name="TransferFamily-Type-ListedConnector-ConnectorId"></a>
The unique identifier for the connector.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `c-([0-9a-f]{17})`   
Required: No

 ** Url **   <a name="TransferFamily-Type-ListedConnector-Url"></a>
The URL of the partner's AS2 or SFTP endpoint.  
When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

## See Also
<a name="API_ListedConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedConnector) 

# ListedExecution
<a name="API_ListedExecution"></a>

Returns properties of the execution that is specified.

## Contents
<a name="API_ListedExecution_Contents"></a>

 ** ExecutionId **   <a name="TransferFamily-Type-ListedExecution-ExecutionId"></a>
A unique identifier for the execution of a workflow.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}`   
Required: No

 ** InitialFileLocation **   <a name="TransferFamily-Type-ListedExecution-InitialFileLocation"></a>
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.  
Type: [FileLocation](API_FileLocation.md) object  
Required: No

 ** ServiceMetadata **   <a name="TransferFamily-Type-ListedExecution-ServiceMetadata"></a>
A container object for the session details that are associated with a workflow.  
Type: [ServiceMetadata](API_ServiceMetadata.md) object  
Required: No

 ** Status **   <a name="TransferFamily-Type-ListedExecution-Status"></a>
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | EXCEPTION | HANDLING_EXCEPTION`   
Required: No

## See Also
<a name="API_ListedExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedExecution) 

# ListedHostKey
<a name="API_ListedHostKey"></a>

Returns properties of the host key that's specified.

## Contents
<a name="API_ListedHostKey_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedHostKey-Arn"></a>
The unique Amazon Resource Name (ARN) of the host key.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** DateImported **   <a name="TransferFamily-Type-ListedHostKey-DateImported"></a>
The date on which the host key was added to the server.  
Type: Timestamp  
Required: No

 ** Description **   <a name="TransferFamily-Type-ListedHostKey-Description"></a>
The current description for the host key. You can change it by calling the `UpdateHostKey` operation and providing a new description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `[\p{Print}]*`   
Required: No

 ** Fingerprint **   <a name="TransferFamily-Type-ListedHostKey-Fingerprint"></a>
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.  
Type: String  
Required: No

 ** HostKeyId **   <a name="TransferFamily-Type-ListedHostKey-HostKeyId"></a>
A unique identifier for the host key.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `hostkey-[0-9a-f]{17}`   
Required: No

 ** Type **   <a name="TransferFamily-Type-ListedHostKey-Type"></a>
The encryption algorithm that is used for the host key. The `Type` parameter is specified by using one of the following values:  
+  `ssh-rsa` 
+  `ssh-ed25519` 
+  `ecdsa-sha2-nistp256` 
+  `ecdsa-sha2-nistp384` 
+  `ecdsa-sha2-nistp521` 
Type: String  
Required: No

## See Also
<a name="API_ListedHostKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedHostKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedHostKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedHostKey) 

# ListedProfile
<a name="API_ListedProfile"></a>

Returns the properties of the profile that was specified.

## Contents
<a name="API_ListedProfile_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedProfile-Arn"></a>
The Amazon Resource Name (ARN) of the specified profile.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** As2Id **   <a name="TransferFamily-Type-ListedProfile-As2Id"></a>
The `As2Id` is the *AS2-name*, as defined in the [RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation. This ID cannot include spaces.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\u0020-\u007E\s]*`   
Required: No

 ** ProfileId **   <a name="TransferFamily-Type-ListedProfile-ProfileId"></a>
A unique identifier for the local or partner AS2 profile.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `p-([0-9a-f]{17})`   
Required: No

 ** ProfileType **   <a name="TransferFamily-Type-ListedProfile-ProfileType"></a>
Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles. If not supplied in the request, the command lists all types of profiles.  
Type: String  
Valid Values: `LOCAL | PARTNER`   
Required: No

## See Also
<a name="API_ListedProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedProfile) 

# ListedServer
<a name="API_ListedServer"></a>

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

## Contents
<a name="API_ListedServer_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedServer-Arn"></a>
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** Domain **   <a name="TransferFamily-Type-ListedServer-Domain"></a>
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.  
Type: String  
Valid Values: `S3 | EFS`   
Required: No

 ** EndpointType **   <a name="TransferFamily-Type-ListedServer-EndpointType"></a>
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.  
Type: String  
Valid Values: `PUBLIC | VPC | VPC_ENDPOINT`   
Required: No

 ** IdentityProviderType **   <a name="TransferFamily-Type-ListedServer-IdentityProviderType"></a>
The mode of authentication for a server. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service.  
Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter.  
Use the `API_GATEWAY` value to integrate with an identity provider of your choosing. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter.  
Use the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter for the `IdentityProviderDetails` data type.  
Type: String  
Valid Values: `SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA`   
Required: No

 ** LoggingRole **   <a name="TransferFamily-Type-ListedServer-LoggingRole"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** ServerId **   <a name="TransferFamily-Type-ListedServer-ServerId"></a>
Specifies the unique system assigned identifier for the servers that were listed.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: No

 ** State **   <a name="TransferFamily-Type-ListedServer-State"></a>
The condition of the server that was described. A value of `ONLINE` indicates that the server can accept jobs and transfer files. A `State` value of `OFFLINE` means that the server cannot perform file transfer operations.  
The states of `STARTING` and `STOPPING` indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of `START_FAILED` or `STOP_FAILED` can indicate an error condition.  
Type: String  
Valid Values: `OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED`   
Required: No

 ** UserCount **   <a name="TransferFamily-Type-ListedServer-UserCount"></a>
Specifies the number of users that are assigned to a server you specified with the `ServerId`.  
Type: Integer  
Required: No

## See Also
<a name="API_ListedServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedServer) 

# ListedUser
<a name="API_ListedUser"></a>

Returns properties of the user that you specify.

## Contents
<a name="API_ListedUser_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedUser-Arn"></a>
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** HomeDirectory **   <a name="TransferFamily-Type-ListedUser-HomeDirectory"></a>
The landing directory (folder) for a user when they log in to the server using the client.  
A `HomeDirectory` example is `/bucket_name/home/mydirectory`.  
You can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `(|/.*)`   
Required: No

 ** HomeDirectoryType **   <a name="TransferFamily-Type-ListedUser-HomeDirectoryType"></a>
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users.  
If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH`, you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template.
Type: String  
Valid Values: `PATH | LOGICAL`   
Required: No

 ** Role **   <a name="TransferFamily-Type-ListedUser-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.  
The IAM role that controls your users' access to your Amazon S3 bucket for servers with `Domain=S3`, or your EFS file system for servers with `Domain=EFS`.   
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** SshPublicKeyCount **   <a name="TransferFamily-Type-ListedUser-SshPublicKeyCount"></a>
Specifies the number of SSH public keys stored for the user you specified.  
Type: Integer  
Required: No

 ** UserName **   <a name="TransferFamily-Type-ListedUser-UserName"></a>
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Pattern: `[\w][\w@.-]{2,99}`   
Required: No

## See Also
<a name="API_ListedUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedUser) 

# ListedWebApp
<a name="API_ListedWebApp"></a>

 a structure that contains details for the web app.

## Contents
<a name="API_ListedWebApp_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedWebApp-Arn"></a>
The Amazon Resource Name (ARN) for the web app.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: Yes

 ** WebAppId **   <a name="TransferFamily-Type-ListedWebApp-WebAppId"></a>
The unique identifier for the web app.  
Type: String  
Length Constraints: Fixed length of 24.  
Pattern: `webapp-[0-9a-f]{17}`   
Required: Yes

 ** AccessEndpoint **   <a name="TransferFamily-Type-ListedWebApp-AccessEndpoint"></a>
The `AccessEndpoint` is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** EndpointType **   <a name="TransferFamily-Type-ListedWebApp-EndpointType"></a>
The type of endpoint hosting the web app. Valid values are `PUBLIC` for publicly accessible endpoints and `VPC` for VPC-hosted endpoints.  
Type: String  
Valid Values: `PUBLIC | VPC`   
Required: No

 ** WebAppEndpoint **   <a name="TransferFamily-Type-ListedWebApp-WebAppEndpoint"></a>
The `WebAppEndpoint` is the unique URL for your Transfer Family web app. This is the value that you use when you configure **Origins** on CloudFront.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_ListedWebApp_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedWebApp) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedWebApp) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedWebApp) 

# ListedWorkflow
<a name="API_ListedWorkflow"></a>

Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.

## Contents
<a name="API_ListedWorkflow_Contents"></a>

 ** Arn **   <a name="TransferFamily-Type-ListedWorkflow-Arn"></a>
Specifies the unique Amazon Resource Name (ARN) for the workflow.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1600.  
Pattern: `arn:\S+`   
Required: No

 ** Description **   <a name="TransferFamily-Type-ListedWorkflow-Description"></a>
Specifies the text description for the workflow.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[\w- ]*`   
Required: No

 ** WorkflowId **   <a name="TransferFamily-Type-ListedWorkflow-WorkflowId"></a>
A unique identifier for the workflow.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `w-([a-z0-9]{17})`   
Required: No

## See Also
<a name="API_ListedWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListedWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListedWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListedWorkflow) 

# LoggingConfiguration
<a name="API_LoggingConfiguration"></a>

Consists of the logging role and the log group name.

## Contents
<a name="API_LoggingConfiguration_Contents"></a>

 ** LoggingRole **   <a name="TransferFamily-Type-LoggingConfiguration-LoggingRole"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

 ** LogGroupName **   <a name="TransferFamily-Type-LoggingConfiguration-LogGroupName"></a>
The name of the CloudWatch logging group for the AWS Transfer Family server to which this workflow belongs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `[\.\-_/#A-Za-z0-9]*`   
Required: No

## See Also
<a name="API_LoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/LoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/LoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/LoggingConfiguration) 

# PosixProfile
<a name="API_PosixProfile"></a>

The full POSIX identity, including user ID (`Uid`), group ID (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

## Contents
<a name="API_PosixProfile_Contents"></a>

 ** Gid **   <a name="TransferFamily-Type-PosixProfile-Gid"></a>
The POSIX group ID used for all EFS operations by this user.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** Uid **   <a name="TransferFamily-Type-PosixProfile-Uid"></a>
The POSIX user ID used for all EFS operations by this user.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** SecondaryGids **   <a name="TransferFamily-Type-PosixProfile-SecondaryGids"></a>
The secondary POSIX group IDs used for all EFS operations by this user.  
Type: Array of longs  
Array Members: Minimum number of 0 items. Maximum number of 16 items.  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: No

## See Also
<a name="API_PosixProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/PosixProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/PosixProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/PosixProfile) 

# ProtocolDetails
<a name="API_ProtocolDetails"></a>

 The protocol settings that are configured for your server. 

## Contents
<a name="API_ProtocolDetails_Contents"></a>

 ** As2Transports **   <a name="TransferFamily-Type-ProtocolDetails-As2Transports"></a>
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `HTTP`   
Required: No

 ** PassiveIp **   <a name="TransferFamily-Type-ProtocolDetails-PassiveIp"></a>
 Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:   
 `aws transfer update-server --protocol-details PassiveIp=0.0.0.0`   
Replace `0.0.0.0` in the example above with the actual IP address you want to use.  
 If you change the `PassiveIp` value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see [Configuring your FTPS server behind a firewall or NAT with AWS Transfer Family](http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/).   
Additionally, avoid placing Network Load Balancers (NLBs) or NAT gateways in front of AWS Transfer Family servers. This configuration increases costs and can cause performance issues. When NLBs or NATs are in the communication path, Transfer Family cannot accurately recognize client IP addresses, which impacts connection sharding and limits FTPS servers to only 300 simultaneous connections instead of 10,000. If you must use an NLB, use port 21 for health checks and enable TLS session resumption by setting `TlsSessionResumptionMode = ENFORCED`. For optimal performance, migrate to VPC endpoints with Elastic IP addresses instead of using NLBs. For more details, see [ Avoid placing NLBs and NATs in front of AWS Transfer Family](https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations). 
 *Special values*   
The `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. `PassiveIp=0.0.0.0` has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter. This reduces the effectiveness of having High Availability. In this case, you can specify `PassiveIp=0.0.0.0`. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Required: No

 ** SetStatOption **   <a name="TransferFamily-Type-ProtocolDetails-SetStatOption"></a>
Use the `SetStatOption` to ignore the error that is generated when the client attempts to use `SETSTAT` on a file you are uploading to an S3 bucket.  
Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as `SETSTAT` when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.  
Set the value to `ENABLE_NO_OP` to have the Transfer Family server ignore the `SETSTAT` command, and upload files without needing to make any changes to your SFTP client. While the `SetStatOption` `ENABLE_NO_OP` setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call.  
If you want to preserve the original timestamp for your file, and modify other file attributes using `SETSTAT`, you can use Amazon EFS as backend storage with Transfer Family.
Type: String  
Valid Values: `DEFAULT | ENABLE_NO_OP`   
Required: No

 ** TlsSessionResumptionMode **   <a name="TransferFamily-Type-ProtocolDetails-TlsSessionResumptionMode"></a>
A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. `TlsSessionResumptionMode` determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during `CreateServer` and `UpdateServer` calls. If a `TlsSessionResumptionMode` value is not specified during `CreateServer`, it is set to `ENFORCED` by default.  
+  `DISABLED`: the server does not process TLS session resumption client requests and creates a new TLS session for each request. 
+  `ENABLED`: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
+  `ENFORCED`: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to `ENFORCED`, test your clients.
**Note**  
Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the `ENFORCED` value, you need to test your clients.
Type: String  
Valid Values: `DISABLED | ENABLED | ENFORCED`   
Required: No

## See Also
<a name="API_ProtocolDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ProtocolDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ProtocolDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ProtocolDetails) 

# S3FileLocation
<a name="API_S3FileLocation"></a>

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage.

## Contents
<a name="API_S3FileLocation_Contents"></a>

 ** Bucket **   <a name="TransferFamily-Type-S3FileLocation-Bucket"></a>
Specifies the S3 bucket that contains the file being used.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: No

 ** Etag **   <a name="TransferFamily-Type-S3FileLocation-Etag"></a>
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `.+`   
Required: No

 ** Key **   <a name="TransferFamily-Type-S3FileLocation-Key"></a>
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `[\P{M}\p{M}]*`   
Required: No

 ** VersionId **   <a name="TransferFamily-Type-S3FileLocation-VersionId"></a>
Specifies the file version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.+`   
Required: No

## See Also
<a name="API_S3FileLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/S3FileLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/S3FileLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/S3FileLocation) 

# S3InputFileLocation
<a name="API_S3InputFileLocation"></a>

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.

## Contents
<a name="API_S3InputFileLocation_Contents"></a>

 ** Bucket **   <a name="TransferFamily-Type-S3InputFileLocation-Bucket"></a>
Specifies the S3 bucket for the customer input file.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: No

 ** Key **   <a name="TransferFamily-Type-S3InputFileLocation-Key"></a>
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `[\P{M}\p{M}]*`   
Required: No

## See Also
<a name="API_S3InputFileLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/S3InputFileLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/S3InputFileLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/S3InputFileLocation) 

# S3StorageOptions
<a name="API_S3StorageOptions"></a>

The Amazon S3 storage options that are configured for your server.

## Contents
<a name="API_S3StorageOptions_Contents"></a>

 ** DirectoryListingOptimization **   <a name="TransferFamily-Type-S3StorageOptions-DirectoryListingOptimization"></a>
Specifies whether or not performance for your Amazon S3 directories is optimized.  
+ If using the console, this is enabled by default.
+ If using the API or CLI, this is disabled by default.
By default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## See Also
<a name="API_S3StorageOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/S3StorageOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/S3StorageOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/S3StorageOptions) 

# S3Tag
<a name="API_S3Tag"></a>

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

## Contents
<a name="API_S3Tag_Contents"></a>

 ** Key **   <a name="TransferFamily-Type-S3Tag-Key"></a>
The name assigned to the tag that you create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

 ** Value **   <a name="TransferFamily-Type-S3Tag-Value"></a>
The value that corresponds to the key.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## See Also
<a name="API_S3Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/S3Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/S3Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/S3Tag) 

# ServiceMetadata
<a name="API_ServiceMetadata"></a>

A container object for the session details that are associated with a workflow.

## Contents
<a name="API_ServiceMetadata_Contents"></a>

 ** UserDetails **   <a name="TransferFamily-Type-ServiceMetadata-UserDetails"></a>
The Server ID (`ServerId`), Session ID (`SessionId`) and user (`UserName`) make up the `UserDetails`.  
Type: [UserDetails](API_UserDetails.md) object  
Required: Yes

## See Also
<a name="API_ServiceMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ServiceMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ServiceMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ServiceMetadata) 

# SftpConnectorConfig
<a name="API_SftpConnectorConfig"></a>

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

## Contents
<a name="API_SftpConnectorConfig_Contents"></a>

 ** MaxConcurrentConnections **   <a name="TransferFamily-Type-SftpConnectorConfig-MaxConcurrentConnections"></a>
Specify the number of concurrent connections that your connector creates to the remote server. The default value is `1`. The maximum values is `5`.  
If you are using the AWS Management Console, the default value is `5`.
This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** TrustedHostKeys **   <a name="TransferFamily-Type-SftpConnectorConfig-TrustedHostKeys"></a>
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.  
 `TrustedHostKeys` is optional for `CreateConnector`. If not provided, you can use `TestConnection` to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key.
When creating connectors with egress config (VPC\$1LATTICE type connectors), since host name is not something we can verify, the only accepted trusted host key format is `key-type key-body` without the host name. For example: `ssh-rsa AAAAB3Nza...<long-string-for-public-key>`   
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, AWS Transfer Family accepts RSA and ECDSA keys.  
+ For RSA keys, the `<key type>` string is `ssh-rsa`.
+ 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.
Run this command to retrieve the SFTP server host key, where your SFTP server name is `ftp.host.com`.  
 `ssh-keyscan ftp.host.com`   
This prints the public host key to standard output.  
 `ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key>`   
Copy and paste this string into the `TrustedHostKeys` field for the `create-connector` command or into the **Trusted host keys** field in the console.  
For VPC Lattice type connectors (VPC\$1LATTICE), remove the hostname from the key and use only the `key-type key-body` format. In this example, it should be: `ssh-rsa AAAAB3Nza...<long-string-for-public-key>`   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** UserSecretId **   <a name="TransferFamily-Type-SftpConnectorConfig-UserSecretId"></a>
The identifier for the secret (in AWS 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.  
+ Required when creating an SFTP connector
+ Optional when updating an existing SFTP connector
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_SftpConnectorConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/SftpConnectorConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/SftpConnectorConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/SftpConnectorConfig) 

# SftpConnectorConnectionDetails
<a name="API_SftpConnectorConnectionDetails"></a>

Contains the details for an SFTP connector connection.

## Contents
<a name="API_SftpConnectorConnectionDetails_Contents"></a>

 ** HostKey **   <a name="TransferFamily-Type-SftpConnectorConnectionDetails-HostKey"></a>
The SSH public key of the remote SFTP server. This is returned during the initial connection attempt when you call `TestConnection`. It allows you to retrieve the valid server host key to update the connector when you are unable to obtain it in advance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_SftpConnectorConnectionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/SftpConnectorConnectionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/SftpConnectorConnectionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/SftpConnectorConnectionDetails) 

# SshPublicKey
<a name="API_SshPublicKey"></a>

Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by `ServerId`). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

## Contents
<a name="API_SshPublicKey_Contents"></a>

 ** DateImported **   <a name="TransferFamily-Type-SshPublicKey-DateImported"></a>
Specifies the date that the public key was added to the Transfer Family user.  
Type: Timestamp  
Required: Yes

 ** SshPublicKeyBody **   <a name="TransferFamily-Type-SshPublicKey-SshPublicKeyBody"></a>
Specifies the content of the SSH public key as specified by the `PublicKeyId`.  
 AWS Transfer Family accepts RSA, ECDSA, and ED25519 keys.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `\s*(ssh|ecdsa)-[a-z0-9-]+[ \t]+(([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{1,3})?(={0,3})?)(\s*|[ \t]+[\S \t]*\s*)`   
Required: Yes

 ** SshPublicKeyId **   <a name="TransferFamily-Type-SshPublicKey-SshPublicKeyId"></a>
Specifies the `SshPublicKeyId` parameter contains the identifier of the public key.  
Type: String  
Length Constraints: Fixed length of 21.  
Pattern: `key-[0-9a-f]{17}`   
Required: Yes

## See Also
<a name="API_SshPublicKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/SshPublicKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/SshPublicKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/SshPublicKey) 

# Tag
<a name="API_Tag"></a>

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called `Group` and assign the values `Research` and `Accounting` to that group.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="TransferFamily-Type-Tag-Key"></a>
The name assigned to the tag that you create.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="TransferFamily-Type-Tag-Value"></a>
Contains one or more values that you assigned to the key name you create.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/Tag) 

# TagStepDetails
<a name="API_TagStepDetails"></a>

Each step type has its own `StepDetails` structure.

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

## Contents
<a name="API_TagStepDetails_Contents"></a>

 ** Name **   <a name="TransferFamily-Type-TagStepDetails-Name"></a>
The name of the step, used as an identifier.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30.  
Pattern: `[\w-]*`   
Required: No

 ** SourceFileLocation **   <a name="TransferFamily-Type-TagStepDetails-SourceFileLocation"></a>
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.  
+ To use the previous file as the input, enter `${previous.file}`. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
+ To use the originally uploaded file location as input for this step, enter `${original.file}`.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `\$\{(\w+.)+\w+\}`   
Required: No

 ** Tags **   <a name="TransferFamily-Type-TagStepDetails-Tags"></a>
Array that contains from 1 to 10 key/value pairs.  
Type: Array of [S3Tag](API_S3Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_TagStepDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/TagStepDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/TagStepDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/TagStepDetails) 

# UpdateConnectorEgressConfig
<a name="API_UpdateConnectorEgressConfig"></a>

Structure for updating the egress configuration of an existing connector. Allows modification of how traffic is routed from the connector to the SFTP server, including VPC\$1LATTICE settings.

## Contents
<a name="API_UpdateConnectorEgressConfig_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** VpcLattice **   <a name="TransferFamily-Type-UpdateConnectorEgressConfig-VpcLattice"></a>
VPC\$1LATTICE configuration updates for the connector. Use this to modify the Resource Configuration ARN or port number for VPC-based connectivity.  
Type: [UpdateConnectorVpcLatticeEgressConfig](API_UpdateConnectorVpcLatticeEgressConfig.md) object  
Required: No

## See Also
<a name="API_UpdateConnectorEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateConnectorEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateConnectorEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateConnectorEgressConfig) 

# UpdateConnectorVpcLatticeEgressConfig
<a name="API_UpdateConnectorVpcLatticeEgressConfig"></a>

VPC\$1LATTICE egress configuration updates for modifying how the connector routes traffic through customer VPCs. Changes to these settings may require connector restart to take effect.

## Contents
<a name="API_UpdateConnectorVpcLatticeEgressConfig_Contents"></a>

 ** PortNumber **   <a name="TransferFamily-Type-UpdateConnectorVpcLatticeEgressConfig-PortNumber"></a>
Updated port number for SFTP connections through VPC\$1LATTICE. Change this if the target SFTP server port has been modified or if connecting to a different server endpoint.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** ResourceConfigurationArn **   <a name="TransferFamily-Type-UpdateConnectorVpcLatticeEgressConfig-ResourceConfigurationArn"></a>
Updated ARN of the VPC\$1LATTICE Resource Configuration. Use this to change the target SFTP server location or modify the network path through the customer's VPC infrastructure.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}`   
Required: No

## See Also
<a name="API_UpdateConnectorVpcLatticeEgressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateConnectorVpcLatticeEgressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateConnectorVpcLatticeEgressConfig) 

# UpdateWebAppEndpointDetails
<a name="API_UpdateWebAppEndpointDetails"></a>

Contains the endpoint configuration details for updating a web app, including VPC settings for endpoints hosted within a VPC.

## Contents
<a name="API_UpdateWebAppEndpointDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** Vpc **   <a name="TransferFamily-Type-UpdateWebAppEndpointDetails-Vpc"></a>
The VPC configuration details for updating a web app endpoint hosted within a VPC. This includes the subnet IDs for endpoint deployment.  
Type: [UpdateWebAppVpcConfig](API_UpdateWebAppVpcConfig.md) object  
Required: No

## See Also
<a name="API_UpdateWebAppEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateWebAppEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateWebAppEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateWebAppEndpointDetails) 

# UpdateWebAppIdentityCenterConfig
<a name="API_UpdateWebAppIdentityCenterConfig"></a>

A structure that describes the values to use for the IAM Identity Center settings when you update a web app.

## Contents
<a name="API_UpdateWebAppIdentityCenterConfig_Contents"></a>

 ** Role **   <a name="TransferFamily-Type-UpdateWebAppIdentityCenterConfig-Role"></a>
The IAM role used to access IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: No

## See Also
<a name="API_UpdateWebAppIdentityCenterConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateWebAppIdentityCenterConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateWebAppIdentityCenterConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateWebAppIdentityCenterConfig) 

# UpdateWebAppIdentityProviderDetails
<a name="API_UpdateWebAppIdentityProviderDetails"></a>

A union that contains the `UpdateWebAppIdentityCenterConfig` object.

## Contents
<a name="API_UpdateWebAppIdentityProviderDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** IdentityCenterConfig **   <a name="TransferFamily-Type-UpdateWebAppIdentityProviderDetails-IdentityCenterConfig"></a>
A structure that describes the values to use for the IAM Identity Center settings when you update a web app.  
Type: [UpdateWebAppIdentityCenterConfig](API_UpdateWebAppIdentityCenterConfig.md) object  
Required: No

## See Also
<a name="API_UpdateWebAppIdentityProviderDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateWebAppIdentityProviderDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateWebAppIdentityProviderDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateWebAppIdentityProviderDetails) 

# UpdateWebAppVpcConfig
<a name="API_UpdateWebAppVpcConfig"></a>

Contains the VPC configuration settings for updating a web app endpoint, including the subnet IDs where the endpoint should be deployed.

## Contents
<a name="API_UpdateWebAppVpcConfig_Contents"></a>

 ** SubnetIds **   <a name="TransferFamily-Type-UpdateWebAppVpcConfig-SubnetIds"></a>
The list of subnet IDs within the VPC where the web app endpoint should be deployed during the update operation.  
Type: Array of strings  
Required: No

## See Also
<a name="API_UpdateWebAppVpcConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UpdateWebAppVpcConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UpdateWebAppVpcConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UpdateWebAppVpcConfig) 

# UserDetails
<a name="API_UserDetails"></a>

Specifies the user name, server ID, and session ID for a workflow.

## Contents
<a name="API_UserDetails_Contents"></a>

 ** ServerId **   <a name="TransferFamily-Type-UserDetails-ServerId"></a>
The system-assigned unique identifier for a Transfer server instance.   
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: Yes

 ** UserName **   <a name="TransferFamily-Type-UserDetails-UserName"></a>
A unique string that identifies a Transfer Family user associated with a server.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Pattern: `[\w][\w@.-]{2,99}`   
Required: Yes

 ** SessionId **   <a name="TransferFamily-Type-UserDetails-SessionId"></a>
The system-assigned unique identifier for a session that corresponds to the workflow.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[\w-]*`   
Required: No

## See Also
<a name="API_UserDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/UserDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/UserDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/UserDetails) 

# WebAppEndpointDetails
<a name="API_WebAppEndpointDetails"></a>

Contains the endpoint configuration for a web app, including VPC settings when the endpoint is hosted within a VPC.

## Contents
<a name="API_WebAppEndpointDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** Vpc **   <a name="TransferFamily-Type-WebAppEndpointDetails-Vpc"></a>
The VPC configuration for hosting the web app endpoint within a VPC.  
Type: [WebAppVpcConfig](API_WebAppVpcConfig.md) object  
Required: No

## See Also
<a name="API_WebAppEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WebAppEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WebAppEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WebAppEndpointDetails) 

# WebAppIdentityProviderDetails
<a name="API_WebAppIdentityProviderDetails"></a>

A union that contains the `IdentityCenterConfig` object.

## Contents
<a name="API_WebAppIdentityProviderDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** IdentityCenterConfig **   <a name="TransferFamily-Type-WebAppIdentityProviderDetails-IdentityCenterConfig"></a>
A structure that describes the values to use for the IAM Identity Center settings when you create a web app.  
Type: [IdentityCenterConfig](API_IdentityCenterConfig.md) object  
Required: No

## See Also
<a name="API_WebAppIdentityProviderDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WebAppIdentityProviderDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WebAppIdentityProviderDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WebAppIdentityProviderDetails) 

# WebAppUnits
<a name="API_WebAppUnits"></a>

Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.

## Contents
<a name="API_WebAppUnits_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** Provisioned **   <a name="TransferFamily-Type-WebAppUnits-Provisioned"></a>
An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.  
Each increment allows an additional 250 concurrent sessions: a value of `1` sets the number of concurrent sessions to 250; `2` sets a value of 500, and so on.   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_WebAppUnits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WebAppUnits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WebAppUnits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WebAppUnits) 

# WebAppVpcConfig
<a name="API_WebAppVpcConfig"></a>

Contains the VPC configuration settings for hosting a web app endpoint, including the VPC ID, subnet IDs, and security group IDs for access control.

## Contents
<a name="API_WebAppVpcConfig_Contents"></a>

 ** SecurityGroupIds **   <a name="TransferFamily-Type-WebAppVpcConfig-SecurityGroupIds"></a>
The list of security group IDs that control access to the web app endpoint. These security groups determine which sources can access the endpoint based on IP addresses and port configurations.  
Type: Array of strings  
Length Constraints: Minimum length of 11. Maximum length of 20.  
Pattern: `sg-[0-9a-f]{8,17}`   
Required: No

 ** SubnetIds **   <a name="TransferFamily-Type-WebAppVpcConfig-SubnetIds"></a>
The list of subnet IDs within the VPC where the web app endpoint will be deployed. These subnets must be in the same VPC specified in the VpcId parameter.  
Type: Array of strings  
Required: No

 ** VpcId **   <a name="TransferFamily-Type-WebAppVpcConfig-VpcId"></a>
The identifier of the VPC where the web app endpoint will be hosted.  
Type: String  
Required: No

## See Also
<a name="API_WebAppVpcConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WebAppVpcConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WebAppVpcConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WebAppVpcConfig) 

# WorkflowDetail
<a name="API_WorkflowDetail"></a>

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 the server session disconnects while the file is still being uploaded.

## Contents
<a name="API_WorkflowDetail_Contents"></a>

 ** ExecutionRole **   <a name="TransferFamily-Type-WorkflowDetail-ExecutionRole"></a>
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  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*role/\S+`   
Required: Yes

 ** WorkflowId **   <a name="TransferFamily-Type-WorkflowDetail-WorkflowId"></a>
A unique identifier for the workflow.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `w-([a-z0-9]{17})`   
Required: Yes

## See Also
<a name="API_WorkflowDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WorkflowDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WorkflowDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WorkflowDetail) 

# WorkflowDetails
<a name="API_WorkflowDetails"></a>

Container for the `WorkflowDetail` data type. It is used by actions that trigger a workflow to begin execution.

## Contents
<a name="API_WorkflowDetails_Contents"></a>

 ** OnPartialUpload **   <a name="TransferFamily-Type-WorkflowDetails-OnPartialUpload"></a>
A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.  
A *partial upload* occurs when a file is open when the session disconnects.  
 `OnPartialUpload` can contain a maximum of one `WorkflowDetail` object.
Type: Array of [WorkflowDetail](API_WorkflowDetail.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** OnUpload **   <a name="TransferFamily-Type-WorkflowDetails-OnUpload"></a>
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.  
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":[]}'`   
 `OnUpload` can contain a maximum of one `WorkflowDetail` object.
Type: Array of [WorkflowDetail](API_WorkflowDetail.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## See Also
<a name="API_WorkflowDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WorkflowDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WorkflowDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WorkflowDetails) 

# WorkflowStep
<a name="API_WorkflowStep"></a>

The basic building block of a workflow.

## Contents
<a name="API_WorkflowStep_Contents"></a>

 ** CopyStepDetails **   <a name="TransferFamily-Type-WorkflowStep-CopyStepDetails"></a>
Details for a step that performs a file copy.  
 Consists of the following values:   
+ A description
+ An Amazon S3 location for the destination of the file copy.
+ A flag that indicates whether to overwrite an existing file of the same name. The default is `FALSE`.
Type: [CopyStepDetails](API_CopyStepDetails.md) object  
Required: No

 ** CustomStepDetails **   <a name="TransferFamily-Type-WorkflowStep-CustomStepDetails"></a>
Details for a step that invokes an AWS Lambda function.  
Consists of the Lambda function's name, target, and timeout (in seconds).   
Type: [CustomStepDetails](API_CustomStepDetails.md) object  
Required: No

 ** DecryptStepDetails **   <a name="TransferFamily-Type-WorkflowStep-DecryptStepDetails"></a>
Details for a step that decrypts an encrypted file.  
Consists of the following values:  
+ A descriptive name
+ An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
+ An S3 or Amazon EFS location for the destination of the file decryption.
+ A flag that indicates whether to overwrite an existing file of the same name. The default is `FALSE`.
+ The type of encryption that's used. Currently, only PGP encryption is supported.
Type: [DecryptStepDetails](API_DecryptStepDetails.md) object  
Required: No

 ** DeleteStepDetails **   <a name="TransferFamily-Type-WorkflowStep-DeleteStepDetails"></a>
Details for a step that deletes the file.  
Type: [DeleteStepDetails](API_DeleteStepDetails.md) object  
Required: No

 ** TagStepDetails **   <a name="TransferFamily-Type-WorkflowStep-TagStepDetails"></a>
Details for a step that creates one or more tags.  
You specify one or more tags. Each tag contains a key-value pair.  
Type: [TagStepDetails](API_TagStepDetails.md) object  
Required: No

 ** Type **   <a name="TransferFamily-Type-WorkflowStep-Type"></a>
 Currently, the following step types are supported.   
+  ** `COPY` ** - Copy the file to another location.
+  ** `CUSTOM` ** - Perform a custom step with an AWS Lambda function target.
+  ** `DECRYPT` ** - Decrypt a file that was encrypted before it was uploaded.
+  ** `DELETE` ** - Delete the file.
+  ** `TAG` ** - Add a tag to the file.
Type: String  
Valid Values: `COPY | CUSTOM | TAG | DELETE | DECRYPT`   
Required: No

## See Also
<a name="API_WorkflowStep_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/WorkflowStep) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/WorkflowStep) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/WorkflowStep)