'2.0', 'service' => '

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

', 'operations' => [ 'CreateAccess' => '

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

', 'CreateAgreement' => '

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

', 'CreateConnector' => '

Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 connectors, see Create AS2 connectors.

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

', 'CreateProfile' => '

Creates the local or partner profile to use for AS2 transfers.

', 'CreateServer' => '

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

', 'CreateUser' => '

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user\'s public key, and assign the user\'s Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

', 'CreateWorkflow' => '

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

', 'DeleteAccess' => '

Allows you to delete the access specified in the ServerID and ExternalID parameters.

', 'DeleteAgreement' => '

Delete the agreement that\'s specified in the provided AgreementId.

', 'DeleteCertificate' => '

Deletes the certificate that\'s specified in the CertificateId parameter.

', 'DeleteConnector' => '

Deletes the connector that\'s specified in the provided ConnectorId.

', 'DeleteHostKey' => '

Deletes the host key that\'s specified in the HostKeyId parameter.

', 'DeleteProfile' => '

Deletes the profile that\'s specified in the ProfileId parameter.

', 'DeleteServer' => '

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

', 'DeleteSshPublicKey' => '

Deletes a user\'s Secure Shell (SSH) public key.

', 'DeleteUser' => '

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

When you delete a user from a server, the user\'s information is lost.

', 'DeleteWorkflow' => '

Deletes the specified workflow.

', 'DescribeAccess' => '

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

', 'DescribeAgreement' => '

Describes the agreement that\'s identified by the AgreementId.

', 'DescribeCertificate' => '

Describes the certificate that\'s identified by the CertificateId.

', 'DescribeConnector' => '

Describes the connector that\'s identified by the ConnectorId.

', 'DescribeExecution' => '

You can use DescribeExecution to check the details of the execution of the specified workflow.

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn\'t match the specified workflow ID, you receive a ResourceNotFound exception.

', 'DescribeHostKey' => '

Returns the details of the host key that\'s specified by the HostKeyId and ServerId.

', 'DescribeProfile' => '

Returns the details of the profile that\'s specified by the ProfileId.

', 'DescribeSecurityPolicy' => '

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy\'s properties. For more information about security policies, see Working with security policies.

', 'DescribeServer' => '

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server\'s properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

', 'DescribeUser' => '

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

', 'DescribeWorkflow' => '

Describes the specified workflow.

', 'ImportCertificate' => '

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

', 'ImportHostKey' => '

Adds a host key to the server that\'s specified by the ServerId parameter.

', 'ImportSshPublicKey' => '

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

', 'ListAccesses' => '

Lists the details for all the accesses you have on your server.

', 'ListAgreements' => '

Returns a list of the agreements for the server that\'s identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

', 'ListCertificates' => '

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

', 'ListConnectors' => '

Lists the connectors for the specified Region.

', 'ListExecutions' => '

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

', 'ListHostKeys' => '

Returns a list of host keys for the server that\'s specified by the ServerId parameter.

', 'ListProfiles' => '

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

', 'ListSecurityPolicies' => '

Lists the security policies that are attached to your file transfer protocol-enabled servers.

', 'ListServers' => '

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

', 'ListTagsForResource' => '

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

', 'ListUsers' => '

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

', 'ListWorkflows' => '

Lists all workflows associated with your Amazon Web Services account for your current region.

', 'SendWorkflowStepState' => '

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

', 'StartFileTransfer' => '

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
- If you are transferring file from a partner\'s SFTP server to a Transfer Family server, you specify one or more RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
- If you are transferring file to a partner\'s SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

', 'StartServer' => '

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

', 'StopServer' => '

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

', 'TagResource' => '

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

', 'TestConnection' => '

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between a Transfer Family server and a trading partner\'s SFTP server.

', 'TestIdentityProvider' => '

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note the following:

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
TestIdentityProvider does not work with keys: it only accepts passwords.
TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.
If you provide any incorrect values for any parameters, the Response field is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:

An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.

It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

', 'UntagResource' => '

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

', 'UpdateAccess' => '

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

', 'UpdateAgreement' => '

Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

', 'UpdateCertificate' => '

Updates the active and inactive dates for a certificate.

', 'UpdateConnector' => '

Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

', 'UpdateHostKey' => '

Updates the description for the host key that\'s specified by the ServerId and HostKeyId parameters.

', 'UpdateProfile' => '

Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

', 'UpdateServer' => '

Updates the file transfer protocol-enabled server\'s properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

', 'UpdateUser' => '

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'AddressAllocationId' => [ 'base' => NULL, 'refs' => [ 'AddressAllocationIds$member' => NULL, ], ], 'AddressAllocationIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$AddressAllocationIds' => '

A list of address allocation IDs that are required to attach an Elastic IP address to your server\'s endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

', ], ], 'AgreementId' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementResponse$AgreementId' => '

The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

', 'DeleteAgreementRequest$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', 'DescribeAgreementRequest$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', 'DescribedAgreement$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', 'ListedAgreement$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', 'UpdateAgreementRequest$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', 'UpdateAgreementResponse$AgreementId' => '

A unique identifier for the agreement. This identifier is returned when you create an agreement.

', ], ], 'AgreementStatusType' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Status' => '

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

', 'DescribedAgreement$Status' => '

The current status of the agreement, either ACTIVE or INACTIVE.

', 'ListedAgreement$Status' => '

The agreement can be either ACTIVE or INACTIVE.

', 'UpdateAgreementRequest$Status' => '

You can update the status for the agreement, either activating an inactive agreement or the reverse.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'DescribedAgreement$Arn' => '

The unique Amazon Resource Name (ARN) for the agreement.

', 'DescribedCertificate$Arn' => '

The unique Amazon Resource Name (ARN) for the certificate.

', 'DescribedConnector$Arn' => '

The unique Amazon Resource Name (ARN) for the connector.

', 'DescribedHostKey$Arn' => '

The unique Amazon Resource Name (ARN) for the host key.

', 'DescribedProfile$Arn' => '

The unique Amazon Resource Name (ARN) for the profile.

', 'DescribedServer$Arn' => '

Specifies the unique Amazon Resource Name (ARN) of the server.

', 'DescribedUser$Arn' => '

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

', 'DescribedWorkflow$Arn' => '

Specifies the unique Amazon Resource Name (ARN) for the workflow.

', 'ListTagsForResourceRequest$Arn' => '

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

', 'ListTagsForResourceResponse$Arn' => '

The ARN you specified to list the tags of.

', 'ListedAgreement$Arn' => '

The Amazon Resource Name (ARN) of the specified agreement.

', 'ListedCertificate$Arn' => '

The Amazon Resource Name (ARN) of the specified certificate.

', 'ListedConnector$Arn' => '

The Amazon Resource Name (ARN) of the specified connector.

', 'ListedHostKey$Arn' => '

The unique Amazon Resource Name (ARN) of the host key.

', 'ListedProfile$Arn' => '

The Amazon Resource Name (ARN) of the specified profile.

', 'ListedServer$Arn' => '

Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

', 'ListedUser$Arn' => '

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

', 'ListedWorkflow$Arn' => '

Specifies the unique Amazon Resource Name (ARN) for the workflow.

', 'StructuredLogDestinations$member' => NULL, 'TagResourceRequest$Arn' => '

An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

', 'UntagResourceRequest$Arn' => '

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

', ], ], 'As2ConnectorConfig' => [ 'base' => '

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

