Transfer ******** Client ====== class Transfer.Client A low-level client representing AWS Transfer Family 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 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. import boto3 client = boto3.client('transfer') These are the available methods: * can_paginate * close * create_access * create_agreement * create_connector * create_profile * create_server * create_user * create_web_app * create_workflow * delete_access * delete_agreement * delete_certificate * delete_connector * delete_host_key * delete_profile * delete_server * delete_ssh_public_key * delete_user * delete_web_app * delete_web_app_customization * delete_workflow * describe_access * describe_agreement * describe_certificate * describe_connector * describe_execution * describe_host_key * describe_profile * describe_security_policy * describe_server * describe_user * describe_web_app * describe_web_app_customization * describe_workflow * get_paginator * get_waiter * import_certificate * import_host_key * import_ssh_public_key * list_accesses * list_agreements * list_certificates * list_connectors * list_executions * list_file_transfer_results * list_host_keys * list_profiles * list_security_policies * list_servers * list_tags_for_resource * list_users * list_web_apps * list_workflows * send_workflow_step_state * start_directory_listing * start_file_transfer * start_remote_delete * start_remote_move * start_server * stop_server * tag_resource * test_connection * test_identity_provider * untag_resource * update_access * update_agreement * update_certificate * update_connector * update_host_key * update_profile * update_server * update_user * update_web_app * update_web_app_customization Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAccesses * ListAgreements * ListCertificates * ListConnectors * ListExecutions * ListFileTransferResults * ListProfiles * ListSecurityPolicies * ListServers * ListTagsForResource * ListUsers * ListWebApps * ListWorkflows Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ServerOffline * ServerOnline Transfer / Waiter / ServerOnline ServerOnline ************ class Transfer.Waiter.ServerOnline waiter = client.get_waiter('server_online') wait(**kwargs) Polls "Transfer.Client.describe_server()" every 30 seconds until a successful state is reached. An error is raised after 120 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ServerId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 120 Returns: None Transfer / Waiter / ServerOffline ServerOffline ************* class Transfer.Waiter.ServerOffline waiter = client.get_waiter('server_offline') wait(**kwargs) Polls "Transfer.Client.describe_server()" every 30 seconds until a successful state is reached. An error is raised after 120 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ServerId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 120 Returns: None Transfer / Paginator / ListTagsForResource ListTagsForResource ******************* class Transfer.Paginator.ListTagsForResource paginator = client.get_paginator('list_tags_for_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_tags_for_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Arn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN you specified to list the tags of. * **Tags** *(list) --* 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. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. Transfer / Paginator / ListAccesses ListAccesses ************ class Transfer.Paginator.ListAccesses paginator = client.get_paginator('list_accesses') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_accesses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ServerId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server that has users assigned to it. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'Accesses': [ { 'HomeDirectory': 'string', 'HomeDirectoryType': 'PATH'|'LOGICAL', 'Role': 'string', 'ExternalId': 'string' }, ] } **Response Structure** * *(dict) --* * **ServerId** *(string) --* A system-assigned unique identifier for a server that has users assigned to it. * **Accesses** *(list) --* Returns the accesses and their properties for the "ServerId" value that you specify. * *(dict) --* Lists the properties for one or more specified associated accesses. * **HomeDirectory** *(string) --* 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** *(string) --* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **Role** *(string) --* 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. * **ExternalId** *(string) --* 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: =,.@:/- Transfer / Paginator / ListFileTransferResults ListFileTransferResults *********************** class Transfer.Paginator.ListFileTransferResults paginator = client.get_paginator('list_file_transfer_results') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_file_transfer_results()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ConnectorId='string', TransferId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** A unique identifier for a connector. This value should match the value supplied to the corresponding "StartFileTransfer" call. * **TransferId** (*string*) -- **[REQUIRED]** A unique identifier for a file transfer. This value should match the value supplied to the corresponding "StartFileTransfer" call. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FileTransferResults': [ { 'FilePath': 'string', 'StatusCode': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'FAILED', 'FailureCode': 'string', 'FailureMessage': 'string' }, ], } **Response Structure** * *(dict) --* * **FileTransferResults** *(list) --* Returns the details for the files transferred in the transfer identified by the "TransferId" and "ConnectorId" specified. * "FilePath": the filename and path to where the file was sent to or retrieved from. * "StatusCode": current status for the transfer. The status returned is one of the following values: "QUEUED", "IN_PROGRESS", "COMPLETED", or "FAILED" * "FailureCode": for transfers that fail, this parameter contains a code indicating the reason. For example, "RETRIEVE_FILE_NOT_FOUND" * "FailureMessage": for transfers that fail, this parameter describes the reason for the failure. * *(dict) --* A structure that contains the details for files transferred using an SFTP connector, during a single transfer. * **FilePath** *(string) --* The filename and path to where the file was sent to or retrieved from. * **StatusCode** *(string) --* The current status for the transfer. * **FailureCode** *(string) --* For transfers that fail, this parameter contains a code indicating the reason. For example, "RETRIEVE_FILE_NOT_FOUND" * **FailureMessage** *(string) --* For transfers that fail, this parameter describes the reason for the failure. Transfer / Paginator / ListWorkflows ListWorkflows ************* class Transfer.Paginator.ListWorkflows paginator = client.get_paginator('list_workflows') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_workflows()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Workflows': [ { 'WorkflowId': 'string', 'Description': 'string', 'Arn': 'string' }, ] } **Response Structure** * *(dict) --* * **Workflows** *(list) --* Returns the "Arn", "WorkflowId", and "Description" for each workflow. * *(dict) --* Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow. * **WorkflowId** *(string) --* A unique identifier for the workflow. * **Description** *(string) --* Specifies the text description for the workflow. * **Arn** *(string) --* Specifies the unique Amazon Resource Name (ARN) for the workflow. Transfer / Paginator / ListExecutions ListExecutions ************** class Transfer.Paginator.ListExecutions paginator = client.get_paginator('list_executions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_executions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( WorkflowId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **WorkflowId** (*string*) -- **[REQUIRED]** A unique identifier for the workflow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'WorkflowId': 'string', 'Executions': [ { 'ExecutionId': 'string', 'InitialFileLocation': { 'S3FileLocation': { 'Bucket': 'string', 'Key': 'string', 'VersionId': 'string', 'Etag': 'string' }, 'EfsFileLocation': { 'FileSystemId': 'string', 'Path': 'string' } }, 'ServiceMetadata': { 'UserDetails': { 'UserName': 'string', 'ServerId': 'string', 'SessionId': 'string' } }, 'Status': 'IN_PROGRESS'|'COMPLETED'|'EXCEPTION'|'HANDLING_EXCEPTION' }, ] } **Response Structure** * *(dict) --* * **WorkflowId** *(string) --* A unique identifier for the workflow. * **Executions** *(list) --* Returns the details for each execution, in a "ListedExecution" array. * *(dict) --* Returns properties of the execution that is specified. * **ExecutionId** *(string) --* A unique identifier for the execution of a workflow. * **InitialFileLocation** *(dict) --* 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. * **S3FileLocation** *(dict) --* Specifies the S3 details for the file being used, such as bucket, ETag, and so forth. * **Bucket** *(string) --* Specifies the S3 bucket that contains the file being used. * **Key** *(string) --* The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object. * **VersionId** *(string) --* Specifies the file version. * **Etag** *(string) --* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. * **EfsFileLocation** *(dict) --* Specifies the Amazon EFS identifier and the path for the file being used. * **FileSystemId** *(string) --* The identifier of the file system, assigned by Amazon EFS. * **Path** *(string) --* The pathname for the folder being used by a workflow. * **ServiceMetadata** *(dict) --* A container object for the session details that are associated with a workflow. * **UserDetails** *(dict) --* The Server ID ( "ServerId"), Session ID ( "SessionId") and user ( "UserName") make up the "UserDetails". * **UserName** *(string) --* A unique string that identifies a Transfer Family user associated with a server. * **ServerId** *(string) --* The system-assigned unique identifier for a Transfer server instance. * **SessionId** *(string) --* The system-assigned unique identifier for a session that corresponds to the workflow. * **Status** *(string) --* The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. Transfer / Paginator / ListServers ListServers *********** class Transfer.Paginator.ListServers paginator = client.get_paginator('list_servers') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_servers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Servers': [ { 'Arn': 'string', 'Domain': 'S3'|'EFS', 'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY'|'AWS_DIRECTORY_SERVICE'|'AWS_LAMBDA', 'EndpointType': 'PUBLIC'|'VPC'|'VPC_ENDPOINT', 'LoggingRole': 'string', 'ServerId': 'string', 'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED', 'UserCount': 123 }, ] } **Response Structure** * *(dict) --* * **Servers** *(list) --* An array of servers that were listed. * *(dict) --* Returns properties of a file transfer protocol-enabled server that was specified. * **Arn** *(string) --* Specifies the unique Amazon Resource Name (ARN) for a server to be listed. * **Domain** *(string) --* Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3. * **IdentityProviderType** *(string) --* 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. * **EndpointType** *(string) --* 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. * **LoggingRole** *(string) --* 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 EFS events. When set, you can view user activity in your CloudWatch logs. * **ServerId** *(string) --* Specifies the unique system assigned identifier for the servers that were listed. * **State** *(string) --* 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. * **UserCount** *(integer) --* Specifies the number of users that are assigned to a server you specified with the "ServerId". Transfer / Paginator / ListUsers ListUsers ********* class Transfer.Paginator.ListUsers paginator = client.get_paginator('list_users') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_users()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ServerId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server that has users assigned to it. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'Users': [ { 'Arn': 'string', 'HomeDirectory': 'string', 'HomeDirectoryType': 'PATH'|'LOGICAL', 'Role': 'string', 'SshPublicKeyCount': 123, 'UserName': 'string' }, ] } **Response Structure** * *(dict) --* * **ServerId** *(string) --* A system-assigned unique identifier for a server that the users are assigned to. * **Users** *(list) --* Returns the Transfer Family users and their properties for the "ServerId" value that you specify. * *(dict) --* Returns properties of the user that you specify. * **Arn** *(string) --* Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about. * **HomeDirectory** *(string) --* 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** *(string) --* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **Role** *(string) --* 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. Note: 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. * **SshPublicKeyCount** *(integer) --* Specifies the number of SSH public keys stored for the user you specified. * **UserName** *(string) --* Specifies the name of the user whose ARN was specified. User names are used for authentication purposes. Transfer / Paginator / ListWebApps ListWebApps *********** class Transfer.Paginator.ListWebApps paginator = client.get_paginator('list_web_apps') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_web_apps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'WebApps': [ { 'Arn': 'string', 'WebAppId': 'string', 'AccessEndpoint': 'string', 'WebAppEndpoint': 'string' }, ] } **Response Structure** * *(dict) --* * **WebApps** *(list) --* Returns, for each listed web app, a structure that contains details for the web app. * *(dict) --* a structure that contains details for the web app. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the web app. * **WebAppId** *(string) --* The unique identifier for the web app. * **AccessEndpoint** *(string) --* The "AccessEndpoint" is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. * **WebAppEndpoint** *(string) --* The "WebAppEndpoint" is the unique URL for your Transfer Family web app. This is the value that you use when you configure **Origins** on CloudFront. Transfer / Paginator / ListAgreements ListAgreements ************** class Transfer.Paginator.ListAgreements paginator = client.get_paginator('list_agreements') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_agreements()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ServerId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** The identifier of the server for which you want a list of agreements. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Agreements': [ { 'Arn': 'string', 'AgreementId': 'string', 'Description': 'string', 'Status': 'ACTIVE'|'INACTIVE', 'ServerId': 'string', 'LocalProfileId': 'string', 'PartnerProfileId': 'string' }, ] } **Response Structure** * *(dict) --* * **Agreements** *(list) --* Returns an array, where each item contains the details of an agreement. * *(dict) --* Describes the properties of an agreement. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified agreement. * **AgreementId** *(string) --* A unique identifier for the agreement. This identifier is returned when you create an agreement. * **Description** *(string) --* The current description for the agreement. You can change it by calling the "UpdateAgreement" operation and providing a new description. * **Status** *(string) --* The agreement can be either "ACTIVE" or "INACTIVE". * **ServerId** *(string) --* The unique identifier for the agreement. * **LocalProfileId** *(string) --* A unique identifier for the AS2 local profile. * **PartnerProfileId** *(string) --* A unique identifier for the partner profile. Transfer / Paginator / ListCertificates ListCertificates **************** class Transfer.Paginator.ListCertificates paginator = client.get_paginator('list_certificates') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_certificates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Certificates': [ { 'Arn': 'string', 'CertificateId': 'string', 'Usage': 'SIGNING'|'ENCRYPTION'|'TLS', 'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE', 'ActiveDate': datetime(2015, 1, 1), 'InactiveDate': datetime(2015, 1, 1), 'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **Certificates** *(list) --* Returns an array of the certificates that are specified in the "ListCertificates" call. * *(dict) --* Describes the properties of a certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified certificate. * **CertificateId** *(string) --* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. * **Usage** *(string) --* Specifies how this certificate is used. It can be used in the following ways: * "SIGNING": For signing AS2 messages * "ENCRYPTION": For encrypting AS2 messages * "TLS": For securing AS2 communications sent over HTTPS * **Status** *(string) --* The certificate can be either "ACTIVE", "PENDING_ROTATION", or "INACTIVE". "PENDING_ROTATION" means that this certificate will replace the current certificate when it expires. * **ActiveDate** *(datetime) --* An optional date that specifies when the certificate becomes active. If you do not specify a value, "ActiveDate" takes the same value as "NotBeforeDate", which is specified by the CA. * **InactiveDate** *(datetime) --* An optional date that specifies when the certificate becomes inactive. If you do not specify a value, "InactiveDate" takes the same value as "NotAfterDate", which is specified by the CA. * **Type** *(string) --* 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". * **Description** *(string) --* The name or short description that's used to identify the certificate. Transfer / Paginator / ListSecurityPolicies ListSecurityPolicies ******************** class Transfer.Paginator.ListSecurityPolicies paginator = client.get_paginator('list_security_policies') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_security_policies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecurityPolicyNames': [ 'string', ] } **Response Structure** * *(dict) --* * **SecurityPolicyNames** *(list) --* An array of security policies that were listed. * *(string) --* Transfer / Paginator / ListConnectors ListConnectors ************** class Transfer.Paginator.ListConnectors paginator = client.get_paginator('list_connectors') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_connectors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Connectors': [ { 'Arn': 'string', 'ConnectorId': 'string', 'Url': 'string' }, ] } **Response Structure** * *(dict) --* * **Connectors** *(list) --* Returns an array, where each item contains the details of a connector. * *(dict) --* Returns details of the connector that is specified. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified connector. * **ConnectorId** *(string) --* The unique identifier for the connector. * **Url** *(string) --* The URL of the partner's AS2 or SFTP endpoint. Transfer / Paginator / ListProfiles ListProfiles ************ class Transfer.Paginator.ListProfiles paginator = client.get_paginator('list_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "Transfer.Client.list_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProfileType='LOCAL'|'PARTNER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProfileType** (*string*) -- 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Profiles': [ { 'Arn': 'string', 'ProfileId': 'string', 'As2Id': 'string', 'ProfileType': 'LOCAL'|'PARTNER' }, ] } **Response Structure** * *(dict) --* * **Profiles** *(list) --* Returns an array, where each item contains the details of a profile. * *(dict) --* Returns the properties of the profile that was specified. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified profile. * **ProfileId** *(string) --* A unique identifier for the local or partner AS2 profile. * **As2Id** *(string) --* 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. * **ProfileType** *(string) --* 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. Transfer / Client / test_connection test_connection *************** Transfer.Client.test_connection(**kwargs) 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 local Amazon Web Services storage and a trading partner's SFTP server. See also: AWS API Documentation **Request Syntax** response = client.test_connection( ConnectorId='string' ) Parameters: **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. Return type: dict Returns: **Response Syntax** { 'ConnectorId': 'string', 'Status': 'string', 'StatusMessage': 'string', 'SftpConnectionDetails': { 'HostKey': 'string' } } **Response Structure** * *(dict) --* * **ConnectorId** *(string) --* Returns the identifier of the connector object that you are testing. * **Status** *(string) --* Returns "OK" for successful test, or "ERROR" if the test fails. * **StatusMessage** *(string) --* Returns "Connection succeeded" if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive. * Verify that your secret name aligns with the one in Transfer Role permissions. * Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector. * Verify that the secret exists and is formatted correctly. * Verify that the trusted host key in the connector configuration matches the "ssh-keyscan" output. * **SftpConnectionDetails** *(dict) --* Structure that contains the SFTP connector host key. * **HostKey** *(string) --* The SSH public key of the remote SFTP server. This is returned during the initial connection attempt when you call "TestConnection". It allows you to retrieve the valid server host key to update the connector when you are unable to obtain it in advance. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / get_paginator get_paginator ************* Transfer.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Transfer / Client / create_web_app create_web_app ************** Transfer.Client.create_web_app(**kwargs) Creates a web app based on specified parameters, and returns the ID for the new web app. See also: AWS API Documentation **Request Syntax** response = client.create_web_app( IdentityProviderDetails={ 'IdentityCenterConfig': { 'InstanceArn': 'string', 'Role': 'string' } }, AccessEndpoint='string', WebAppUnits={ 'Provisioned': 123 }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], WebAppEndpointPolicy='FIPS'|'STANDARD' ) Parameters: * **IdentityProviderDetails** (*dict*) -- **[REQUIRED]** You can provide a structure that contains the details for the identity provider to use with your web app. For more details about this parameter, see Configure your identity provider for Transfer Family web apps. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "IdentityCenterConfig". * **IdentityCenterConfig** *(dict) --* A structure that describes the values to use for the IAM Identity Center settings when you create a web app. * **InstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app. * **Role** *(string) --* The IAM role in IAM Identity Center used for the web app. * **AccessEndpoint** (*string*) -- The "AccessEndpoint" is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL. * **WebAppUnits** (*dict*) -- A union that contains the value for number of concurrent connections or the user sessions on your web app. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Provisioned". * **Provisioned** *(integer) --* An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time. Each increment allows an additional 250 concurrent sessions: a value of "1" sets the number of concurrent sessions to 250; "2" sets a value of 500, and so on. * **Tags** (*list*) -- Key-value pairs that can be used to group and search for web apps. * *(dict) --* 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. * **Key** *(string) --* **[REQUIRED]** The name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name you create. * **WebAppEndpointPolicy** (*string*) -- Setting for the type of endpoint policy for the web app. The default value is "STANDARD". If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to "FIPS". Return type: dict Returns: **Response Syntax** { 'WebAppId': 'string' } **Response Structure** * *(dict) --* * **WebAppId** *(string) --* Returns a unique identifier for the web app. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / describe_connector describe_connector ****************** Transfer.Client.describe_connector(**kwargs) Describes the connector that's identified by the "ConnectorId." See also: AWS API Documentation **Request Syntax** response = client.describe_connector( ConnectorId='string' ) Parameters: **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. Return type: dict Returns: **Response Syntax** { 'Connector': { 'Arn': 'string', 'ConnectorId': 'string', 'Url': 'string', 'As2Config': { 'LocalProfileId': 'string', 'PartnerProfileId': 'string', 'MessageSubject': 'string', 'Compression': 'ZLIB'|'DISABLED', 'EncryptionAlgorithm': 'AES128_CBC'|'AES192_CBC'|'AES256_CBC'|'DES_EDE3_CBC'|'NONE', 'SigningAlgorithm': 'SHA256'|'SHA384'|'SHA512'|'SHA1'|'NONE', 'MdnSigningAlgorithm': 'SHA256'|'SHA384'|'SHA512'|'SHA1'|'NONE'|'DEFAULT', 'MdnResponse': 'SYNC'|'NONE', 'BasicAuthSecretId': 'string', 'PreserveContentType': 'ENABLED'|'DISABLED' }, 'AccessRole': 'string', 'LoggingRole': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SftpConfig': { 'UserSecretId': 'string', 'TrustedHostKeys': [ 'string', ], 'MaxConcurrentConnections': 123 }, 'ServiceManagedEgressIpAddresses': [ 'string', ], 'SecurityPolicyName': 'string' } } **Response Structure** * *(dict) --* * **Connector** *(dict) --* The structure that contains the details of the connector. * **Arn** *(string) --* The unique Amazon Resource Name (ARN) for the connector. * **ConnectorId** *(string) --* The unique identifier for the connector. * **Url** *(string) --* The URL of the partner's AS2 or SFTP endpoint. * **As2Config** *(dict) --* A structure that contains the parameters for an AS2 connector object. * **LocalProfileId** *(string) --* A unique identifier for the AS2 local profile. * **PartnerProfileId** *(string) --* A unique identifier for the partner profile for the connector. * **MessageSubject** *(string) --* Used as the "Subject" HTTP header attribute in AS2 messages that are being sent with the connector. * **Compression** *(string) --* Specifies whether the AS2 file is compressed. * **EncryptionAlgorithm** *(string) --* The algorithm that is used to encrypt the file. Note the following: * Do not use the "DES_EDE3_CBC" algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm. * You can only specify "NONE" if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text. * **SigningAlgorithm** *(string) --* The algorithm that is used to sign the AS2 messages sent with the connector. * **MdnSigningAlgorithm** *(string) --* The signing algorithm for the MDN response. Note: If set to DEFAULT (or not set at all), the value for "SigningAlgorithm" is used. * **MdnResponse** *(string) --* Used for outbound requests (from an Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values: * "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. * **BasicAuthSecretId** *(string) --* 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=""'" * **PreserveContentType** *(string) --* Allows you to use the Amazon S3 "Content-Type" that is associated with objects in S3 instead of having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly. * **AccessRole** *(string) --* Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use. **For AS2 connectors** With AS2, you can send files by calling "StartFileTransfer" and specifying the file paths in the request parameter, "SendFilePaths". We use the file’s parent directory (for example, for "--send-file-paths /bucket/dir/file.txt", parent directory is "/bucket/dir/") to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the "AccessRole" needs to provide read and write access to the parent directory of the file location used in the "StartFileTransfer" request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with "StartFileTransfer". If you are using Basic authentication for your AS2 connector, the access role requires the "secretsmanager:GetSecretValue" permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the "kms:Decrypt" permission for that key. **For SFTP connectors** Make sure that the access role provides read and write access to the parent directory of the file location that's used in the "StartFileTransfer" request. Additionally, make sure that the role provides "secretsmanager:GetSecretValue" permission to Secrets Manager. * **LoggingRole** *(string) --* 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. * **Tags** *(list) --* Key-value pairs that can be used to group and search for connectors. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. * **SftpConfig** *(dict) --* A structure that contains the parameters for an SFTP connector object. * **UserSecretId** *(string) --* The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret. Note: * Required when creating an SFTP connector * Optional when updating an existing SFTP connector * **TrustedHostKeys** *(list) --* The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the "ssh-keyscan" command against the SFTP server to retrieve the necessary key. Note: "TrustedHostKeys" is optional for "CreateConnector". If not provided, you can use "TestConnection" to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key. The three standard SSH public key format elements are "", "", and an optional "", with spaces between each element. Specify only the "" and "": do not enter the "" portion of the key. For the trusted host key, Transfer Family accepts RSA and ECDSA keys. * For RSA keys, the "" string is "ssh-rsa". * For ECDSA keys, the "" string is either "ecdsa-sha2-nistp256", "ecdsa-sha2-nistp384", or "ecdsa-sha2-nistp521", depending on the size of the key you generated. Run this command to retrieve the SFTP server host key, where your SFTP server name is "ftp.host.com". "ssh-keyscan ftp.host.com" This prints the public host key to standard output. "ftp.host.com ssh-rsa AAAAB3Nza... --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"" See also: AWS API Documentation **Request Syntax** response = client.update_user( HomeDirectory='string', HomeDirectoryType='PATH'|'LOGICAL', HomeDirectoryMappings=[ { 'Entry': 'string', 'Target': 'string', 'Type': 'FILE'|'DIRECTORY' }, ], Policy='string', PosixProfile={ 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] }, Role='string', ServerId='string', UserName='string' ) Parameters: * **HomeDirectory** (*string*) -- 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** (*string*) -- The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **HomeDirectoryMappings** (*list*) -- 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" } ]" * *(dict) --* 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" } ]" * **Entry** *(string) --* **[REQUIRED]** Represents an entry for "HomeDirectoryMappings". * **Target** *(string) --* **[REQUIRED]** Represents the map target that is used in a "HomeDirectoryMapEntry". * **Type** *(string) --* Specifies the type of mapping. Set the type to "FILE" if you want the mapping to point to a file, or "DIRECTORY" for the directory to point to a directory. Note: By default, home directory mappings have a "Type" of "DIRECTORY" when you create a Transfer Family server. You would need to explicitly set "Type" to "FILE" if you want a mapping to have a file target. * **Policy** (*string*) -- 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}". Note: 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 Creating a session policy.For more information, see AssumeRole in the *Amazon Web Services Security Token Service API Reference*. * **PosixProfile** (*dict*) -- 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. * **Uid** *(integer) --* **[REQUIRED]** The POSIX user ID used for all EFS operations by this user. * **Gid** *(integer) --* **[REQUIRED]** The POSIX group ID used for all EFS operations by this user. * **SecondaryGids** *(list) --* The secondary POSIX group IDs used for all EFS operations by this user. * *(integer) --* * **Role** (*string*) -- 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. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to. * **UserName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'UserName': 'string' } **Response Structure** * *(dict) --* "UpdateUserResponse" returns the user name and identifier for the request to update a user's properties. * **ServerId** *(string) --* A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to. * **UserName** *(string) --* The unique identifier for a user that is assigned to a server instance that was specified in the request. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / test_identity_provider test_identity_provider ********************** Transfer.Client.test_identity_provider(**kwargs) 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)**. See also: AWS API Documentation **Request Syntax** response = client.test_identity_provider( ServerId='string', ServerProtocol='SFTP'|'FTP'|'FTPS'|'AS2', SourceIp='string', UserName='string', UserPassword='string' ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password. * **ServerProtocol** (*string*) -- 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) * **SourceIp** (*string*) -- The source IP address of the account to be tested. * **UserName** (*string*) -- **[REQUIRED]** The name of the account to be tested. * **UserPassword** (*string*) -- The password of the account to be tested. Return type: dict Returns: **Response Syntax** { 'Response': 'string', 'StatusCode': 123, 'Message': 'string', 'Url': 'string' } **Response Structure** * *(dict) --* * **Response** *(string) --* The response that is returned from your API Gateway or your Lambda function. * **StatusCode** *(integer) --* The HTTP status code that is the response from your API Gateway or your Lambda function. * **Message** *(string) --* A message that indicates whether the test was successful or not. Note: If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password. * **Url** *(string) --* The endpoint of the service used to authenticate a user. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / describe_execution describe_execution ****************** Transfer.Client.describe_execution(**kwargs) You can use "DescribeExecution" to check the details of the execution of the specified workflow. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.describe_execution( ExecutionId='string', WorkflowId='string' ) Parameters: * **ExecutionId** (*string*) -- **[REQUIRED]** A unique identifier for the execution of a workflow. * **WorkflowId** (*string*) -- **[REQUIRED]** A unique identifier for the workflow. Return type: dict Returns: **Response Syntax** { 'WorkflowId': 'string', 'Execution': { 'ExecutionId': 'string', 'InitialFileLocation': { 'S3FileLocation': { 'Bucket': 'string', 'Key': 'string', 'VersionId': 'string', 'Etag': 'string' }, 'EfsFileLocation': { 'FileSystemId': 'string', 'Path': 'string' } }, 'ServiceMetadata': { 'UserDetails': { 'UserName': 'string', 'ServerId': 'string', 'SessionId': 'string' } }, 'ExecutionRole': 'string', 'LoggingConfiguration': { 'LoggingRole': 'string', 'LogGroupName': 'string' }, 'PosixProfile': { 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] }, 'Status': 'IN_PROGRESS'|'COMPLETED'|'EXCEPTION'|'HANDLING_EXCEPTION', 'Results': { 'Steps': [ { 'StepType': 'COPY'|'CUSTOM'|'TAG'|'DELETE'|'DECRYPT', 'Outputs': 'string', 'Error': { 'Type': 'PERMISSION_DENIED'|'CUSTOM_STEP_FAILED'|'THROTTLED'|'ALREADY_EXISTS'|'NOT_FOUND'|'BAD_REQUEST'|'TIMEOUT'|'INTERNAL_SERVER_ERROR', 'Message': 'string' } }, ], 'OnExceptionSteps': [ { 'StepType': 'COPY'|'CUSTOM'|'TAG'|'DELETE'|'DECRYPT', 'Outputs': 'string', 'Error': { 'Type': 'PERMISSION_DENIED'|'CUSTOM_STEP_FAILED'|'THROTTLED'|'ALREADY_EXISTS'|'NOT_FOUND'|'BAD_REQUEST'|'TIMEOUT'|'INTERNAL_SERVER_ERROR', 'Message': 'string' } }, ] } } } **Response Structure** * *(dict) --* * **WorkflowId** *(string) --* A unique identifier for the workflow. * **Execution** *(dict) --* The structure that contains the details of the workflow' execution. * **ExecutionId** *(string) --* A unique identifier for the execution of a workflow. * **InitialFileLocation** *(dict) --* 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. * **S3FileLocation** *(dict) --* Specifies the S3 details for the file being used, such as bucket, ETag, and so forth. * **Bucket** *(string) --* Specifies the S3 bucket that contains the file being used. * **Key** *(string) --* The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object. * **VersionId** *(string) --* Specifies the file version. * **Etag** *(string) --* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. * **EfsFileLocation** *(dict) --* Specifies the Amazon EFS identifier and the path for the file being used. * **FileSystemId** *(string) --* The identifier of the file system, assigned by Amazon EFS. * **Path** *(string) --* The pathname for the folder being used by a workflow. * **ServiceMetadata** *(dict) --* A container object for the session details that are associated with a workflow. * **UserDetails** *(dict) --* The Server ID ( "ServerId"), Session ID ( "SessionId") and user ( "UserName") make up the "UserDetails". * **UserName** *(string) --* A unique string that identifies a Transfer Family user associated with a server. * **ServerId** *(string) --* The system-assigned unique identifier for a Transfer server instance. * **SessionId** *(string) --* The system-assigned unique identifier for a session that corresponds to the workflow. * **ExecutionRole** *(string) --* The IAM role associated with the execution. * **LoggingConfiguration** *(dict) --* The IAM logging role associated with the execution. * **LoggingRole** *(string) --* 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 EFS events. When set, you can view user activity in your CloudWatch logs. * **LogGroupName** *(string) --* The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs. * **PosixProfile** *(dict) --* 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. * **Uid** *(integer) --* The POSIX user ID used for all EFS operations by this user. * **Gid** *(integer) --* The POSIX group ID used for all EFS operations by this user. * **SecondaryGids** *(list) --* The secondary POSIX group IDs used for all EFS operations by this user. * *(integer) --* * **Status** *(string) --* The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. * **Results** *(dict) --* 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. * **Steps** *(list) --* Specifies the details for the steps that are in the specified workflow. * *(dict) --* Specifies the following details for the step: error (if any), outputs (if any), and the step type. * **StepType** *(string) --* One of the available step types. * "COPY" - Copy the file to another location. * "CUSTOM" - Perform a custom step with an Lambda function target. * "DECRYPT" - Decrypt a file that was encrypted before it was uploaded. * "DELETE" - Delete the file. * "TAG" - Add a tag to the file. * **Outputs** *(string) --* The values for the key/value pair applied as a tag to the file. Only applicable if the step type is "TAG". * **Error** *(dict) --* Specifies the details for an error, if it occurred during execution of the specified workflow step. * **Type** *(string) --* Specifies the error type. * "ALREADY_EXISTS": occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location. * "BAD_REQUEST": a general bad request: for example, a step that attempts to tag an EFS file returns "BAD_REQUEST", as only S3 files can be tagged. * "CUSTOM_STEP_FAILED": occurs when the custom step provided a callback that indicates failure. * "INTERNAL_SERVER_ERROR": a catch-all error that can occur for a variety of reasons. * "NOT_FOUND": occurs when a requested entity, for example a source file for a copy step, does not exist. * "PERMISSION_DENIED": occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow. * "TIMEOUT": occurs when the execution times out. Note: You can set the "TimeoutSeconds" for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). * "THROTTLED": occurs if you exceed the new execution refill rate of one workflow per second. * **Message** *(string) --* Specifies the descriptive message that corresponds to the "ErrorType". * **OnExceptionSteps** *(list) --* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. * *(dict) --* Specifies the following details for the step: error (if any), outputs (if any), and the step type. * **StepType** *(string) --* One of the available step types. * "COPY" - Copy the file to another location. * "CUSTOM" - Perform a custom step with an Lambda function target. * "DECRYPT" - Decrypt a file that was encrypted before it was uploaded. * "DELETE" - Delete the file. * "TAG" - Add a tag to the file. * **Outputs** *(string) --* The values for the key/value pair applied as a tag to the file. Only applicable if the step type is "TAG". * **Error** *(dict) --* Specifies the details for an error, if it occurred during execution of the specified workflow step. * **Type** *(string) --* Specifies the error type. * "ALREADY_EXISTS": occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location. * "BAD_REQUEST": a general bad request: for example, a step that attempts to tag an EFS file returns "BAD_REQUEST", as only S3 files can be tagged. * "CUSTOM_STEP_FAILED": occurs when the custom step provided a callback that indicates failure. * "INTERNAL_SERVER_ERROR": a catch-all error that can occur for a variety of reasons. * "NOT_FOUND": occurs when a requested entity, for example a source file for a copy step, does not exist. * "PERMISSION_DENIED": occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow. * "TIMEOUT": occurs when the execution times out. Note: You can set the "TimeoutSeconds" for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). * "THROTTLED": occurs if you exceed the new execution refill rate of one workflow per second. * **Message** *(string) --* Specifies the descriptive message that corresponds to the "ErrorType". **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / delete_workflow delete_workflow *************** Transfer.Client.delete_workflow(**kwargs) Deletes the specified workflow. See also: AWS API Documentation **Request Syntax** response = client.delete_workflow( WorkflowId='string' ) Parameters: **WorkflowId** (*string*) -- **[REQUIRED]** A unique identifier for the workflow. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / update_server update_server ************* Transfer.Client.update_server(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_server( Certificate='string', ProtocolDetails={ 'PassiveIp': 'string', 'TlsSessionResumptionMode': 'DISABLED'|'ENABLED'|'ENFORCED', 'SetStatOption': 'DEFAULT'|'ENABLE_NO_OP', 'As2Transports': [ 'HTTP', ] }, EndpointDetails={ 'AddressAllocationIds': [ 'string', ], 'SubnetIds': [ 'string', ], 'VpcEndpointId': 'string', 'VpcId': 'string', 'SecurityGroupIds': [ 'string', ] }, EndpointType='PUBLIC'|'VPC'|'VPC_ENDPOINT', HostKey='string', IdentityProviderDetails={ 'Url': 'string', 'InvocationRole': 'string', 'DirectoryId': 'string', 'Function': 'string', 'SftpAuthenticationMethods': 'PASSWORD'|'PUBLIC_KEY'|'PUBLIC_KEY_OR_PASSWORD'|'PUBLIC_KEY_AND_PASSWORD' }, LoggingRole='string', PostAuthenticationLoginBanner='string', PreAuthenticationLoginBanner='string', Protocols=[ 'SFTP'|'FTP'|'FTPS'|'AS2', ], SecurityPolicyName='string', ServerId='string', WorkflowDetails={ 'OnUpload': [ { 'WorkflowId': 'string', 'ExecutionRole': 'string' }, ], 'OnPartialUpload': [ { 'WorkflowId': 'string', 'ExecutionRole': 'string' }, ] }, StructuredLogDestinations=[ 'string', ], S3StorageOptions={ 'DirectoryListingOptimization': 'ENABLED'|'DISABLED' }, IpAddressType='IPV4'|'DUALSTACK' ) Parameters: * **Certificate** (*string*) -- 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) Note: The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer. * **ProtocolDetails** (*dict*) -- 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. * **PassiveIp** *(string) --* 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. Note: 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. * **TlsSessionResumptionMode** *(string) --* A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. "TlsSessionResumptionMode" determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during "CreateServer" and "UpdateServer" calls. If a "TlsSessionResumptionMode" value is not specified during "CreateServer", it is set to "ENFORCED" by default. * "DISABLED": the server does not process TLS session resumption client requests and creates a new TLS session for each request. * "ENABLED": the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing. * "ENFORCED": the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to "ENFORCED", test your clients. Note: Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the "ENFORCED" value, you need to test your clients. * **SetStatOption** *(string) --* 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. Note: 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. * **As2Transports** *(list) --* Indicates the transport method for the AS2 messages. Currently, only HTTP is supported. * *(string) --* * **EndpointDetails** (*dict*) -- 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. * **AddressAllocationIds** *(list) --* A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint. An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the "allocationId" field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API. This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server. Note: This property can only be set as follows: * "EndpointType" must be set to "VPC" * The Transfer Family server must be offline. * You cannot set this parameter for Transfer Family servers that use the FTP protocol. * The server must already have "SubnetIds" populated ( "SubnetIds" and "AddressAllocationIds" cannot be updated simultaneously). * "AddressAllocationIds" can't contain duplicates, and must be equal in length to "SubnetIds". For example, if you have three subnet IDs, you must also specify three address allocation IDs. * Call the "UpdateServer" API to set or change this parameter. * You can't set address allocation IDs for servers that have an "IpAddressType" set to "DUALSTACK" You can only set this property if "IpAddressType" is set to "IPV4". * *(string) --* * **SubnetIds** *(list) --* A list of subnet IDs that are required to host your server endpoint in your VPC. Note: This property can only be set when "EndpointType" is set to "VPC". * *(string) --* * **VpcEndpointId** *(string) --* The identifier of the VPC endpoint. Note: 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** *(string) --* The VPC identifier of the VPC in which a server's endpoint will be hosted. Note: This property can only be set when "EndpointType" is set to "VPC". * **SecurityGroupIds** *(list) --* A list of security groups IDs that are available to attach to your server's endpoint. Note: 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. * *(string) --* * **EndpointType** (*string*) -- 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. Note: 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". * **HostKey** (*string*) -- 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. Warning: If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see Manage host keys for your SFTP- enabled server in the *Transfer Family User Guide*. * **IdentityProviderDetails** (*dict*) -- An array containing all of the information required to call a customer's authentication API method. * **Url** *(string) --* Provides the location of the service endpoint used to authenticate users. * **InvocationRole** *(string) --* This parameter is only applicable if your "IdentityProviderType" is "API_GATEWAY". Provides the type of "InvocationRole" used to authenticate the user account. * **DirectoryId** *(string) --* The identifier of the Directory Service directory that you want to use as your identity provider. * **Function** *(string) --* The ARN for a Lambda function to use for the Identity provider. * **SftpAuthenticationMethods** *(string) --* 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. * **LoggingRole** (*string*) -- 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 EFS events. When set, you can view user activity in your CloudWatch logs. * **PostAuthenticationLoginBanner** (*string*) -- Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. Note: The SFTP protocol does not support post-authentication display banners. * **PreAuthenticationLoginBanner** (*string*) -- 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." * **Protocols** (*list*) -- 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 Note: * 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. * *(string) --* * **SecurityPolicyName** (*string*) -- Specifies the name of the security policy for the server. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to. * **WorkflowDetails** (*dict*) -- 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. To remove an associated workflow from a server, you can provide an empty "OnUpload" object, as in the following example. "aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'" * **OnUpload** *(list) --* 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":[]}'" Note: "OnUpload" can contain a maximum of one "WorkflowDetail" object. * *(dict) --* 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. * **WorkflowId** *(string) --* **[REQUIRED]** A unique identifier for the workflow. * **ExecutionRole** *(string) --* **[REQUIRED]** 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 * **OnPartialUpload** *(list) --* 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. Note: "OnPartialUpload" can contain a maximum of one "WorkflowDetail" object. * *(dict) --* 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. * **WorkflowId** *(string) --* **[REQUIRED]** A unique identifier for the workflow. * **ExecutionRole** *(string) --* **[REQUIRED]** 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 * **StructuredLogDestinations** (*list*) -- 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" * *(string) --* * **S3StorageOptions** (*dict*) -- Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. By default, home directory mappings have a "TYPE" of "DIRECTORY". If you enable this option, you would then need to explicitly set the "HomeDirectoryMapEntry" "Type" to "FILE" if you want a mapping to have a file target. * **DirectoryListingOptimization** *(string) --* Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. By default, home directory mappings have a "TYPE" of "DIRECTORY". If you enable this option, you would then need to explicitly set the "HomeDirectoryMapEntry" "Type" to "FILE" if you want a mapping to have a file target. * **IpAddressType** (*string*) -- Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is "IPV4". Warning: The "IpAddressType" parameter has the following limitations: * It cannot be changed while the server is online. You must stop the server before modifying this parameter. * It cannot be updated to "DUALSTACK" if the server has "AddressAllocationIds" specified. Note: When using "DUALSTACK" as the "IpAddressType", you cannot set the "AddressAllocationIds" parameter for the EndpointDetails for the server. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string' } **Response Structure** * *(dict) --* * **ServerId** *(string) --* A system-assigned unique identifier for a server that the Transfer Family user is assigned to. **Exceptions** * "Transfer.Client.exceptions.ConflictException" * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.ResourceExistsException" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / list_accesses list_accesses ************* Transfer.Client.list_accesses(**kwargs) Lists the details for all the accesses you have on your server. See also: AWS API Documentation **Request Syntax** response = client.list_accesses( MaxResults=123, NextToken='string', ServerId='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return. * **NextToken** (*string*) -- 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. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server that has users assigned to it. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ServerId': 'string', 'Accesses': [ { 'HomeDirectory': 'string', 'HomeDirectoryType': 'PATH'|'LOGICAL', 'Role': 'string', 'ExternalId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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. * **ServerId** *(string) --* A system-assigned unique identifier for a server that has users assigned to it. * **Accesses** *(list) --* Returns the accesses and their properties for the "ServerId" value that you specify. * *(dict) --* Lists the properties for one or more specified associated accesses. * **HomeDirectory** *(string) --* 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** *(string) --* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **Role** *(string) --* 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. * **ExternalId** *(string) --* 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: =,.@:/- **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException" Transfer / Client / create_user create_user *********** Transfer.Client.create_user(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_user( HomeDirectory='string', HomeDirectoryType='PATH'|'LOGICAL', HomeDirectoryMappings=[ { 'Entry': 'string', 'Target': 'string', 'Type': 'FILE'|'DIRECTORY' }, ], Policy='string', PosixProfile={ 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] }, Role='string', ServerId='string', SshPublicKeyBody='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], UserName='string' ) Parameters: * **HomeDirectory** (*string*) -- 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** (*string*) -- The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **HomeDirectoryMappings** (*list*) -- 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 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" } ]" * *(dict) --* 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" } ]" * **Entry** *(string) --* **[REQUIRED]** Represents an entry for "HomeDirectoryMappings". * **Target** *(string) --* **[REQUIRED]** Represents the map target that is used in a "HomeDirectoryMapEntry". * **Type** *(string) --* Specifies the type of mapping. Set the type to "FILE" if you want the mapping to point to a file, or "DIRECTORY" for the directory to point to a directory. Note: By default, home directory mappings have a "Type" of "DIRECTORY" when you create a Transfer Family server. You would need to explicitly set "Type" to "FILE" if you want a mapping to have a file target. * **Policy** (*string*) -- 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}". Note: 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 *Amazon Web Services Security Token Service API Reference*. * **PosixProfile** (*dict*) -- 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. * **Uid** *(integer) --* **[REQUIRED]** The POSIX user ID used for all EFS operations by this user. * **Gid** *(integer) --* **[REQUIRED]** The POSIX group ID used for all EFS operations by this user. * **SecondaryGids** *(list) --* The secondary POSIX group IDs used for all EFS operations by this user. * *(integer) --* * **Role** (*string*) -- **[REQUIRED]** 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. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server instance. This is the specific server that you added your user to. * **SshPublicKeyBody** (*string*) -- The public portion of the Secure Shell (SSH) key used to authenticate the user to the server. The three standard SSH public key format elements are "", "", and an optional "", 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. * **Tags** (*list*) -- Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. * *(dict) --* 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. * **Key** *(string) --* **[REQUIRED]** The name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name you create. * **UserName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'UserName': 'string' } **Response Structure** * *(dict) --* * **ServerId** *(string) --* The identifier of the server that the user is attached to. * **UserName** *(string) --* A unique string that identifies a Transfer Family user. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.ResourceExistsException" Transfer / Client / describe_profile describe_profile **************** Transfer.Client.describe_profile(**kwargs) Returns the details of the profile that's specified by the "ProfileId". See also: AWS API Documentation **Request Syntax** response = client.describe_profile( ProfileId='string' ) Parameters: **ProfileId** (*string*) -- **[REQUIRED]** The identifier of the profile that you want described. Return type: dict Returns: **Response Syntax** { 'Profile': { 'Arn': 'string', 'ProfileId': 'string', 'ProfileType': 'LOCAL'|'PARTNER', 'As2Id': 'string', 'CertificateIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **Profile** *(dict) --* The details of the specified profile, returned as an object. * **Arn** *(string) --* The unique Amazon Resource Name (ARN) for the profile. * **ProfileId** *(string) --* A unique identifier for the local or partner AS2 profile. * **ProfileType** *(string) --* 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. * **As2Id** *(string) --* 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. * **CertificateIds** *(list) --* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. * *(string) --* * **Tags** *(list) --* Key-value pairs that can be used to group and search for profiles. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / list_certificates list_certificates ***************** Transfer.Client.list_certificates(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_certificates( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Certificates': [ { 'Arn': 'string', 'CertificateId': 'string', 'Usage': 'SIGNING'|'ENCRYPTION'|'TLS', 'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE', 'ActiveDate': datetime(2015, 1, 1), 'InactiveDate': datetime(2015, 1, 1), 'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* Returns the next token, which you can use to list the next certificate. * **Certificates** *(list) --* Returns an array of the certificates that are specified in the "ListCertificates" call. * *(dict) --* Describes the properties of a certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified certificate. * **CertificateId** *(string) --* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. * **Usage** *(string) --* Specifies how this certificate is used. It can be used in the following ways: * "SIGNING": For signing AS2 messages * "ENCRYPTION": For encrypting AS2 messages * "TLS": For securing AS2 communications sent over HTTPS * **Status** *(string) --* The certificate can be either "ACTIVE", "PENDING_ROTATION", or "INACTIVE". "PENDING_ROTATION" means that this certificate will replace the current certificate when it expires. * **ActiveDate** *(datetime) --* An optional date that specifies when the certificate becomes active. If you do not specify a value, "ActiveDate" takes the same value as "NotBeforeDate", which is specified by the CA. * **InactiveDate** *(datetime) --* An optional date that specifies when the certificate becomes inactive. If you do not specify a value, "InactiveDate" takes the same value as "NotAfterDate", which is specified by the CA. * **Type** *(string) --* 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". * **Description** *(string) --* The name or short description that's used to identify the certificate. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException" Transfer / Client / describe_web_app_customization describe_web_app_customization ****************************** Transfer.Client.describe_web_app_customization(**kwargs) Describes the web app customization object that's identified by "WebAppId". See also: AWS API Documentation **Request Syntax** response = client.describe_web_app_customization( WebAppId='string' ) Parameters: **WebAppId** (*string*) -- **[REQUIRED]** Provide the unique identifier for the web app. Return type: dict Returns: **Response Syntax** { 'WebAppCustomization': { 'Arn': 'string', 'WebAppId': 'string', 'Title': 'string', 'LogoFile': b'bytes', 'FaviconFile': b'bytes' } } **Response Structure** * *(dict) --* * **WebAppCustomization** *(dict) --* Returns a structure that contains the details of the web app customizations. * **Arn** *(string) --* Returns the Amazon Resource Name (ARN) for the web app. * **WebAppId** *(string) --* Returns the unique identifier for your web app. * **Title** *(string) --* Returns the page title that you defined for your web app. * **LogoFile** *(bytes) --* Returns a logo file data string (in base64 encoding). * **FaviconFile** *(bytes) --* Returns an icon file data string (in base64 encoding). **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / start_file_transfer start_file_transfer ******************* Transfer.Client.start_file_transfer(**kwargs) 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 Amazon Web Services storage, you specify one or more "RetrieveFilePaths" 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. See also: AWS API Documentation **Request Syntax** response = client.start_file_transfer( ConnectorId='string', SendFilePaths=[ 'string', ], RetrieveFilePaths=[ 'string', ], LocalDirectoryPath='string', RemoteDirectoryPath='string' ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. * **SendFilePaths** (*list*) -- One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, >>``<>``<<. Note: Replace "amzn-s3-demo-bucket" with one of your actual buckets. * *(string) --* * **RetrieveFilePaths** (*list*) -- One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer. * *(string) --* * **LocalDirectoryPath** (*string*) -- For an inbound transfer, the "LocaDirectoryPath" specifies the destination for one or more files that are transferred from the partner's SFTP server. * **RemoteDirectoryPath** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'TransferId': 'string' } **Response Structure** * *(dict) --* * **TransferId** *(string) --* Returns the unique identifier for the file transfer. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / create_access create_access ************* Transfer.Client.create_access(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_access( HomeDirectory='string', HomeDirectoryType='PATH'|'LOGICAL', HomeDirectoryMappings=[ { 'Entry': 'string', 'Target': 'string', 'Type': 'FILE'|'DIRECTORY' }, ], Policy='string', PosixProfile={ 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] }, Role='string', ServerId='string', ExternalId='string' ) Parameters: * **HomeDirectory** (*string*) -- 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** (*string*) -- The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **HomeDirectoryMappings** (*list*) -- 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" } ]" * *(dict) --* 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" } ]" * **Entry** *(string) --* **[REQUIRED]** Represents an entry for "HomeDirectoryMappings". * **Target** *(string) --* **[REQUIRED]** Represents the map target that is used in a "HomeDirectoryMapEntry". * **Type** *(string) --* Specifies the type of mapping. Set the type to "FILE" if you want the mapping to point to a file, or "DIRECTORY" for the directory to point to a directory. Note: By default, home directory mappings have a "Type" of "DIRECTORY" when you create a Transfer Family server. You would need to explicitly set "Type" to "FILE" if you want a mapping to have a file target. * **Policy** (*string*) -- 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}". Note: 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*. * **PosixProfile** (*dict*) -- 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. * **Uid** *(integer) --* **[REQUIRED]** The POSIX user ID used for all EFS operations by this user. * **Gid** *(integer) --* **[REQUIRED]** The POSIX group ID used for all EFS operations by this user. * **SecondaryGids** *(list) --* The secondary POSIX group IDs used for all EFS operations by this user. * *(integer) --* * **Role** (*string*) -- **[REQUIRED]** 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. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server instance. This is the specific server that you added your user to. * **ExternalId** (*string*) -- **[REQUIRED]** 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: =,.@:/- Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'ExternalId': 'string' } **Response Structure** * *(dict) --* * **ServerId** *(string) --* The identifier of the server that the user is attached to. * **ExternalId** *(string) --* 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. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.ResourceExistsException" Transfer / Client / delete_agreement delete_agreement **************** Transfer.Client.delete_agreement(**kwargs) Delete the agreement that's specified in the provided "AgreementId". See also: AWS API Documentation **Request Syntax** response = client.delete_agreement( AgreementId='string', ServerId='string' ) Parameters: * **AgreementId** (*string*) -- **[REQUIRED]** A unique identifier for the agreement. This identifier is returned when you create an agreement. * **ServerId** (*string*) -- **[REQUIRED]** The server identifier associated with the agreement that you are deleting. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / list_tags_for_resource list_tags_for_resource ********************** Transfer.Client.list_tags_for_resource(**kwargs) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( Arn='string', MaxResults=123, NextToken='string' ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** 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. * **MaxResults** (*integer*) -- Specifies the number of tags to return as a response to the "ListTagsForResource" request. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'NextToken': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN you specified to list the tags of. * **NextToken** *(string) --* 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. * **Tags** *(list) --* 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. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. **Exceptions** * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException" Transfer / Client / delete_access delete_access ************* Transfer.Client.delete_access(**kwargs) Allows you to delete the access specified in the "ServerID" and "ExternalID" parameters. See also: AWS API Documentation **Request Syntax** response = client.delete_access( ServerId='string', ExternalId='string' ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server that has this user assigned. * **ExternalId** (*string*) -- **[REQUIRED]** 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: =,.@:/- Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / describe_host_key describe_host_key ***************** Transfer.Client.describe_host_key(**kwargs) Returns the details of the host key that's specified by the "HostKeyId" and "ServerId". See also: AWS API Documentation **Request Syntax** response = client.describe_host_key( ServerId='string', HostKeyId='string' ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** The identifier of the server that contains the host key that you want described. * **HostKeyId** (*string*) -- **[REQUIRED]** The identifier of the host key that you want described. Return type: dict Returns: **Response Syntax** { 'HostKey': { 'Arn': 'string', 'HostKeyId': 'string', 'HostKeyFingerprint': 'string', 'Description': 'string', 'Type': 'string', 'DateImported': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **HostKey** *(dict) --* Returns the details for the specified host key. * **Arn** *(string) --* The unique Amazon Resource Name (ARN) for the host key. * **HostKeyId** *(string) --* A unique identifier for the host key. * **HostKeyFingerprint** *(string) --* The public key fingerprint, which is a short sequence of bytes used to identify the longer public key. * **Description** *(string) --* The text description for this host key. * **Type** *(string) --* 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" * **DateImported** *(datetime) --* The date on which the host key was added to the server. * **Tags** *(list) --* Key-value pairs that can be used to group and search for host keys. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / untag_resource untag_resource ************** Transfer.Client.untag_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( Arn='string', TagKeys=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** 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. * **TagKeys** (*list*) -- **[REQUIRED]** 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. * *(string) --* Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / update_host_key update_host_key *************** Transfer.Client.update_host_key(**kwargs) Updates the description for the host key that's specified by the "ServerId" and "HostKeyId" parameters. See also: AWS API Documentation **Request Syntax** response = client.update_host_key( ServerId='string', HostKeyId='string', Description='string' ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** The identifier of the server that contains the host key that you are updating. * **HostKeyId** (*string*) -- **[REQUIRED]** The identifier of the host key that you are updating. * **Description** (*string*) -- **[REQUIRED]** An updated description for the host key. Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'HostKeyId': 'string' } **Response Structure** * *(dict) --* * **ServerId** *(string) --* Returns the server identifier for the server that contains the updated host key. * **HostKeyId** *(string) --* Returns the host key identifier for the updated host key. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / list_host_keys list_host_keys ************** Transfer.Client.list_host_keys(**kwargs) Returns a list of host keys for the server that's specified by the "ServerId" parameter. See also: AWS API Documentation **Request Syntax** response = client.list_host_keys( MaxResults=123, NextToken='string', ServerId='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return. * **NextToken** (*string*) -- 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. * **ServerId** (*string*) -- **[REQUIRED]** The identifier of the server that contains the host keys that you want to view. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ServerId': 'string', 'HostKeys': [ { 'Arn': 'string', 'HostKeyId': 'string', 'Fingerprint': 'string', 'Description': 'string', 'Type': 'string', 'DateImported': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* Returns a token that you can use to call "ListHostKeys" again and receive additional results, if there are any. * **ServerId** *(string) --* Returns the server identifier that contains the listed host keys. * **HostKeys** *(list) --* Returns an array, where each item contains the details of a host key. * *(dict) --* Returns properties of the host key that's specified. * **Arn** *(string) --* The unique Amazon Resource Name (ARN) of the host key. * **HostKeyId** *(string) --* A unique identifier for the host key. * **Fingerprint** *(string) --* The public key fingerprint, which is a short sequence of bytes used to identify the longer public key. * **Description** *(string) --* The current description for the host key. You can change it by calling the "UpdateHostKey" operation and providing a new description. * **Type** *(string) --* 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" * **DateImported** *(datetime) --* The date on which the host key was added to the server. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException" Transfer / Client / start_directory_listing start_directory_listing *********************** Transfer.Client.start_directory_listing(**kwargs) Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional "MaxItems" value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep. After you receive the listing file, you can provide the files that you want to transfer to the "RetrieveFilePaths" parameter of the "StartFileTransfer" API call. The naming convention for the output file is "connector-ID-listing- ID.json". The output file contains the following information: * "filePath": the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server. * "modifiedTimestamp": the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing. * "size": the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing. * "path": the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server. * "truncated": a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your "Truncated" output value is true, you can increase the value provided in the optional "max-items" input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items). See also: AWS API Documentation **Request Syntax** response = client.start_directory_listing( ConnectorId='string', RemoteDirectoryPath='string', MaxItems=123, OutputDirectoryPath='string' ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. * **RemoteDirectoryPath** (*string*) -- **[REQUIRED]** Specifies the directory on the remote SFTP server for which you want to list its contents. * **MaxItems** (*integer*) -- An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000. * **OutputDirectoryPath** (*string*) -- **[REQUIRED]** Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing. Return type: dict Returns: **Response Syntax** { 'ListingId': 'string', 'OutputFileName': 'string' } **Response Structure** * *(dict) --* * **ListingId** *(string) --* Returns a unique identifier for the directory listing call. * **OutputFileName** *(string) --* Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: "-.json". **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / update_web_app update_web_app ************** Transfer.Client.update_web_app(**kwargs) Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units. See also: AWS API Documentation **Request Syntax** response = client.update_web_app( WebAppId='string', IdentityProviderDetails={ 'IdentityCenterConfig': { 'Role': 'string' } }, AccessEndpoint='string', WebAppUnits={ 'Provisioned': 123 } ) Parameters: * **WebAppId** (*string*) -- **[REQUIRED]** Provide the identifier of the web app that you are updating. * **IdentityProviderDetails** (*dict*) -- Provide updated identity provider values in a "WebAppIdentityProviderDetails" object. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "IdentityCenterConfig". * **IdentityCenterConfig** *(dict) --* A structure that describes the values to use for the IAM Identity Center settings when you update a web app. * **Role** *(string) --* The IAM role used to access IAM Identity Center. * **AccessEndpoint** (*string*) -- The "AccessEndpoint" is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. * **WebAppUnits** (*dict*) -- A union that contains the value for number of concurrent connections or the user sessions on your web app. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Provisioned". * **Provisioned** *(integer) --* An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time. Each increment allows an additional 250 concurrent sessions: a value of "1" sets the number of concurrent sessions to 250; "2" sets a value of 500, and so on. Return type: dict Returns: **Response Syntax** { 'WebAppId': 'string' } **Response Structure** * *(dict) --* * **WebAppId** *(string) --* Returns the unique identifier for the web app being updated. **Exceptions** * "Transfer.Client.exceptions.ConflictException" * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / update_access update_access ************* Transfer.Client.update_access(**kwargs) Allows you to update parameters for the access specified in the "ServerID" and "ExternalID" parameters. See also: AWS API Documentation **Request Syntax** response = client.update_access( HomeDirectory='string', HomeDirectoryType='PATH'|'LOGICAL', HomeDirectoryMappings=[ { 'Entry': 'string', 'Target': 'string', 'Type': 'FILE'|'DIRECTORY' }, ], Policy='string', PosixProfile={ 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] }, Role='string', ServerId='string', ExternalId='string' ) Parameters: * **HomeDirectory** (*string*) -- 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". Note: You can use the "HomeDirectory" parameter for "HomeDirectoryType" when it is set to either "PATH" or "LOGICAL". * **HomeDirectoryType** (*string*) -- The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to "PATH", the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to "LOGICAL", you need to provide mappings in the "HomeDirectoryMappings" for how you want to make Amazon S3 or Amazon EFS paths visible to your users. Note: If "HomeDirectoryType" is "LOGICAL", you must provide mappings, using the "HomeDirectoryMappings" parameter. If, on the other hand, "HomeDirectoryType" is "PATH", you provide an absolute path using the "HomeDirectory" parameter. You cannot have both "HomeDirectory" and "HomeDirectoryMappings" in your template. * **HomeDirectoryMappings** (*list*) -- 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" } ]" * *(dict) --* 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" } ]" * **Entry** *(string) --* **[REQUIRED]** Represents an entry for "HomeDirectoryMappings". * **Target** *(string) --* **[REQUIRED]** Represents the map target that is used in a "HomeDirectoryMapEntry". * **Type** *(string) --* Specifies the type of mapping. Set the type to "FILE" if you want the mapping to point to a file, or "DIRECTORY" for the directory to point to a directory. Note: By default, home directory mappings have a "Type" of "DIRECTORY" when you create a Transfer Family server. You would need to explicitly set "Type" to "FILE" if you want a mapping to have a file target. * **Policy** (*string*) -- 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}". Note: 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 *Amazon Web ServicesSecurity Token Service API Reference*. * **PosixProfile** (*dict*) -- 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. * **Uid** *(integer) --* **[REQUIRED]** The POSIX user ID used for all EFS operations by this user. * **Gid** *(integer) --* **[REQUIRED]** The POSIX group ID used for all EFS operations by this user. * **SecondaryGids** *(list) --* The secondary POSIX group IDs used for all EFS operations by this user. * *(integer) --* * **Role** (*string*) -- 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. * **ServerId** (*string*) -- **[REQUIRED]** A system-assigned unique identifier for a server instance. This is the specific server that you added your user to. * **ExternalId** (*string*) -- **[REQUIRED]** 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: =,.@:/- Return type: dict Returns: **Response Syntax** { 'ServerId': 'string', 'ExternalId': 'string' } **Response Structure** * *(dict) --* * **ServerId** *(string) --* The identifier of the server that the user is attached to. * **ExternalId** *(string) --* 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. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.ResourceExistsException" Transfer / Client / get_waiter get_waiter ********** Transfer.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Transfer / Client / list_executions list_executions *************** Transfer.Client.list_executions(**kwargs) Lists all in-progress executions for the specified workflow. Note: If the specified workflow ID cannot be found, "ListExecutions" returns a "ResourceNotFound" exception. See also: AWS API Documentation **Request Syntax** response = client.list_executions( MaxResults=123, NextToken='string', WorkflowId='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return. * **NextToken** (*string*) -- "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. * **WorkflowId** (*string*) -- **[REQUIRED]** A unique identifier for the workflow. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'WorkflowId': 'string', 'Executions': [ { 'ExecutionId': 'string', 'InitialFileLocation': { 'S3FileLocation': { 'Bucket': 'string', 'Key': 'string', 'VersionId': 'string', 'Etag': 'string' }, 'EfsFileLocation': { 'FileSystemId': 'string', 'Path': 'string' } }, 'ServiceMetadata': { 'UserDetails': { 'UserName': 'string', 'ServerId': 'string', 'SessionId': 'string' } }, 'Status': 'IN_PROGRESS'|'COMPLETED'|'EXCEPTION'|'HANDLING_EXCEPTION' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* "ListExecutions" returns the "NextToken" parameter in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional executions. * **WorkflowId** *(string) --* A unique identifier for the workflow. * **Executions** *(list) --* Returns the details for each execution, in a "ListedExecution" array. * *(dict) --* Returns properties of the execution that is specified. * **ExecutionId** *(string) --* A unique identifier for the execution of a workflow. * **InitialFileLocation** *(dict) --* 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. * **S3FileLocation** *(dict) --* Specifies the S3 details for the file being used, such as bucket, ETag, and so forth. * **Bucket** *(string) --* Specifies the S3 bucket that contains the file being used. * **Key** *(string) --* The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object. * **VersionId** *(string) --* Specifies the file version. * **Etag** *(string) --* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. * **EfsFileLocation** *(dict) --* Specifies the Amazon EFS identifier and the path for the file being used. * **FileSystemId** *(string) --* The identifier of the file system, assigned by Amazon EFS. * **Path** *(string) --* The pathname for the folder being used by a workflow. * **ServiceMetadata** *(dict) --* A container object for the session details that are associated with a workflow. * **UserDetails** *(dict) --* The Server ID ( "ServerId"), Session ID ( "SessionId") and user ( "UserName") make up the "UserDetails". * **UserName** *(string) --* A unique string that identifies a Transfer Family user associated with a server. * **ServerId** *(string) --* The system-assigned unique identifier for a Transfer server instance. * **SessionId** *(string) --* The system-assigned unique identifier for a session that corresponds to the workflow. * **Status** *(string) --* The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException" Transfer / Client / update_connector update_connector **************** Transfer.Client.update_connector(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_connector( ConnectorId='string', Url='string', As2Config={ 'LocalProfileId': 'string', 'PartnerProfileId': 'string', 'MessageSubject': 'string', 'Compression': 'ZLIB'|'DISABLED', 'EncryptionAlgorithm': 'AES128_CBC'|'AES192_CBC'|'AES256_CBC'|'DES_EDE3_CBC'|'NONE', 'SigningAlgorithm': 'SHA256'|'SHA384'|'SHA512'|'SHA1'|'NONE', 'MdnSigningAlgorithm': 'SHA256'|'SHA384'|'SHA512'|'SHA1'|'NONE'|'DEFAULT', 'MdnResponse': 'SYNC'|'NONE', 'BasicAuthSecretId': 'string', 'PreserveContentType': 'ENABLED'|'DISABLED' }, AccessRole='string', LoggingRole='string', SftpConfig={ 'UserSecretId': 'string', 'TrustedHostKeys': [ 'string', ], 'MaxConcurrentConnections': 123 }, SecurityPolicyName='string' ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. * **Url** (*string*) -- The URL of the partner's AS2 or SFTP endpoint. * **As2Config** (*dict*) -- A structure that contains the parameters for an AS2 connector object. * **LocalProfileId** *(string) --* A unique identifier for the AS2 local profile. * **PartnerProfileId** *(string) --* A unique identifier for the partner profile for the connector. * **MessageSubject** *(string) --* Used as the "Subject" HTTP header attribute in AS2 messages that are being sent with the connector. * **Compression** *(string) --* Specifies whether the AS2 file is compressed. * **EncryptionAlgorithm** *(string) --* The algorithm that is used to encrypt the file. Note the following: * Do not use the "DES_EDE3_CBC" algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm. * You can only specify "NONE" if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text. * **SigningAlgorithm** *(string) --* The algorithm that is used to sign the AS2 messages sent with the connector. * **MdnSigningAlgorithm** *(string) --* The signing algorithm for the MDN response. Note: If set to DEFAULT (or not set at all), the value for "SigningAlgorithm" is used. * **MdnResponse** *(string) --* Used for outbound requests (from an Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values: * "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. * **BasicAuthSecretId** *(string) --* 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=""'" * **PreserveContentType** *(string) --* Allows you to use the Amazon S3 "Content-Type" that is associated with objects in S3 instead of having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly. * **AccessRole** (*string*) -- Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use. **For AS2 connectors** With AS2, you can send files by calling "StartFileTransfer" and specifying the file paths in the request parameter, "SendFilePaths". We use the file’s parent directory (for example, for "--send-file-paths /bucket/dir/file.txt", parent directory is "/bucket/dir/") to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the "AccessRole" needs to provide read and write access to the parent directory of the file location used in the "StartFileTransfer" request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with "StartFileTransfer". If you are using Basic authentication for your AS2 connector, the access role requires the "secretsmanager:GetSecretValue" permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the "kms:Decrypt" permission for that key. **For SFTP connectors** Make sure that the access role provides read and write access to the parent directory of the file location that's used in the "StartFileTransfer" request. Additionally, make sure that the role provides "secretsmanager:GetSecretValue" permission to Secrets Manager. * **LoggingRole** (*string*) -- 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. * **SftpConfig** (*dict*) -- A structure that contains the parameters for an SFTP connector object. * **UserSecretId** *(string) --* The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret. Note: * Required when creating an SFTP connector * Optional when updating an existing SFTP connector * **TrustedHostKeys** *(list) --* The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the "ssh-keyscan" command against the SFTP server to retrieve the necessary key. Note: "TrustedHostKeys" is optional for "CreateConnector". If not provided, you can use "TestConnection" to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key. The three standard SSH public key format elements are "", "", and an optional "", with spaces between each element. Specify only the "" and "": do not enter the "" portion of the key. For the trusted host key, Transfer Family accepts RSA and ECDSA keys. * For RSA keys, the "" string is "ssh-rsa". * For ECDSA keys, the "" string is either "ecdsa- sha2-nistp256", "ecdsa-sha2-nistp384", or "ecdsa- sha2-nistp521", depending on the size of the key you generated. Run this command to retrieve the SFTP server host key, where your SFTP server name is "ftp.host.com". "ssh-keyscan ftp.host.com" This prints the public host key to standard output. "ftp.host.com ssh-rsa AAAAB3Nza...", "", and an optional "", with spaces between each element. Specify only the "" and "": do not enter the "" portion of the key. For the trusted host key, Transfer Family accepts RSA and ECDSA keys. * For RSA keys, the "" string is "ssh-rsa". * For ECDSA keys, the "" string is either "ecdsa- sha2-nistp256", "ecdsa-sha2-nistp384", or "ecdsa- sha2-nistp521", depending on the size of the key you generated. Run this command to retrieve the SFTP server host key, where your SFTP server name is "ftp.host.com". "ssh-keyscan ftp.host.com" This prints the public host key to standard output. "ftp.host.com ssh-rsa AAAAB3Nza...>``<>``<<. * **AccessRole** (*string*) -- Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use. **For AS2 connectors** With AS2, you can send files by calling "StartFileTransfer" and specifying the file paths in the request parameter, "SendFilePaths". We use the file’s parent directory (for example, for "--send-file-paths /bucket/dir/file.txt", parent directory is "/bucket/dir/") to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the "AccessRole" needs to provide read and write access to the parent directory of the file location used in the "StartFileTransfer" request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with "StartFileTransfer". If you are using Basic authentication for your AS2 connector, the access role requires the "secretsmanager:GetSecretValue" permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the "kms:Decrypt" permission for that key. **For SFTP connectors** Make sure that the access role provides read and write access to the parent directory of the file location that's used in the "StartFileTransfer" request. Additionally, make sure that the role provides "secretsmanager:GetSecretValue" permission to Secrets Manager. * **PreserveFilename** (*string*) -- Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it. * "ENABLED": the filename provided by your trading parter is preserved when the file is saved. * "DISABLED" (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations. * **EnforceMessageSigning** (*string*) -- Determines whether or not unsigned messages from your trading partners will be accepted. * "ENABLED": Transfer Family rejects unsigned messages from your trading partner. * "DISABLED" (default value): Transfer Family accepts unsigned messages from your trading partner. * **CustomDirectories** (*dict*) -- A "CustomDirectoriesType" structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files. * Failed files * MDN files * Payload files * Status files * Temporary files * **FailedFilesDirectory** *(string) --* **[REQUIRED]** Specifies a location to store failed AS2 message files. * **MdnFilesDirectory** *(string) --* **[REQUIRED]** Specifies a location to store MDN files. * **PayloadFilesDirectory** *(string) --* **[REQUIRED]** Specifies a location to store the payload for AS2 message files. * **StatusFilesDirectory** *(string) --* **[REQUIRED]** Specifies a location to store AS2 status messages. * **TemporaryFilesDirectory** *(string) --* **[REQUIRED]** Specifies a location to store temporary AS2 message files. Return type: dict Returns: **Response Syntax** { 'AgreementId': 'string' } **Response Structure** * *(dict) --* * **AgreementId** *(string) --* A unique identifier for the agreement. This identifier is returned when you create an agreement. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.ResourceExistsException" Transfer / Client / import_certificate import_certificate ****************** Transfer.Client.import_certificate(**kwargs) Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. You can import both the certificate and its chain in the "Certificate" parameter. Note: If you use the "Certificate" parameter to upload both the certificate and its chain, don't use the "CertificateChain" parameter. See also: AWS API Documentation **Request Syntax** response = client.import_certificate( Usage='SIGNING'|'ENCRYPTION'|'TLS', Certificate='string', CertificateChain='string', PrivateKey='string', ActiveDate=datetime(2015, 1, 1), InactiveDate=datetime(2015, 1, 1), Description='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Usage** (*string*) -- **[REQUIRED]** Specifies how this certificate is used. It can be used in the following ways: * "SIGNING": For signing AS2 messages * "ENCRYPTION": For encrypting AS2 messages * "TLS": For securing AS2 communications sent over HTTPS * **Certificate** (*string*) -- **[REQUIRED]** * 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`"". Note: You can provide both the certificate and its chain in this parameter, without needing to use the "CertificateChain" parameter. If you use this parameter for both the certificate and its chain, do not use the "CertificateChain" parameter. * **CertificateChain** (*string*) -- An optional list of certificates that make up the chain for the certificate that's being imported. * **PrivateKey** (*string*) -- * 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`"" * **ActiveDate** (*datetime*) -- An optional date that specifies when the certificate becomes active. If you do not specify a value, "ActiveDate" takes the same value as "NotBeforeDate", which is specified by the CA. * **InactiveDate** (*datetime*) -- An optional date that specifies when the certificate becomes inactive. If you do not specify a value, "InactiveDate" takes the same value as "NotAfterDate", which is specified by the CA. * **Description** (*string*) -- A short description that helps identify the certificate. * **Tags** (*list*) -- Key-value pairs that can be used to group and search for certificates. * *(dict) --* 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. * **Key** *(string) --* **[REQUIRED]** The name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name you create. Return type: dict Returns: **Response Syntax** { 'CertificateId': 'string' } **Response Structure** * *(dict) --* * **CertificateId** *(string) --* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / list_file_transfer_results list_file_transfer_results ************************** Transfer.Client.list_file_transfer_results(**kwargs) Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its "ConnectorId" and its "TransferId". Note: File transfer results are available up to 7 days after an operation has been requested. See also: AWS API Documentation **Request Syntax** response = client.list_file_transfer_results( ConnectorId='string', TransferId='string', NextToken='string', MaxResults=123 ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** A unique identifier for a connector. This value should match the value supplied to the corresponding "StartFileTransfer" call. * **TransferId** (*string*) -- **[REQUIRED]** A unique identifier for a file transfer. This value should match the value supplied to the corresponding "StartFileTransfer" call. * **NextToken** (*string*) -- If there are more file details than returned in this call, use this value for a subsequent call to "ListFileTransferResults" to retrieve them. * **MaxResults** (*integer*) -- The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single StartFileTransfer operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10. Return type: dict Returns: **Response Syntax** { 'FileTransferResults': [ { 'FilePath': 'string', 'StatusCode': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'FAILED', 'FailureCode': 'string', 'FailureMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FileTransferResults** *(list) --* Returns the details for the files transferred in the transfer identified by the "TransferId" and "ConnectorId" specified. * "FilePath": the filename and path to where the file was sent to or retrieved from. * "StatusCode": current status for the transfer. The status returned is one of the following values: "QUEUED", "IN_PROGRESS", "COMPLETED", or "FAILED" * "FailureCode": for transfers that fail, this parameter contains a code indicating the reason. For example, "RETRIEVE_FILE_NOT_FOUND" * "FailureMessage": for transfers that fail, this parameter describes the reason for the failure. * *(dict) --* A structure that contains the details for files transferred using an SFTP connector, during a single transfer. * **FilePath** *(string) --* The filename and path to where the file was sent to or retrieved from. * **StatusCode** *(string) --* The current status for the transfer. * **FailureCode** *(string) --* For transfers that fail, this parameter contains a code indicating the reason. For example, "RETRIEVE_FILE_NOT_FOUND" * **FailureMessage** *(string) --* For transfers that fail, this parameter describes the reason for the failure. * **NextToken** *(string) --* Returns a token that you can use to call "ListFileTransferResults" again and receive additional results, if there are any (against the same "TransferId". **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / delete_certificate delete_certificate ****************** Transfer.Client.delete_certificate(**kwargs) Deletes the certificate that's specified in the "CertificateId" parameter. See also: AWS API Documentation **Request Syntax** response = client.delete_certificate( CertificateId='string' ) Parameters: **CertificateId** (*string*) -- **[REQUIRED]** The identifier of the certificate object that you are deleting. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / delete_host_key delete_host_key *************** Transfer.Client.delete_host_key(**kwargs) Deletes the host key that's specified in the "HostKeyId" parameter. See also: AWS API Documentation **Request Syntax** response = client.delete_host_key( ServerId='string', HostKeyId='string' ) Parameters: * **ServerId** (*string*) -- **[REQUIRED]** The identifier of the server that contains the host key that you are deleting. * **HostKeyId** (*string*) -- **[REQUIRED]** The identifier of the host key that you are deleting. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / tag_resource tag_resource ************ Transfer.Client.tag_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( Arn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role. * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* 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. * **Key** *(string) --* **[REQUIRED]** The name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name you create. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / start_remote_move start_remote_move ***************** Transfer.Client.start_remote_move(**kwargs) Moves or renames a file or directory on the remote SFTP server. See also: AWS API Documentation **Request Syntax** response = client.start_remote_move( ConnectorId='string', SourcePath='string', TargetPath='string' ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. * **SourcePath** (*string*) -- **[REQUIRED]** The absolute path of the file or directory to move or rename. You can only specify one path per call to this operation. * **TargetPath** (*string*) -- **[REQUIRED]** The absolute path for the target of the move/rename operation. Return type: dict Returns: **Response Syntax** { 'MoveId': 'string' } **Response Structure** * *(dict) --* * **MoveId** *(string) --* Returns a unique identifier for the move/rename operation. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / delete_connector delete_connector **************** Transfer.Client.delete_connector(**kwargs) Deletes the connector that's specified in the provided "ConnectorId". See also: AWS API Documentation **Request Syntax** response = client.delete_connector( ConnectorId='string' ) Parameters: **ConnectorId** (*string*) -- **[REQUIRED]** The unique identifier for the connector. Returns: None **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / describe_web_app describe_web_app **************** Transfer.Client.describe_web_app(**kwargs) Describes the web app that's identified by "WebAppId". See also: AWS API Documentation **Request Syntax** response = client.describe_web_app( WebAppId='string' ) Parameters: **WebAppId** (*string*) -- **[REQUIRED]** Provide the unique identifier for the web app. Return type: dict Returns: **Response Syntax** { 'WebApp': { 'Arn': 'string', 'WebAppId': 'string', 'DescribedIdentityProviderDetails': { 'IdentityCenterConfig': { 'ApplicationArn': 'string', 'InstanceArn': 'string', 'Role': 'string' } }, 'AccessEndpoint': 'string', 'WebAppEndpoint': 'string', 'WebAppUnits': { 'Provisioned': 123 }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WebAppEndpointPolicy': 'FIPS'|'STANDARD' } } **Response Structure** * *(dict) --* * **WebApp** *(dict) --* Returns a structure that contains the details of the web app. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the web app. * **WebAppId** *(string) --* The unique identifier for the web app. * **DescribedIdentityProviderDetails** *(dict) --* A structure that contains the details for the identity provider used by the web app. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "IdentityCenterConfig". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **IdentityCenterConfig** *(dict) --* Returns a structure for your identity provider details. This structure contains the instance ARN and role being used for the web app. * **ApplicationArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app. * **InstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app. * **Role** *(string) --* The IAM role in IAM Identity Center used for the web app. * **AccessEndpoint** *(string) --* The "AccessEndpoint" is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. * **WebAppEndpoint** *(string) --* The "WebAppEndpoint" is the unique URL for your Transfer Family web app. This is the value that you use when you configure **Origins** on CloudFront. * **WebAppUnits** *(dict) --* A union that contains the value for number of concurrent connections or the user sessions on your web app. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Provisioned". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Provisioned** *(integer) --* An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time. Each increment allows an additional 250 concurrent sessions: a value of "1" sets the number of concurrent sessions to 250; "2" sets a value of 500, and so on. * **Tags** *(list) --* Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. * **WebAppEndpointPolicy** *(string) --* Setting for the type of endpoint policy for the web app. The default value is "STANDARD". If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be "FIPS", which indicates the web app endpoint is FIPS- compliant. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.ThrottlingException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.AccessDeniedException" Transfer / Client / describe_certificate describe_certificate ******************** Transfer.Client.describe_certificate(**kwargs) Describes the certificate that's identified by the "CertificateId". See also: AWS API Documentation **Request Syntax** response = client.describe_certificate( CertificateId='string' ) Parameters: **CertificateId** (*string*) -- **[REQUIRED]** An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. Return type: dict Returns: **Response Syntax** { 'Certificate': { 'Arn': 'string', 'CertificateId': 'string', 'Usage': 'SIGNING'|'ENCRYPTION'|'TLS', 'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE', 'Certificate': 'string', 'CertificateChain': 'string', 'ActiveDate': datetime(2015, 1, 1), 'InactiveDate': datetime(2015, 1, 1), 'Serial': 'string', 'NotBeforeDate': datetime(2015, 1, 1), 'NotAfterDate': datetime(2015, 1, 1), 'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **Certificate** *(dict) --* The details for the specified certificate, returned as an object. * **Arn** *(string) --* The unique Amazon Resource Name (ARN) for the certificate. * **CertificateId** *(string) --* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles. * **Usage** *(string) --* Specifies how this certificate is used. It can be used in the following ways: * "SIGNING": For signing AS2 messages * "ENCRYPTION": For encrypting AS2 messages * "TLS": For securing AS2 communications sent over HTTPS * **Status** *(string) --* A certificate's status can be either "ACTIVE" or "INACTIVE". You can set "ActiveDate" and "InactiveDate" in the "UpdateCertificate" call. If you set values for these parameters, those values are used to determine whether the certificate has a status of "ACTIVE" or "INACTIVE". If you don't set values for "ActiveDate" and "InactiveDate", we use the "NotBefore" and "NotAfter" date as specified on the X509 certificate to determine when a certificate is active and when it is inactive. * **Certificate** *(string) --* The file name for the certificate. * **CertificateChain** *(string) --* The list of certificates that make up the chain for the certificate. * **ActiveDate** *(datetime) --* An optional date that specifies when the certificate becomes active. If you do not specify a value, "ActiveDate" takes the same value as "NotBeforeDate", which is specified by the CA. * **InactiveDate** *(datetime) --* An optional date that specifies when the certificate becomes inactive. If you do not specify a value, "InactiveDate" takes the same value as "NotAfterDate", which is specified by the CA. * **Serial** *(string) --* The serial number for the certificate. * **NotBeforeDate** *(datetime) --* The earliest date that the certificate is valid. * **NotAfterDate** *(datetime) --* The final date that the certificate is valid. * **Type** *(string) --* 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". * **Description** *(string) --* The name or description that's used to identity the certificate. * **Tags** *(list) --* Key-value pairs that can be used to group and search for certificates. * *(dict) --* 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. * **Key** *(string) --* The name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name you create. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" Transfer / Client / list_connectors list_connectors *************** Transfer.Client.list_connectors(**kwargs) Lists the connectors for the specified Region. See also: AWS API Documentation **Request Syntax** response = client.list_connectors( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Connectors': [ { 'Arn': 'string', 'ConnectorId': 'string', 'Url': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* Returns a token that you can use to call "ListConnectors" again and receive additional results, if there are any. * **Connectors** *(list) --* Returns an array, where each item contains the details of a connector. * *(dict) --* Returns details of the connector that is specified. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the specified connector. * **ConnectorId** *(string) --* The unique identifier for the connector. * **Url** *(string) --* The URL of the partner's AS2 or SFTP endpoint. **Exceptions** * "Transfer.Client.exceptions.ResourceNotFoundException" * "Transfer.Client.exceptions.InvalidRequestException" * "Transfer.Client.exceptions.InternalServiceError" * "Transfer.Client.exceptions.ServiceUnavailableException" * "Transfer.Client.exceptions.InvalidNextTokenException"