2021/09/02 - AWS Transfer Family - 7 new3 updated api methods
Changes AWS Transfer Family introduces Managed Workflows for creating, executing, monitoring, and standardizing post file transfer processing
Sends a callback for asynchronous custom steps.
The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
See also: AWS API Documentation
Request Syntax
client.send_workflow_step_state(
WorkflowId='string',
ExecutionId='string',
Token='string',
Status='SUCCESS'|'FAILURE'
)
string
[REQUIRED]
A unique identifier for the workflow.
string
[REQUIRED]
A unique identifier for the execution of a workflow.
string
[REQUIRED]
Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
string
[REQUIRED]
Indicates whether the specified step succeeded or failed.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all executions for the specified workflow.
See also: AWS API Documentation
Request Syntax
client.list_executions(
MaxResults=123,
NextToken='string',
WorkflowId='string'
)
integer
Specifies the aximum number of executions to return.
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, callthe API by specifing 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, suppling 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.
string
[REQUIRED]
A unique identifier for the workflow.
dict
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.
NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
StartTime: timestamp indicating when the execution began.
Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.
(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 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 ID and the path for the file being used.
FileSystemId (string) --
The ID 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 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 user account 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.
Describes the specified workflow.
See also: AWS API Documentation
Request Syntax
client.describe_workflow(
WorkflowId='string'
)
string
[REQUIRED]
A unique identifier for the workflow.
dict
Response Syntax
{
'Workflow': {
'Arn': 'string',
'Description': 'string',
'Steps': [
{
'Type': 'COPY'|'CUSTOM'|'TAG'|'DELETE',
'CopyStepDetails': {
'Name': 'string',
'DestinationFileLocation': {
'S3FileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'EfsFileLocation': {
'FileSystemId': 'string',
'Path': 'string'
}
},
'OverwriteExisting': 'TRUE'|'FALSE'
},
'CustomStepDetails': {
'Name': 'string',
'Target': 'string',
'TimeoutSeconds': 123
},
'DeleteStepDetails': {
'Name': 'string'
},
'TagStepDetails': {
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
],
'OnExceptionSteps': [
{
'Type': 'COPY'|'CUSTOM'|'TAG'|'DELETE',
'CopyStepDetails': {
'Name': 'string',
'DestinationFileLocation': {
'S3FileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'EfsFileLocation': {
'FileSystemId': 'string',
'Path': 'string'
}
},
'OverwriteExisting': 'TRUE'|'FALSE'
},
'CustomStepDetails': {
'Name': 'string',
'Target': 'string',
'TimeoutSeconds': 123
},
'DeleteStepDetails': {
'Name': 'string'
},
'TagStepDetails': {
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
],
'WorkflowId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Workflow (dict) --
The structure that contains the details of the workflow.
Arn (string) --
Specifies the unique Amazon Resource Name (ARN) for the workflow.
Description (string) --
Specifies the text description for the workflow.
Steps (list) --
Specifies the details for the steps that are in the specified workflow.
(dict) --
The basic building block of a workflow.
Type (string) --
Currently, the following step types are supported.
Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file
CopyStepDetails (dict) --
Details for a step that performs a file copy.
Consists of the following values:
A description
An S3 or EFS location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
Name (string) --
The name of the step, used as an identifier.
DestinationFileLocation (dict) --
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
S3FileLocation (dict) --
Specifies the details for the S3 file being copied.
Bucket (string) --
Specifies the S3 bucket that contains the file being copied.
Key (string) --
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
EfsFileLocation (dict) --
Specifies the details for the Amazon EFS file being copied.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
Path (string) --
The pathname for the folder being used by a workflow.
OverwriteExisting (string) --
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
CustomStepDetails (dict) --
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
Name (string) --
The name of the step, used as an identifier.
Target (string) --
The ARN for the lambda function that is being called.
TimeoutSeconds (integer) --
Timeout, in seconds, for the step.
DeleteStepDetails (dict) --
You need to specify the name of the file to be deleted.
Name (string) --
The name of the step, used as an identifier.
TagStepDetails (dict) --
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
Name (string) --
The name of the step, used as an identifier.
Tags (list) --
Array that contains from 1 to 10 key/value pairs.
(dict) --
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
Key (string) --
The name assigned to the tag that you create.
Value (string) --
The value that corresponds to the key.
OnExceptionSteps (list) --
Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
(dict) --
The basic building block of a workflow.
Type (string) --
Currently, the following step types are supported.
Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file
CopyStepDetails (dict) --
Details for a step that performs a file copy.
Consists of the following values:
A description
An S3 or EFS location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
Name (string) --
The name of the step, used as an identifier.
DestinationFileLocation (dict) --
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
S3FileLocation (dict) --
Specifies the details for the S3 file being copied.
Bucket (string) --
Specifies the S3 bucket that contains the file being copied.
Key (string) --
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
EfsFileLocation (dict) --
Specifies the details for the Amazon EFS file being copied.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
Path (string) --
The pathname for the folder being used by a workflow.
OverwriteExisting (string) --
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
CustomStepDetails (dict) --
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
Name (string) --
The name of the step, used as an identifier.
Target (string) --
The ARN for the lambda function that is being called.
TimeoutSeconds (integer) --
Timeout, in seconds, for the step.
DeleteStepDetails (dict) --
You need to specify the name of the file to be deleted.
Name (string) --
The name of the step, used as an identifier.
TagStepDetails (dict) --
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
Name (string) --
The name of the step, used as an identifier.
Tags (list) --
Array that contains from 1 to 10 key/value pairs.
(dict) --
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
Key (string) --
The name assigned to the tag that you create.
Value (string) --
The value that corresponds to the key.
WorkflowId (string) --
A unique identifier for the workflow.
Tags (list) --
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows 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.
Deletes the specified workflow.
See also: AWS API Documentation
Request Syntax
client.delete_workflow(
WorkflowId='string'
)
string
[REQUIRED]
A unique identifier for the workflow.
None
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.
See also: AWS API Documentation
Request Syntax
client.create_workflow(
Description='string',
Steps=[
{
'Type': 'COPY'|'CUSTOM'|'TAG'|'DELETE',
'CopyStepDetails': {
'Name': 'string',
'DestinationFileLocation': {
'S3FileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'EfsFileLocation': {
'FileSystemId': 'string',
'Path': 'string'
}
},
'OverwriteExisting': 'TRUE'|'FALSE'
},
'CustomStepDetails': {
'Name': 'string',
'Target': 'string',
'TimeoutSeconds': 123
},
'DeleteStepDetails': {
'Name': 'string'
},
'TagStepDetails': {
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
],
OnExceptionSteps=[
{
'Type': 'COPY'|'CUSTOM'|'TAG'|'DELETE',
'CopyStepDetails': {
'Name': 'string',
'DestinationFileLocation': {
'S3FileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'EfsFileLocation': {
'FileSystemId': 'string',
'Path': 'string'
}
},
'OverwriteExisting': 'TRUE'|'FALSE'
},
'CustomStepDetails': {
'Name': 'string',
'Target': 'string',
'TimeoutSeconds': 123
},
'DeleteStepDetails': {
'Name': 'string'
},
'TagStepDetails': {
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
A textual description for the workflow.
list
[REQUIRED]
Specifies the details for the steps that are in the specified workflow.
The TYPE specifies which of the following actions is being taken for this step.
Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file
For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.
(dict) --
The basic building block of a workflow.
Type (string) --
Currently, the following step types are supported.
Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file
CopyStepDetails (dict) --
Details for a step that performs a file copy.
Consists of the following values:
A description
An S3 or EFS location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
Name (string) --
The name of the step, used as an identifier.
DestinationFileLocation (dict) --
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
S3FileLocation (dict) --
Specifies the details for the S3 file being copied.
Bucket (string) --
Specifies the S3 bucket that contains the file being copied.
Key (string) --
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
EfsFileLocation (dict) --
Specifies the details for the Amazon EFS file being copied.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
Path (string) --
The pathname for the folder being used by a workflow.
OverwriteExisting (string) --
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
CustomStepDetails (dict) --
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
Name (string) --
The name of the step, used as an identifier.
Target (string) --
The ARN for the lambda function that is being called.
TimeoutSeconds (integer) --
Timeout, in seconds, for the step.
DeleteStepDetails (dict) --
You need to specify the name of the file to be deleted.
Name (string) --
The name of the step, used as an identifier.
TagStepDetails (dict) --
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
Name (string) --
The name of the step, used as an identifier.
Tags (list) --
Array that contains from 1 to 10 key/value pairs.
(dict) --
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
Key (string) -- [REQUIRED]
The name assigned to the tag that you create.
Value (string) -- [REQUIRED]
The value that corresponds to the key.
list
Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
(dict) --
The basic building block of a workflow.
Type (string) --
Currently, the following step types are supported.
Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file
CopyStepDetails (dict) --
Details for a step that performs a file copy.
Consists of the following values:
A description
An S3 or EFS location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
Name (string) --
The name of the step, used as an identifier.
DestinationFileLocation (dict) --
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
S3FileLocation (dict) --
Specifies the details for the S3 file being copied.
Bucket (string) --
Specifies the S3 bucket that contains the file being copied.
Key (string) --
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
EfsFileLocation (dict) --
Specifies the details for the Amazon EFS file being copied.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
Path (string) --
The pathname for the folder being used by a workflow.
OverwriteExisting (string) --
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
CustomStepDetails (dict) --
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
Name (string) --
The name of the step, used as an identifier.
Target (string) --
The ARN for the lambda function that is being called.
TimeoutSeconds (integer) --
Timeout, in seconds, for the step.
DeleteStepDetails (dict) --
You need to specify the name of the file to be deleted.
Name (string) --
The name of the step, used as an identifier.
TagStepDetails (dict) --
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
Name (string) --
The name of the step, used as an identifier.
Tags (list) --
Array that contains from 1 to 10 key/value pairs.
(dict) --
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
Key (string) -- [REQUIRED]
The name assigned to the tag that you create.
Value (string) -- [REQUIRED]
The value that corresponds to the key.
list
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows 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.
dict
Response Syntax
{
'WorkflowId': 'string'
}
Response Structure
(dict) --
WorkflowId (string) --
A unique identifier for the workflow.
Lists all of your workflows.
See also: AWS API Documentation
Request Syntax
client.list_workflows(
MaxResults=123,
NextToken='string'
)
integer
Specifies the maximum number of workflows to return.
string
ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.
dict
Response Syntax
{
'NextToken': 'string',
'Workflows': [
{
'WorkflowId': 'string',
'Description': 'string',
'Arn': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.
Workflows (list) --
Returns the Arn, WorkflowId, and Description for each workflow.
(dict) --
Contains the ID, 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.
You can use DescribeExecution to check the details of the execution of the specified workflow.
See also: AWS API Documentation
Request Syntax
client.describe_execution(
ExecutionId='string',
WorkflowId='string'
)
string
[REQUIRED]
A unique identifier for the execution of a workflow.
string
[REQUIRED]
A unique identifier for the workflow.
dict
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',
'Outputs': 'string',
'Error': {
'Type': 'PERMISSION_DENIED',
'Message': 'string'
}
},
],
'OnExceptionSteps': [
{
'StepType': 'COPY'|'CUSTOM'|'TAG'|'DELETE',
'Outputs': 'string',
'Error': {
'Type': 'PERMISSION_DENIED',
'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 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 ID and the path for the file being used.
FileSystemId (string) --
The ID 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 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 user account 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) --
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services 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, user activity can be viewed in your CloudWatch logs.
LogGroupName (string) --
The name of the CloudWatch logging group for the Amazon Web Services Transfer 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: custom step with a lambda target
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 workfow step.
Type (string) --
Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
Message (string) --
Specifies the descriptive message that corresponds to the ErrorType.
OnExceptionSteps (list) --
Specifies the steps (actions) to take if any 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: custom step with a lambda target
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 workfow step.
Type (string) --
Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
Message (string) --
Specifies the descriptive message that corresponds to the ErrorType.
{'WorkflowDetails': {'OnUpload': [{'ExecutionRole': 'string',
'WorkflowId': 'string'}]}}
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
See also: AWS API Documentation
Request Syntax
client.create_server(
Certificate='string',
Domain='S3'|'EFS',
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'
},
IdentityProviderType='SERVICE_MANAGED'|'API_GATEWAY'|'AWS_DIRECTORY_SERVICE',
LoggingRole='string',
Protocols=[
'SFTP'|'FTP'|'FTPS',
],
SecurityPolicyName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
WorkflowDetails={
'OnUpload': [
{
'WorkflowId': 'string',
'ExecutionRole': 'string'
},
]
}
)
string
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate 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 Services Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web Services Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
string
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.
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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it 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.
(string) --
SubnetIds (list) --
A list of subnet IDs that are required to host your server endpoint in your VPC.
(string) --
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcId (string) --
The VPC ID of the VPC in which a server's endpoint will be hosted.
SecurityGroupIds (list) --
A list of security groups IDs that are available to attach to your server's endpoint.
(string) --
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.
string
The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.
For more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer Family User Guide.
dict
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
Url (string) --
Provides the location of the service endpoint used to authenticate users.
InvocationRole (string) --
Provides the type of InvocationRole used to authenticate the user account.
DirectoryId (string) --
The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.
string
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
string
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services 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, user activity can be viewed in your CloudWatch logs.
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
(string) --
string
Specifies the name of the security policy that is attached to the server.
list
Key-value pairs that can be used to group and search for servers.
(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.
dict
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
OnUpload (list) -- [REQUIRED]
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
(dict) --
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
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
dict
Response Syntax
{
'ServerId': 'string'
}
Response Structure
(dict) --
ServerId (string) --
The service-assigned ID of the server that is created.
{'Server': {'WorkflowDetails': {'OnUpload': [{'ExecutionRole': 'string',
'WorkflowId': 'string'}]}}}
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
See also: AWS API Documentation
Request Syntax
client.describe_server(
ServerId='string'
)
string
[REQUIRED]
A system-assigned unique identifier for a server.
dict
Response Syntax
{
'Server': {
'Arn': 'string',
'Certificate': 'string',
'ProtocolDetails': {
'PassiveIp': 'string'
},
'Domain': 'S3'|'EFS',
'EndpointDetails': {
'AddressAllocationIds': [
'string',
],
'SubnetIds': [
'string',
],
'VpcEndpointId': 'string',
'VpcId': 'string',
'SecurityGroupIds': [
'string',
]
},
'EndpointType': 'PUBLIC'|'VPC'|'VPC_ENDPOINT',
'HostKeyFingerprint': 'string',
'IdentityProviderDetails': {
'Url': 'string',
'InvocationRole': 'string',
'DirectoryId': 'string'
},
'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY'|'AWS_DIRECTORY_SERVICE',
'LoggingRole': 'string',
'Protocols': [
'SFTP'|'FTP'|'FTPS',
],
'SecurityPolicyName': 'string',
'ServerId': 'string',
'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'UserCount': 123,
'WorkflowDetails': {
'OnUpload': [
{
'WorkflowId': 'string',
'ExecutionRole': 'string'
},
]
}
}
}
Response Structure
(dict) --
Server (dict) --
An array containing the properties of a server with the ServerID you specified.
Arn (string) --
Specifies the unique Amazon Resource Name (ARN) of the server.
Certificate (string) --
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
ProtocolDetails (dict) --
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
PassiveIp (string) --
Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external 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.
Domain (string) --
Specifies the domain of the storage system that is used for file transfers.
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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it 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.
(string) --
SubnetIds (list) --
A list of subnet IDs that are required to host your server endpoint in your VPC.
(string) --
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcId (string) --
The VPC ID of the VPC in which a server's endpoint will be hosted.
SecurityGroupIds (list) --
A list of security groups IDs that are available to attach to your server's endpoint.
(string) --
EndpointType (string) --
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
HostKeyFingerprint (string) --
Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.
IdentityProviderDetails (dict) --
Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
Url (string) --
Provides the location of the service endpoint used to authenticate users.
InvocationRole (string) --
Provides the type of InvocationRole used to authenticate the user account.
DirectoryId (string) --
The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.
IdentityProviderType (string) --
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
LoggingRole (string) --
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services 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, user activity can be viewed in your CloudWatch logs.
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
(string) --
SecurityPolicyName (string) --
Specifies the name of the security policy that is attached to the server.
ServerId (string) --
Specifies the unique system-assigned identifier for a server that you instantiate.
State (string) --
Specifies the condition of a server for 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.
Tags (list) --
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
(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.
UserCount (integer) --
Specifies the number of users that are assigned to a server you specified with the ServerId.
WorkflowDetails (dict) --
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
OnUpload (list) --
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
(dict) --
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
WorkflowId (string) --
A unique identifier for the workflow.
ExecutionRole (string) --
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
{'WorkflowDetails': {'OnUpload': [{'ExecutionRole': 'string',
'WorkflowId': 'string'}]}}
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
client.update_server(
Certificate='string',
ProtocolDetails={
'PassiveIp': 'string'
},
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'
},
LoggingRole='string',
Protocols=[
'SFTP'|'FTP'|'FTPS',
],
SecurityPolicyName='string',
ServerId='string',
WorkflowDetails={
'OnUpload': [
{
'WorkflowId': 'string',
'ExecutionRole': 'string'
},
]
}
)
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)
dict
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
PassiveIp (string) --
Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external 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.
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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it 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.
(string) --
SubnetIds (list) --
A list of subnet IDs that are required to host your server endpoint in your VPC.
(string) --
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcId (string) --
The VPC ID of the VPC in which a server's endpoint will be hosted.
SecurityGroupIds (list) --
A list of security groups IDs that are available to attach to your server's endpoint.
(string) --
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.
string
The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
For more information, see Change the host key for your SFTP-enabled server in the Amazon Web ServicesTransfer Family User Guide.
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) --
Provides the type of InvocationRole used to authenticate the user account.
DirectoryId (string) --
The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.
string
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services 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, user activity can be viewed in your CloudWatch logs.
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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
(string) --
string
Specifies the name of the security policy that is attached to the server.
string
[REQUIRED]
A system-assigned unique identifier for a server instance that the user account is assigned to.
dict
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
OnUpload (list) -- [REQUIRED]
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
(dict) --
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
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
dict
Response Syntax
{
'ServerId': 'string'
}
Response Structure
(dict) --
ServerId (string) --
A system-assigned unique identifier for a server that the user account is assigned to.