', 'refs' => [ 'CreateConnectorRequest$As2Config' => '

A structure that contains the parameters for an AS2 connector object.

', 'DescribedConnector$As2Config' => '

A structure that contains the parameters for an AS2 connector object.

', 'UpdateConnectorRequest$As2Config' => '

A structure that contains the parameters for an AS2 connector object.

', ], ], 'As2ConnectorSecretId' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$BasicAuthSecretId' => '

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 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 Amazon Web Services 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=""\'

', ], ], 'As2Id' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$As2Id' => '

The As2Id is the AS2-name, as defined in the RFC 4130. 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.

', 'DescribedProfile$As2Id' => '

', 'ListedProfile$As2Id' => '

', ], ], 'As2Transport' => [ 'base' => NULL, 'refs' => [ 'As2Transports$member' => NULL, ], ], 'As2Transports' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$As2Transports' => '

Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'SendWorkflowStepStateRequest$Token' => '

Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

', ], ], 'CertDate' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$ActiveDate' => '

An optional date that specifies when the certificate becomes active.

', 'DescribedCertificate$InactiveDate' => '

An optional date that specifies when the certificate becomes inactive.

', 'DescribedCertificate$NotBeforeDate' => '

The earliest date that the certificate is valid.

', 'DescribedCertificate$NotAfterDate' => '

The final date that the certificate is valid.

', 'ImportCertificateRequest$ActiveDate' => '

An optional date that specifies when the certificate becomes active.

', 'ImportCertificateRequest$InactiveDate' => '

An optional date that specifies when the certificate becomes inactive.

', 'ListedCertificate$ActiveDate' => '

An optional date that specifies when the certificate becomes active.

', 'ListedCertificate$InactiveDate' => '

An optional date that specifies when the certificate becomes inactive.

', 'UpdateCertificateRequest$ActiveDate' => '

An optional date that specifies when the certificate becomes active.

', 'UpdateCertificateRequest$InactiveDate' => '

An optional date that specifies when the certificate becomes inactive.

', ], ], 'CertSerial' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Serial' => '

The serial number for the certificate.

', ], ], 'Certificate' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Certificate' => '

The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

', 'DescribedServer$Certificate' => '

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

', 'UpdateServerRequest$Certificate' => '

The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

', ], ], 'CertificateBodyType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Certificate' => '

The file name for the certificate.

', 'ImportCertificateRequest$Certificate' => '

For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.
For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

', ], ], 'CertificateChainType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$CertificateChain' => '

The list of certificates that make up the chain for the certificate.

', 'ImportCertificateRequest$CertificateChain' => '

An optional list of certificates that make up the chain for the certificate that\'s being imported.

', ], ], 'CertificateId' => [ 'base' => NULL, 'refs' => [ 'CertificateIds$member' => NULL, 'DeleteCertificateRequest$CertificateId' => '

The identifier of the certificate object that you are deleting.

', 'DescribeCertificateRequest$CertificateId' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'DescribedCertificate$CertificateId' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'ImportCertificateResponse$CertificateId' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'ListedCertificate$CertificateId' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'UpdateCertificateRequest$CertificateId' => '

The identifier of the certificate object that you are updating.

', 'UpdateCertificateResponse$CertificateId' => '

Returns the identifier of the certificate object that you are updating.

', ], ], 'CertificateIds' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$CertificateIds' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'DescribedProfile$CertificateIds' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', 'UpdateProfileRequest$CertificateIds' => '

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

', ], ], 'CertificateStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Status' => '

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

', 'ListedCertificate$Status' => '

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

', ], ], 'CertificateType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Type' => '

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.

', 'ListedCertificate$Type' => '

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.

', ], ], 'CertificateUsageType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Usage' => '

Specifies whether this certificate is used for signing or encryption.

', 'ImportCertificateRequest$Usage' => '

Specifies whether this certificate is used for signing or encryption.

', 'ListedCertificate$Usage' => '

Specifies whether this certificate is used for signing or encryption.

', ], ], 'CompressionEnum' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$Compression' => '

Specifies whether the AS2 file is compressed.

', ], ], 'ConflictException' => [ 'base' => '

This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server\'s VpcEndpointID is not in the available state.

', 'refs' => [], ], 'ConnectorId' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorResponse$ConnectorId' => '

The unique identifier for the connector, returned after the API call succeeds.

', 'DeleteConnectorRequest$ConnectorId' => '

The unique identifier for the connector.

', 'DescribeConnectorRequest$ConnectorId' => '

The unique identifier for the connector.

', 'DescribedConnector$ConnectorId' => '

The unique identifier for the connector.

', 'ListedConnector$ConnectorId' => '

The unique identifier for the connector.

', 'StartFileTransferRequest$ConnectorId' => '

The unique identifier for the connector.

', 'TestConnectionRequest$ConnectorId' => '

The unique identifier for the connector.

', 'TestConnectionResponse$ConnectorId' => '

Returns the identifier of the connector object that you are testing.

', 'UpdateConnectorRequest$ConnectorId' => '

The unique identifier for the connector.

', 'UpdateConnectorResponse$ConnectorId' => '

Returns the identifier of the connector object that you are updating.

', ], ], 'CopyStepDetails' => [ 'base' => '

Each step type has its own StepDetails structure.

', 'refs' => [ 'WorkflowStep$CopyStepDetails' => '

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.

', ], ], 'CreateAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CustomStepDetails' => [ 'base' => '

Each step type has its own StepDetails structure.

', 'refs' => [ 'WorkflowStep$CustomStepDetails' => '

Details for a step that invokes an Lambda function.

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

', ], ], 'CustomStepStatus' => [ 'base' => NULL, 'refs' => [ 'SendWorkflowStepStateRequest$Status' => '

Indicates whether the specified step succeeded or failed.

', ], ], 'CustomStepTarget' => [ 'base' => NULL, 'refs' => [ 'CustomStepDetails$Target' => '

The ARN for the Lambda function that is being called.

', ], ], 'CustomStepTimeoutSeconds' => [ 'base' => NULL, 'refs' => [ 'CustomStepDetails$TimeoutSeconds' => '

Timeout, in seconds, for the step.

', ], ], 'DateImported' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$DateImported' => '

The date on which the host key was added to the server.

', 'ListedHostKey$DateImported' => '

The date on which the host key was added to the server.

', 'SshPublicKey$DateImported' => '

Specifies the date that the public key was added to the Transfer Family user.

', ], ], 'DecryptStepDetails' => [ 'base' => '

Each step type has its own StepDetails structure.

', 'refs' => [ 'WorkflowStep$DecryptStepDetails' => '

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.

', ], ], 'DeleteAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSshPublicKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStepDetails' => [ 'base' => '

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

', 'refs' => [ 'WorkflowStep$DeleteStepDetails' => '

Details for a step that deletes the file.

', ], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribedAccess' => [ 'base' => '

Describes the properties of the access that was specified.

', 'refs' => [ 'DescribeAccessResponse$Access' => '

The external identifier of the server that the access is attached to.

', ], ], 'DescribedAgreement' => [ 'base' => '

Describes the properties of an agreement.

', 'refs' => [ 'DescribeAgreementResponse$Agreement' => '

The details for the specified agreement, returned as a DescribedAgreement object.

', ], ], 'DescribedCertificate' => [ 'base' => '

Describes the properties of a certificate.

', 'refs' => [ 'DescribeCertificateResponse$Certificate' => '

The details for the specified certificate, returned as an object.

', ], ], 'DescribedConnector' => [ 'base' => '

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

', 'refs' => [ 'DescribeConnectorResponse$Connector' => '

The structure that contains the details of the connector.

', ], ], 'DescribedExecution' => [ 'base' => '

The details for an execution object.

', 'refs' => [ 'DescribeExecutionResponse$Execution' => '

The structure that contains the details of the workflow\' execution.

', ], ], 'DescribedHostKey' => [ 'base' => '

The details for a server host key.

', 'refs' => [ 'DescribeHostKeyResponse$HostKey' => '

Returns the details for the specified host key.

', ], ], 'DescribedProfile' => [ 'base' => '

The details for a local or partner AS2 profile.

', 'refs' => [ 'DescribeProfileResponse$Profile' => '

The details of the specified profile, returned as an object.

', ], ], 'DescribedSecurityPolicy' => [ 'base' => '

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.

', 'refs' => [ 'DescribeSecurityPolicyResponse$SecurityPolicy' => '

An array containing the properties of the security policy.

', ], ], 'DescribedServer' => [ 'base' => '

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

', 'refs' => [ 'DescribeServerResponse$Server' => '

An array containing the properties of a server with the ServerID you specified.

', ], ], 'DescribedUser' => [ 'base' => '

Describes the properties of a user that was specified.

', 'refs' => [ 'DescribeUserResponse$User' => '

An array containing the properties of the Transfer Family user for the ServerID value that you specified.

', ], ], 'DescribedWorkflow' => [ 'base' => '

Describes the properties of the specified workflow

', 'refs' => [ 'DescribeWorkflowResponse$Workflow' => '

The structure that contains the details of the workflow.

', ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Description' => '

A name or short description to identify the agreement.

', 'DescribedAgreement$Description' => '

The name or short description that\'s used to identify the agreement.

', 'DescribedCertificate$Description' => '

The name or description that\'s used to identity the certificate.

', 'ImportCertificateRequest$Description' => '

A short description that helps identify the certificate.

', 'ListedAgreement$Description' => '

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

', 'ListedCertificate$Description' => '

The name or short description that\'s used to identify the certificate.

', 'UpdateAgreementRequest$Description' => '

To replace the existing description, provide a short description for the agreement.

', 'UpdateCertificateRequest$Description' => '

A short description to help identify the certificate.

', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$DirectoryId' => '

The identifier of the Directory Service directory that you want to stop sharing.

', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Domain' => '

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.

After the server is created, the domain cannot be changed.

', 'DescribedServer$Domain' => '

Specifies the domain of the storage system that is used for file transfers.

', 'ListedServer$Domain' => '

Specifies the domain of the storage system that is used for file transfers.

', ], ], 'EfsFileLocation' => [ 'base' => '

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.

', 'refs' => [ 'FileLocation$EfsFileLocation' => '

Specifies the Amazon EFS identifier and the path for the file being used.

', 'InputFileLocation$EfsFileLocation' => '

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

', ], ], 'EfsFileSystemId' => [ 'base' => NULL, 'refs' => [ 'EfsFileLocation$FileSystemId' => '

The identifier of the file system, assigned by Amazon EFS.

', ], ], 'EfsPath' => [ 'base' => NULL, 'refs' => [ 'EfsFileLocation$Path' => '

The pathname for the folder being used by a workflow.

', ], ], 'EncryptionAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$EncryptionAlgorithm' => '

The algorithm that is used to encrypt the file.

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

', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'DecryptStepDetails$Type' => '

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

', ], ], 'EndpointDetails' => [ 'base' => '

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.

After May 19, 2021, you won\'t be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn\'t already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

', 'refs' => [ 'CreateServerRequest$EndpointDetails' => '

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.

', 'DescribedServer$EndpointDetails' => '

', 'UpdateServerRequest$EndpointDetails' => '

', ], ], 'EndpointType' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$EndpointType' => '

The type of endpoint that you want your server to use. You can choose to make your server\'s endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won\'t be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services 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 Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see 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.

', 'DescribedServer$EndpointType' => '

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.

', 'ListedServer$EndpointType' => '

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.

', 'UpdateServerRequest$EndpointType' => '

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

', ], ], 'ExecutionError' => [ 'base' => '

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

', 'refs' => [ 'ExecutionStepResult$Error' => '

Specifies the details for an error, if it occurred during execution of the specified workflow step.

', ], ], 'ExecutionErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ExecutionError$Message' => '

Specifies the descriptive message that corresponds to the ErrorType.

', ], ], 'ExecutionErrorType' => [ 'base' => NULL, 'refs' => [ 'ExecutionError$Type' => '

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.

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.

', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionRequest$ExecutionId' => '

A unique identifier for the execution of a workflow.

', 'DescribedExecution$ExecutionId' => '

A unique identifier for the execution of a workflow.

', 'ListedExecution$ExecutionId' => '

A unique identifier for the execution of a workflow.

', 'SendWorkflowStepStateRequest$ExecutionId' => '

A unique identifier for the execution of a workflow.

', ], ], 'ExecutionResults' => [ 'base' => '

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

', 'refs' => [ 'DescribedExecution$Results' => '

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.

', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribedExecution$Status' => '

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

', 'ListedExecution$Status' => '

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

', ], ], 'ExecutionStepResult' => [ 'base' => '

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

', 'refs' => [ 'ExecutionStepResults$member' => NULL, ], ], 'ExecutionStepResults' => [ 'base' => NULL, 'refs' => [ 'ExecutionResults$Steps' => '

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

', 'ExecutionResults$OnExceptionSteps' => '

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

', ], ], 'ExternalId' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$ExternalId' => '

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 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: =,.@:/-

', 'CreateAccessResponse$ExternalId' => '

The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.

', 'DeleteAccessRequest$ExternalId' => '

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

', 'DescribeAccessRequest$ExternalId' => '

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

', 'DescribedAccess$ExternalId' => '

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

', 'ListedAccess$ExternalId' => '

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

', 'UpdateAccessRequest$ExternalId' => '

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

', 'UpdateAccessResponse$ExternalId' => '

The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

', ], ], 'FileLocation' => [ 'base' => '

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

', 'refs' => [ 'DescribedExecution$InitialFileLocation' => '

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.

', 'ListedExecution$InitialFileLocation' => '

', ], ], 'FilePath' => [ 'base' => NULL, 'refs' => [ 'FilePaths$member' => NULL, 'StartFileTransferRequest$LocalDirectoryPath' => '

For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner\'s SFTP server.

', 'StartFileTransferRequest$RemoteDirectoryPath' => '

For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner\'s SFTP server. If you don\'t specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user\'s home directory.

', ], ], 'FilePaths' => [ 'base' => NULL, 'refs' => [ 'StartFileTransferRequest$SendFilePaths' => '

One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

', 'StartFileTransferRequest$RetrieveFilePaths' => '

One or more source paths for the partner\'s SFTP server. Each string represents a source file path for one inbound file transfer.

', ], ], 'Fips' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$Fips' => '

Specifies whether this policy enables Federal Information Processing Standards (FIPS).

', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$Function' => '

The ARN for a Lambda function to use for the Identity provider.

', ], ], 'HomeDirectory' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectory' => '

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.

', 'CreateAgreementRequest$BaseDirectory' => '

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

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

', 'CreateUserRequest$HomeDirectory' => '

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.

', 'DescribedAccess$HomeDirectory' => '

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.

', 'DescribedAgreement$BaseDirectory' => '

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

', 'DescribedUser$HomeDirectory' => '

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.

', 'ListedAccess$HomeDirectory' => '

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.

', 'ListedUser$HomeDirectory' => '

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.

', 'UpdateAccessRequest$HomeDirectory' => '

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.

', 'UpdateAgreementRequest$BaseDirectory' => '

To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .

', 'UpdateUserRequest$HomeDirectory' => '

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.

', ], ], 'HomeDirectoryMapEntry' => [ 'base' => '

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" } ]

', 'refs' => [ 'HomeDirectoryMappings$member' => NULL, ], ], 'HomeDirectoryMappings' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectoryMappings' => '

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 Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

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

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

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

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

', 'CreateUserRequest$HomeDirectoryMappings' => '

The following is an Entry and Target pair example.

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

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 value the user should see for their home directory when they log in.

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

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

', 'DescribedAccess$HomeDirectoryMappings' => '

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.

', 'DescribedUser$HomeDirectoryMappings' => '

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.

', 'UpdateAccessRequest$HomeDirectoryMappings' => '

The following is an Entry and Target pair example.

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

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

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

', 'UpdateUserRequest$HomeDirectoryMappings' => '

The following is an Entry and Target pair example.

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

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to \'/\' and set Target to the HomeDirectory parameter value.

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

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

', ], ], 'HomeDirectoryType' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectoryType' => '

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 EFS paths as is in their file transfer protocol clients. If you set it 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.

', 'CreateUserRequest$HomeDirectoryType' => '

', 'DescribedAccess$HomeDirectoryType' => '

', 'DescribedUser$HomeDirectoryType' => '

', 'ListedAccess$HomeDirectoryType' => '

', 'ListedUser$HomeDirectoryType' => '

', 'UpdateAccessRequest$HomeDirectoryType' => '

', 'UpdateUserRequest$HomeDirectoryType' => '

', ], ], 'HostKey' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$HostKey' => '

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

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

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

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

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

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

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

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

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

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

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

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

', 'ImportHostKeyRequest$HostKeyBody' => '

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

', 'UpdateServerRequest$HostKey' => '

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

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

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

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

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

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

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

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

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

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

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

', ], ], 'HostKeyDescription' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$Description' => '

The text description for this host key.

', 'ImportHostKeyRequest$Description' => '

The text description that identifies this host key.

', 'ListedHostKey$Description' => '

The current description for the host key. You can change it by calling the UpdateHostKey operation and providing a new description.

', 'UpdateHostKeyRequest$Description' => '

An updated description for the host key.

', ], ], 'HostKeyFingerprint' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$HostKeyFingerprint' => '

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

', 'DescribedServer$HostKeyFingerprint' => '

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.

', 'ListedHostKey$Fingerprint' => '

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

', ], ], 'HostKeyId' => [ 'base' => NULL, 'refs' => [ 'DeleteHostKeyRequest$HostKeyId' => '

The identifier of the host key that you are deleting.

', 'DescribeHostKeyRequest$HostKeyId' => '

The identifier of the host key that you want described.

', 'DescribedHostKey$HostKeyId' => '

A unique identifier for the host key.

', 'ImportHostKeyResponse$HostKeyId' => '

Returns the host key identifier for the imported key.

', 'ListedHostKey$HostKeyId' => '

A unique identifier for the host key.

', 'UpdateHostKeyRequest$HostKeyId' => '

The identifier of the host key that you are updating.

', 'UpdateHostKeyResponse$HostKeyId' => '

Returns the host key identifier for the updated host key.

', ], ], 'HostKeyType' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$Type' => '

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

', 'ListedHostKey$Type' => '

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

', ], ], 'IdentityProviderDetails' => [ 'base' => '

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.

', 'refs' => [ 'CreateServerRequest$IdentityProviderDetails' => '

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

', 'DescribedServer$IdentityProviderDetails' => '

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.

', 'UpdateServerRequest$IdentityProviderDetails' => '

An array containing all of the information required to call a customer\'s authentication API method.

', ], ], 'IdentityProviderType' => [ 'base' => '

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services 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 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.

', 'refs' => [ 'CreateServerRequest$IdentityProviderType' => '

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

', 'DescribedServer$IdentityProviderType' => '

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

', 'ListedServer$IdentityProviderType' => '

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

', ], ], 'ImportCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportSshPublicKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportSshPublicKeyResponse' => [ 'base' => '

Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

', 'refs' => [], ], 'InputFileLocation' => [ 'base' => '

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

', 'refs' => [ 'CopyStepDetails$DestinationFileLocation' => '

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.

The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

', 'DecryptStepDetails$DestinationFileLocation' => '

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.

The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

', ], ], 'InternalServiceError' => [ 'base' => '

This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The NextToken parameter that was passed is invalid.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

This exception is thrown when the client submits a malformed request.

', 'refs' => [], ], 'ListAccessesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccessesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAgreementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAgreementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCertificatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHostKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHostKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListedAccess' => [ 'base' => '

Lists the properties for one or more specified associated accesses.

', 'refs' => [ 'ListedAccesses$member' => NULL, ], ], 'ListedAccesses' => [ 'base' => NULL, 'refs' => [ 'ListAccessesResponse$Accesses' => '

Returns the accesses and their properties for the ServerId value that you specify.

', ], ], 'ListedAgreement' => [ 'base' => '

Describes the properties of an agreement.

', 'refs' => [ 'ListedAgreements$member' => NULL, ], ], 'ListedAgreements' => [ 'base' => NULL, 'refs' => [ 'ListAgreementsResponse$Agreements' => '

Returns an array, where each item contains the details of an agreement.

', ], ], 'ListedCertificate' => [ 'base' => '

Describes the properties of a certificate.

', 'refs' => [ 'ListedCertificates$member' => NULL, ], ], 'ListedCertificates' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesResponse$Certificates' => '

Returns an array of the certificates that are specified in the ListCertificates call.

', ], ], 'ListedConnector' => [ 'base' => '

Returns details of the connector that is specified.

', 'refs' => [ 'ListedConnectors$member' => NULL, ], ], 'ListedConnectors' => [ 'base' => NULL, 'refs' => [ 'ListConnectorsResponse$Connectors' => '

Returns an array, where each item contains the details of a connector.

', ], ], 'ListedExecution' => [ 'base' => '

Returns properties of the execution that is specified.

', 'refs' => [ 'ListedExecutions$member' => NULL, ], ], 'ListedExecutions' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsResponse$Executions' => '

Returns the details for each execution, in a ListedExecution array.

', ], ], 'ListedHostKey' => [ 'base' => '

Returns properties of the host key that\'s specified.

', 'refs' => [ 'ListedHostKeys$member' => NULL, ], ], 'ListedHostKeys' => [ 'base' => NULL, 'refs' => [ 'ListHostKeysResponse$HostKeys' => '

Returns an array, where each item contains the details of a host key.

', ], ], 'ListedProfile' => [ 'base' => '

Returns the properties of the profile that was specified.

', 'refs' => [ 'ListedProfiles$member' => NULL, ], ], 'ListedProfiles' => [ 'base' => NULL, 'refs' => [ 'ListProfilesResponse$Profiles' => '

Returns an array, where each item contains the details of a profile.

', ], ], 'ListedServer' => [ 'base' => '

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

', 'refs' => [ 'ListedServers$member' => NULL, ], ], 'ListedServers' => [ 'base' => NULL, 'refs' => [ 'ListServersResponse$Servers' => '

An array of servers that were listed.

', ], ], 'ListedUser' => [ 'base' => '

Returns properties of the user that you specify.

', 'refs' => [ 'ListedUsers$member' => NULL, ], ], 'ListedUsers' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$Users' => '

Returns the Transfer Family users and their properties for the ServerId value that you specify.

', ], ], 'ListedWorkflow' => [ 'base' => '

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

', 'refs' => [ 'ListedWorkflows$member' => NULL, ], ], 'ListedWorkflows' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsResponse$Workflows' => '

Returns the Arn, WorkflowId, and Description for each workflow.

', ], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$LogGroupName' => '

The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.

', ], ], 'LoggingConfiguration' => [ 'base' => '

Consists of the logging role and the log group name.

', 'refs' => [ 'DescribedExecution$LoggingConfiguration' => '

The IAM logging role associated with the execution.

', ], ], 'MapEntry' => [ 'base' => NULL, 'refs' => [ 'HomeDirectoryMapEntry$Entry' => '

Represents an entry for HomeDirectoryMappings.

', ], ], 'MapTarget' => [ 'base' => NULL, 'refs' => [ 'HomeDirectoryMapEntry$Target' => '

Represents the map target that is used in a HomeDirectorymapEntry.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAccessesRequest$MaxResults' => '

Specifies the maximum number of access SIDs to return.

', 'ListAgreementsRequest$MaxResults' => '

The maximum number of agreements to return.

', 'ListCertificatesRequest$MaxResults' => '

The maximum number of certificates to return.

', 'ListConnectorsRequest$MaxResults' => '

The maximum number of connectors to return.

', 'ListExecutionsRequest$MaxResults' => '

Specifies the maximum number of executions to return.

', 'ListHostKeysRequest$MaxResults' => '

The maximum number of host keys to return.

', 'ListProfilesRequest$MaxResults' => '

The maximum number of profiles to return.

', 'ListSecurityPoliciesRequest$MaxResults' => '

Specifies the number of security policies to return as a response to the ListSecurityPolicies query.

', 'ListServersRequest$MaxResults' => '

Specifies the number of servers to return as a response to the ListServers query.

', 'ListTagsForResourceRequest$MaxResults' => '

Specifies the number of tags to return as a response to the ListTagsForResource request.

', 'ListUsersRequest$MaxResults' => '

Specifies the number of users to return as a response to the ListUsers request.

', 'ListWorkflowsRequest$MaxResults' => '

Specifies the maximum number of workflows to return.

', ], ], 'MdnResponse' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MdnResponse' => '

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

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.

', ], ], 'MdnSigningAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MdnSigningAlgorithm' => '

The signing algorithm for the MDN response.

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

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'InternalServiceError$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'ResourceExistsException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'TestConnectionResponse$StatusMessage' => '

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.
Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.
Private key not found: Verify that the secret exists and is formatted correctly.
Invalid trusted host keys: Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

', 'TestIdentityProviderResponse$Message' => '

A message that indicates whether the test was successful or not.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

', ], ], 'MessageSubject' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MessageSubject' => '

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAccessesRequest$NextToken' => '

When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

', 'ListAccessesResponse$NextToken' => '

', 'ListAgreementsRequest$NextToken' => '

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

', 'ListAgreementsResponse$NextToken' => '

Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

', 'ListCertificatesRequest$NextToken' => '

When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

', 'ListCertificatesResponse$NextToken' => '

Returns the next token, which you can use to list the next certificate.

', 'ListConnectorsRequest$NextToken' => '

When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.

', 'ListConnectorsResponse$NextToken' => '

Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

', 'ListExecutionsRequest$NextToken' => '

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

', 'ListExecutionsResponse$NextToken' => '

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

', 'ListHostKeysRequest$NextToken' => '

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

', 'ListHostKeysResponse$NextToken' => '

Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

', 'ListProfilesRequest$NextToken' => '

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

', 'ListProfilesResponse$NextToken' => '

Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

', 'ListSecurityPoliciesRequest$NextToken' => '

When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

', 'ListSecurityPoliciesResponse$NextToken' => '

When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

', 'ListServersRequest$NextToken' => '

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

', 'ListServersResponse$NextToken' => '

When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

', 'ListTagsForResourceRequest$NextToken' => '

When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

', 'ListTagsForResourceResponse$NextToken' => '

When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

', 'ListUsersRequest$NextToken' => '

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

', 'ListUsersResponse$NextToken' => '

', 'ListWorkflowsRequest$NextToken' => '

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

', 'ListWorkflowsResponse$NextToken' => '

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

', ], ], 'NullableRole' => [ 'base' => NULL, 'refs' => [ 'UpdateServerRequest$LoggingRole' => '

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

', ], ], 'OnPartialUploadWorkflowDetails' => [ 'base' => NULL, 'refs' => [ 'WorkflowDetails$OnPartialUpload' => '

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.

', ], ], 'OnUploadWorkflowDetails' => [ 'base' => NULL, 'refs' => [ 'WorkflowDetails$OnUpload' => '

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":[]}\'

', ], ], 'OverwriteExisting' => [ 'base' => NULL, 'refs' => [ 'CopyStepDetails$OverwriteExisting' => '

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.

', 'DecryptStepDetails$OverwriteExisting' => '

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.

', ], ], 'PassiveIp' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$PassiveIp' => '

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 Transfer Family.

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.

', ], ], 'Policy' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$Policy' => '

A session policy for your user so that you can use the same 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}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Security Token Service API Reference.

', 'CreateUserRequest$Policy' => '

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

', 'DescribedAccess$Policy' => '

', 'DescribedUser$Policy' => '

', 'UpdateAccessRequest$Policy' => '

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

', 'UpdateUserRequest$Policy' => '

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For an example of a session policy, see Creating a session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

', ], ], 'PosixId' => [ 'base' => NULL, 'refs' => [ 'PosixProfile$Uid' => '

The POSIX user ID used for all EFS operations by this user.

', 'PosixProfile$Gid' => '

The POSIX group ID used for all EFS operations by this user.

', 'SecondaryGids$member' => NULL, ], ], 'PosixProfile' => [ 'base' => '

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.

', 'refs' => [ 'CreateAccessRequest$PosixProfile' => NULL, 'CreateUserRequest$PosixProfile' => '

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

', 'DescribedAccess$PosixProfile' => NULL, 'DescribedExecution$PosixProfile' => NULL, 'DescribedUser$PosixProfile' => '

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.

', 'UpdateAccessRequest$PosixProfile' => NULL, 'UpdateUserRequest$PosixProfile' => '

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 Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

', ], ], 'PostAuthenticationLoginBanner' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$PostAuthenticationLoginBanner' => '

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.

', 'DescribedServer$PostAuthenticationLoginBanner' => '

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.

', 'UpdateServerRequest$PostAuthenticationLoginBanner' => '

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.

', ], ], 'PreAuthenticationLoginBanner' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$PreAuthenticationLoginBanner' => '

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.

', 'DescribedServer$PreAuthenticationLoginBanner' => '

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:

', 'UpdateServerRequest$PreAuthenticationLoginBanner' => '

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:

', ], ], 'PrivateKeyType' => [ 'base' => NULL, 'refs' => [ 'ImportCertificateRequest$PrivateKey' => '

For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.
For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

', ], ], 'ProfileId' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$LocalProfileId' => '

A unique identifier for the AS2 local profile.

', 'As2ConnectorConfig$PartnerProfileId' => '

A unique identifier for the partner profile for the connector.

', 'CreateAgreementRequest$LocalProfileId' => '

A unique identifier for the AS2 local profile.

', 'CreateAgreementRequest$PartnerProfileId' => '

A unique identifier for the partner profile used in the agreement.

', 'CreateProfileResponse$ProfileId' => '

The unique identifier for the AS2 profile, returned after the API call succeeds.

', 'DeleteProfileRequest$ProfileId' => '

The identifier of the profile that you are deleting.

', 'DescribeProfileRequest$ProfileId' => '

The identifier of the profile that you want described.

', 'DescribedAgreement$LocalProfileId' => '

A unique identifier for the AS2 local profile.

', 'DescribedAgreement$PartnerProfileId' => '

A unique identifier for the partner profile used in the agreement.

', 'DescribedProfile$ProfileId' => '

A unique identifier for the local or partner AS2 profile.

', 'ListedAgreement$LocalProfileId' => '

A unique identifier for the AS2 local profile.

', 'ListedAgreement$PartnerProfileId' => '

A unique identifier for the partner profile.

', 'ListedProfile$ProfileId' => '

A unique identifier for the local or partner AS2 profile.

', 'UpdateAgreementRequest$LocalProfileId' => '

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

', 'UpdateAgreementRequest$PartnerProfileId' => '

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

', 'UpdateProfileRequest$ProfileId' => '

The identifier of the profile object that you are updating.

', 'UpdateProfileResponse$ProfileId' => '

Returns the identifier for the profile that\'s being updated.

', ], ], 'ProfileType' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$ProfileType' => '

Determines the type of profile to create:

Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.
Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

', 'DescribedProfile$ProfileType' => '

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.

', 'ListProfilesRequest$ProfileType' => '

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.

', 'ListedProfile$ProfileType' => '

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.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'Protocols$member' => NULL, 'TestIdentityProviderRequest$ServerProtocol' => '

The type of file transfer protocol to be tested.

The available protocols are:

Secure Shell (SSH) File Transfer Protocol (SFTP)
File Transfer Protocol Secure (FTPS)
File Transfer Protocol (FTP)
Applicability Statement 2 (AS2)

', ], ], 'ProtocolDetails' => [ 'base' => '

The protocol settings that are configured for your server.

', 'refs' => [ 'CreateServerRequest$ProtocolDetails' => '

The protocol settings that are configured for your server.

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 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 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.

', 'DescribedServer$ProtocolDetails' => '

The protocol settings that are configured for your server.

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 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 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.

', 'UpdateServerRequest$ProtocolDetails' => '

The protocol settings that are configured for your server.

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 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 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.

', ], ], 'Protocols' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Protocols' => '

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 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.

', 'DescribedServer$Protocols' => '

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 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.

', 'UpdateServerRequest$Protocols' => '

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 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.

', ], ], 'Resource' => [ 'base' => NULL, 'refs' => [ 'ResourceExistsException$Resource' => NULL, 'ResourceNotFoundException$Resource' => NULL, ], ], 'ResourceExistsException' => [ 'base' => '

The requested resource does not exist.

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceExistsException$ResourceType' => NULL, 'ResourceNotFoundException$ResourceType' => NULL, ], ], 'Response' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderResponse$Response' => '

The response that is returned from your API Gateway or your Lambda function.

', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$RetryAfterSeconds' => NULL, ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$Role' => '

The Amazon Resource Name (ARN) of the 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.

', 'CreateAgreementRequest$AccessRole' => '

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 Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

', 'CreateConnectorRequest$AccessRole' => '

', 'CreateConnectorRequest$LoggingRole' => '

The Amazon Resource Name (ARN) of the 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.

', 'CreateServerRequest$LoggingRole' => '

', 'CreateUserRequest$Role' => '

', 'DescribedAccess$Role' => '

', 'DescribedAgreement$AccessRole' => '

', 'DescribedConnector$AccessRole' => '

', 'DescribedConnector$LoggingRole' => '

', 'DescribedExecution$ExecutionRole' => '

The IAM role associated with the execution.

', 'DescribedServer$LoggingRole' => '

', 'DescribedUser$Role' => '

', 'IdentityProviderDetails$InvocationRole' => '

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

', 'ListedAccess$Role' => '

', 'ListedServer$LoggingRole' => '

', 'ListedUser$Role' => '

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.

', 'LoggingConfiguration$LoggingRole' => '

', 'UpdateAccessRequest$Role' => '

', 'UpdateAgreementRequest$AccessRole' => '

', 'UpdateConnectorRequest$AccessRole' => '

', 'UpdateConnectorRequest$LoggingRole' => '

', 'UpdateUserRequest$Role' => '

', 'WorkflowDetail$ExecutionRole' => '

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

', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Bucket' => '

Specifies the S3 bucket that contains the file being used.

', 'S3InputFileLocation$Bucket' => '

Specifies the S3 bucket for the customer input file.

', ], ], 'S3Etag' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Etag' => '

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

', ], ], 'S3FileLocation' => [ 'base' => '

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.

', 'refs' => [ 'FileLocation$S3FileLocation' => '

Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.

', ], ], 'S3InputFileLocation' => [ 'base' => '

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.

', 'refs' => [ 'InputFileLocation$S3FileLocation' => '

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

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Key' => '

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

', 'S3InputFileLocation$Key' => '

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

', ], ], 'S3Tag' => [ 'base' => '

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

', 'refs' => [ 'S3Tags$member' => NULL, ], ], 'S3TagKey' => [ 'base' => NULL, 'refs' => [ 'S3Tag$Key' => '

The name assigned to the tag that you create.

', ], ], 'S3TagValue' => [ 'base' => NULL, 'refs' => [ 'S3Tag$Value' => '

The value that corresponds to the key.

', ], ], 'S3Tags' => [ 'base' => NULL, 'refs' => [ 'TagStepDetails$Tags' => '

Array that contains from 1 to 10 key/value pairs.

', ], ], 'S3VersionId' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$VersionId' => '

Specifies the file version.

', ], ], 'SecondaryGids' => [ 'base' => NULL, 'refs' => [ 'PosixProfile$SecondaryGids' => '

The secondary POSIX group IDs used for all EFS operations by this user.

', ], ], 'SecretId' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorConfig$UserSecretId' => '

The identifiers for the secrets (in Amazon Web Services Secrets Manager) that contain the SFTP user\'s private keys or passwords.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$SecurityGroupIds' => '

A list of security groups IDs that are available to attach to your server\'s endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer 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 API.

', ], ], 'SecurityPolicyName' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$SecurityPolicyName' => '

Specifies the name of the security policy that is attached to the server.

', 'DescribeSecurityPolicyRequest$SecurityPolicyName' => '

Specifies the name of the security policy that is attached to the server.

', 'DescribedSecurityPolicy$SecurityPolicyName' => '

Specifies the name of the security policy that is attached to the server.

', 'DescribedServer$SecurityPolicyName' => '

Specifies the name of the security policy that is attached to the server.

', 'SecurityPolicyNames$member' => NULL, 'UpdateServerRequest$SecurityPolicyName' => '

Specifies the name of the security policy that is attached to the server.

', ], ], 'SecurityPolicyNames' => [ 'base' => NULL, 'refs' => [ 'ListSecurityPoliciesResponse$SecurityPolicyNames' => '

An array of security policies that were listed.

', ], ], 'SecurityPolicyOption' => [ 'base' => NULL, 'refs' => [ 'SecurityPolicyOptions$member' => NULL, ], ], 'SecurityPolicyOptions' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$SshCiphers' => '

Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

', 'DescribedSecurityPolicy$SshKexs' => '

Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

', 'DescribedSecurityPolicy$SshMacs' => '

Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

', 'DescribedSecurityPolicy$TlsCiphers' => '

Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

', ], ], 'SendWorkflowStepStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendWorkflowStepStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerId' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$ServerId' => '

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

', 'CreateAccessResponse$ServerId' => '

The identifier of the server that the user is attached to.

', 'CreateAgreementRequest$ServerId' => '

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

', 'CreateServerResponse$ServerId' => '

The service-assigned identifier of the server that is created.

', 'CreateUserRequest$ServerId' => '

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

', 'CreateUserResponse$ServerId' => '

The identifier of the server that the user is attached to.

', 'DeleteAccessRequest$ServerId' => '

A system-assigned unique identifier for a server that has this user assigned.

', 'DeleteAgreementRequest$ServerId' => '

The server identifier associated with the agreement that you are deleting.

', 'DeleteHostKeyRequest$ServerId' => '

The identifier of the server that contains the host key that you are deleting.

', 'DeleteServerRequest$ServerId' => '

A unique system-assigned identifier for a server instance.

', 'DeleteSshPublicKeyRequest$ServerId' => '

A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

', 'DeleteUserRequest$ServerId' => '

A system-assigned unique identifier for a server instance that has the user assigned to it.

', 'DescribeAccessRequest$ServerId' => '

A system-assigned unique identifier for a server that has this access assigned.

', 'DescribeAccessResponse$ServerId' => '

A system-assigned unique identifier for a server that has this access assigned.

', 'DescribeAgreementRequest$ServerId' => '

The server identifier that\'s associated with the agreement.

', 'DescribeHostKeyRequest$ServerId' => '

The identifier of the server that contains the host key that you want described.

', 'DescribeServerRequest$ServerId' => '

A system-assigned unique identifier for a server.

', 'DescribeUserRequest$ServerId' => '

A system-assigned unique identifier for a server that has this user assigned.

', 'DescribeUserResponse$ServerId' => '

A system-assigned unique identifier for a server that has this user assigned.

', 'DescribedAgreement$ServerId' => '

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

', 'DescribedServer$ServerId' => '

Specifies the unique system-assigned identifier for a server that you instantiate.

', 'ImportHostKeyRequest$ServerId' => '

The identifier of the server that contains the host key that you are importing.

', 'ImportHostKeyResponse$ServerId' => '

Returns the server identifier that contains the imported key.

', 'ImportSshPublicKeyRequest$ServerId' => '

A system-assigned unique identifier for a server.

', 'ImportSshPublicKeyResponse$ServerId' => '

A system-assigned unique identifier for a server.

', 'ListAccessesRequest$ServerId' => '

A system-assigned unique identifier for a server that has users assigned to it.

', 'ListAccessesResponse$ServerId' => '

A system-assigned unique identifier for a server that has users assigned to it.

', 'ListAgreementsRequest$ServerId' => '

The identifier of the server for which you want a list of agreements.

', 'ListHostKeysRequest$ServerId' => '

The identifier of the server that contains the host keys that you want to view.

', 'ListHostKeysResponse$ServerId' => '

Returns the server identifier that contains the listed host keys.

', 'ListUsersRequest$ServerId' => '

A system-assigned unique identifier for a server that has users assigned to it.

', 'ListUsersResponse$ServerId' => '

A system-assigned unique identifier for a server that the users are assigned to.

', 'ListedAgreement$ServerId' => '

The unique identifier for the agreement.

', 'ListedServer$ServerId' => '

Specifies the unique system assigned identifier for the servers that were listed.

', 'StartServerRequest$ServerId' => '

A system-assigned unique identifier for a server that you start.

', 'StopServerRequest$ServerId' => '

A system-assigned unique identifier for a server that you stopped.

', 'TestIdentityProviderRequest$ServerId' => '

A system-assigned identifier for a specific server. That server\'s user authentication method is tested with a user name and password.

', 'UpdateAccessRequest$ServerId' => '

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

', 'UpdateAccessResponse$ServerId' => '

The identifier of the server that the user is attached to.

', 'UpdateAgreementRequest$ServerId' => '

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

', 'UpdateHostKeyRequest$ServerId' => '

The identifier of the server that contains the host key that you are updating.

', 'UpdateHostKeyResponse$ServerId' => '

Returns the server identifier for the server that contains the updated host key.

', 'UpdateServerRequest$ServerId' => '

A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.

', 'UpdateServerResponse$ServerId' => '

A system-assigned unique identifier for a server that the Transfer Family user is assigned to.

', 'UpdateUserRequest$ServerId' => '

A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.

', 'UpdateUserResponse$ServerId' => '

A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.

', 'UserDetails$ServerId' => '

The system-assigned unique identifier for a Transfer server instance.

', ], ], 'ServiceErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ServiceUnavailableException$Message' => NULL, ], ], 'ServiceMetadata' => [ 'base' => '

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

', 'refs' => [ 'DescribedExecution$ServiceMetadata' => '

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

', 'ListedExecution$ServiceMetadata' => '

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

', ], ], 'ServiceUnavailableException' => [ 'base' => '

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

', 'refs' => [], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'UserDetails$SessionId' => '

The system-assigned unique identifier for a session that corresponds to the workflow.

', ], ], 'SetStatOption' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$SetStatOption' => '

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.

', ], ], 'SftpAuthenticationMethods' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$SftpAuthenticationMethods' => '

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.

', ], ], 'SftpConnectorConfig' => [ 'base' => '

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

', 'refs' => [ 'CreateConnectorRequest$SftpConfig' => '

A structure that contains the parameters for an SFTP connector object.

', 'DescribedConnector$SftpConfig' => '

A structure that contains the parameters for an SFTP connector object.

', 'UpdateConnectorRequest$SftpConfig' => '

A structure that contains the parameters for an SFTP connector object.

', ], ], 'SftpConnectorTrustedHostKey' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorTrustedHostKeyList$member' => NULL, ], ], 'SftpConnectorTrustedHostKeyList' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorConfig$TrustedHostKeys' => '

The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

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

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

For RSA keys, the key type is ssh-rsa.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

', ], ], 'SigningAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$SigningAlgorithm' => '

The algorithm that is used to sign the AS2 messages sent with the connector.

', ], ], 'SourceFileLocation' => [ 'base' => NULL, 'refs' => [ 'CopyStepDetails$SourceFileLocation' => '

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}.

', 'CustomStepDetails$SourceFileLocation' => '

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}.

', 'DecryptStepDetails$SourceFileLocation' => '

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}.

', 'DeleteStepDetails$SourceFileLocation' => '

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}.

', 'TagStepDetails$SourceFileLocation' => '

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}.

', ], ], 'SourceIp' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderRequest$SourceIp' => '

The source IP address of the account to be tested.

', ], ], 'SshPublicKey' => [ 'base' => '

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.

', 'refs' => [ 'SshPublicKeys$member' => NULL, ], ], 'SshPublicKeyBody' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$SshPublicKeyBody' => '

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

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

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

For RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

', 'ImportSshPublicKeyRequest$SshPublicKeyBody' => '

The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

', 'SshPublicKey$SshPublicKeyBody' => '

Specifies the content of the SSH public key as specified by the PublicKeyId.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

', ], ], 'SshPublicKeyCount' => [ 'base' => NULL, 'refs' => [ 'ListedUser$SshPublicKeyCount' => '

Specifies the number of SSH public keys stored for the user you specified.

', ], ], 'SshPublicKeyId' => [ 'base' => NULL, 'refs' => [ 'DeleteSshPublicKeyRequest$SshPublicKeyId' => '

A unique identifier used to reference your user\'s specific SSH key.

', 'ImportSshPublicKeyResponse$SshPublicKeyId' => '

The name given to a public key by the system that was imported.

', 'SshPublicKey$SshPublicKeyId' => '

Specifies the SshPublicKeyId parameter contains the identifier of the public key.

', ], ], 'SshPublicKeys' => [ 'base' => NULL, 'refs' => [ 'DescribedUser$SshPublicKeys' => '

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

', ], ], 'StartFileTransferRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFileTransferResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'State' => [ 'base' => '

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server\'s was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

', 'refs' => [ 'DescribedServer$State' => '

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.

', 'ListedServer$State' => '

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'TestConnectionResponse$Status' => '

Returns OK for successful test, or ERROR if the test fails.

', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderResponse$StatusCode' => '

The HTTP status code that is the response from your API Gateway or your Lambda function.

', ], ], 'StepResultOutputsJson' => [ 'base' => NULL, 'refs' => [ 'ExecutionStepResult$Outputs' => '

The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

', ], ], 'StopServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StructuredLogDestinations' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$StructuredLogDestinations' => '

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

', 'DescribedServer$StructuredLogDestinations' => '

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:*

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

', 'UpdateServerRequest$StructuredLogDestinations' => '

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:*

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$SubnetIds' => '

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.

', ], ], 'Tag' => [ 'base' => '

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.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The name assigned to the tag that you create.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagStepDetails' => [ 'base' => '

Each step type has its own StepDetails structure.

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

', 'refs' => [ 'WorkflowStep$TagStepDetails' => '

Details for a step that creates one or more tags.

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

', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Contains one or more values that you assigned to the key name you create.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Tags' => '

Key-value pairs that can be used to group and search for agreements.

', 'CreateConnectorRequest$Tags' => '

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

', 'CreateProfileRequest$Tags' => '

Key-value pairs that can be used to group and search for AS2 profiles.

', 'CreateServerRequest$Tags' => '

Key-value pairs that can be used to group and search for servers.

', 'CreateUserRequest$Tags' => '

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

', 'CreateWorkflowRequest$Tags' => '

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

', 'DescribedAgreement$Tags' => '

Key-value pairs that can be used to group and search for agreements.

', 'DescribedCertificate$Tags' => '

Key-value pairs that can be used to group and search for certificates.

', 'DescribedConnector$Tags' => '

Key-value pairs that can be used to group and search for connectors.

', 'DescribedHostKey$Tags' => '

Key-value pairs that can be used to group and search for host keys.

', 'DescribedProfile$Tags' => '

Key-value pairs that can be used to group and search for profiles.

', 'DescribedServer$Tags' => '

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

', 'DescribedUser$Tags' => '

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

', 'DescribedWorkflow$Tags' => '

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

', 'ImportCertificateRequest$Tags' => '

Key-value pairs that can be used to group and search for certificates.

', 'ImportHostKeyRequest$Tags' => '

Key-value pairs that can be used to group and search for host keys.

', 'ListTagsForResourceResponse$Tags' => '

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

', 'TagResourceRequest$Tags' => '

Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.

', ], ], 'TestConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'TestIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

', 'refs' => [], ], 'TlsSessionResumptionMode' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$TlsSessionResumptionMode' => '

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.

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.

', ], ], 'TransferId' => [ 'base' => NULL, 'refs' => [ 'StartFileTransferResponse$TransferId' => '

Returns the unique identifier for the file transfer.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => '

UpdateUserResponse returns the user name and identifier for the request to update a user\'s properties.

', 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorRequest$Url' => '

The URL of the partner\'s AS2 or SFTP endpoint.

', 'DescribedConnector$Url' => '

The URL of the partner\'s AS2 or SFTP endpoint.

', 'IdentityProviderDetails$Url' => '

Provides the location of the service endpoint used to authenticate users.

', 'ListedConnector$Url' => '

The URL of the partner\'s AS2 or SFTP endpoint.

', 'TestIdentityProviderResponse$Url' => '

The endpoint of the service used to authenticate a user.

', 'UpdateConnectorRequest$Url' => '

The URL of the partner\'s AS2 or SFTP endpoint.

', ], ], 'UserCount' => [ 'base' => NULL, 'refs' => [ 'DescribedServer$UserCount' => '

Specifies the number of users that are assigned to a server you specified with the ServerId.

', 'ListedServer$UserCount' => '

Specifies the number of users that are assigned to a server you specified with the ServerId.

', ], ], 'UserDetails' => [ 'base' => '

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

', 'refs' => [ 'ServiceMetadata$UserDetails' => '

The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$UserName' => '

A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore \'_\', hyphen \'-\', period \'.\', and at sign \'@\'. The user name can\'t start with a hyphen, period, or at sign.

', 'CreateUserResponse$UserName' => '

A unique string that identifies a Transfer Family user.

', 'DeleteSshPublicKeyRequest$UserName' => '

A unique string that identifies a user whose public key is being deleted.

', 'DeleteUserRequest$UserName' => '

A unique string that identifies a user that is being deleted from a server.

', 'DescribeUserRequest$UserName' => '

The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.

', 'DescribedUser$UserName' => '

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.

', 'ImportSshPublicKeyRequest$UserName' => '

The name of the Transfer Family user that is assigned to one or more servers.

', 'ImportSshPublicKeyResponse$UserName' => '

A user name assigned to the ServerID value that you specified.

', 'ListedUser$UserName' => '

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

', 'TestIdentityProviderRequest$UserName' => '

The name of the account to be tested.

', 'UpdateUserRequest$UserName' => '

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore \'_\', hyphen \'-\', period \'.\', and at sign \'@\'. The user name can\'t start with a hyphen, period, or at sign.

', 'UpdateUserResponse$UserName' => '

The unique identifier for a user that is assigned to a server instance that was specified in the request.

', 'UserDetails$UserName' => '

A unique string that identifies a Transfer Family user associated with a server.

', ], ], 'UserPassword' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderRequest$UserPassword' => '

The password of the account to be tested.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$VpcEndpointId' => '

The identifier of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$VpcId' => '

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.

', ], ], 'WorkflowDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$Description' => '

A textual description for the workflow.

', 'DescribedWorkflow$Description' => '

Specifies the text description for the workflow.

', 'ListedWorkflow$Description' => '

Specifies the text description for the workflow.

', ], ], 'WorkflowDetail' => [ 'base' => '

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.

', 'refs' => [ 'OnPartialUploadWorkflowDetails$member' => NULL, 'OnUploadWorkflowDetails$member' => NULL, ], ], 'WorkflowDetails' => [ 'base' => '

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

', 'refs' => [ 'CreateServerRequest$WorkflowDetails' => '

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

', 'DescribedServer$WorkflowDetails' => '

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

', 'UpdateServerRequest$WorkflowDetails' => '

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

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":[]}\'

', ], ], 'WorkflowId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$WorkflowId' => '