prowler-sdk-poc
Version:
1,267 lines • 27.1 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2018-11-05",
"endpointPrefix": "transfer",
"jsonVersion": "1.1",
"protocol": "json",
"serviceAbbreviation": "AWS Transfer",
"serviceFullName": "AWS Transfer Family",
"serviceId": "Transfer",
"signatureVersion": "v4",
"signingName": "transfer",
"targetPrefix": "TransferService",
"uid": "transfer-2018-11-05"
},
"operations": {
"CreateAccess": {
"input": {
"type": "structure",
"required": [
"Role",
"ServerId",
"ExternalId"
],
"members": {
"HomeDirectory": {},
"HomeDirectoryType": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"ServerId": {},
"ExternalId": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"ExternalId"
],
"members": {
"ServerId": {},
"ExternalId": {}
}
}
},
"CreateServer": {
"input": {
"type": "structure",
"members": {
"Certificate": {},
"Domain": {},
"EndpointDetails": {
"shape": "Sj"
},
"EndpointType": {},
"HostKey": {
"shape": "St"
},
"IdentityProviderDetails": {
"shape": "Su"
},
"IdentityProviderType": {},
"LoggingRole": {},
"Protocols": {
"shape": "Sy"
},
"SecurityPolicyName": {},
"Tags": {
"shape": "S11"
},
"WorkflowDetails": {
"shape": "S15"
}
}
},
"output": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
}
},
"CreateUser": {
"input": {
"type": "structure",
"required": [
"Role",
"ServerId",
"UserName"
],
"members": {
"HomeDirectory": {},
"HomeDirectoryType": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"ServerId": {},
"SshPublicKeyBody": {},
"Tags": {
"shape": "S11"
},
"UserName": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"ServerId": {},
"UserName": {}
}
}
},
"CreateWorkflow": {
"input": {
"type": "structure",
"required": [
"Steps"
],
"members": {
"Description": {},
"Steps": {
"shape": "S1g"
},
"OnExceptionSteps": {
"shape": "S1g"
},
"Tags": {
"shape": "S11"
}
}
},
"output": {
"type": "structure",
"required": [
"WorkflowId"
],
"members": {
"WorkflowId": {}
}
}
},
"DeleteAccess": {
"input": {
"type": "structure",
"required": [
"ServerId",
"ExternalId"
],
"members": {
"ServerId": {},
"ExternalId": {}
}
}
},
"DeleteServer": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
}
},
"DeleteSshPublicKey": {
"input": {
"type": "structure",
"required": [
"ServerId",
"SshPublicKeyId",
"UserName"
],
"members": {
"ServerId": {},
"SshPublicKeyId": {},
"UserName": {}
}
}
},
"DeleteUser": {
"input": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"ServerId": {},
"UserName": {}
}
}
},
"DeleteWorkflow": {
"input": {
"type": "structure",
"required": [
"WorkflowId"
],
"members": {
"WorkflowId": {}
}
}
},
"DescribeAccess": {
"input": {
"type": "structure",
"required": [
"ServerId",
"ExternalId"
],
"members": {
"ServerId": {},
"ExternalId": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"Access"
],
"members": {
"ServerId": {},
"Access": {
"type": "structure",
"members": {
"HomeDirectory": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"HomeDirectoryType": {},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"ExternalId": {}
}
}
}
}
},
"DescribeExecution": {
"input": {
"type": "structure",
"required": [
"ExecutionId",
"WorkflowId"
],
"members": {
"ExecutionId": {},
"WorkflowId": {}
}
},
"output": {
"type": "structure",
"required": [
"WorkflowId",
"Execution"
],
"members": {
"WorkflowId": {},
"Execution": {
"type": "structure",
"members": {
"ExecutionId": {},
"InitialFileLocation": {
"shape": "S2g"
},
"ServiceMetadata": {
"shape": "S2k"
},
"ExecutionRole": {},
"LoggingConfiguration": {
"type": "structure",
"members": {
"LoggingRole": {},
"LogGroupName": {}
}
},
"PosixProfile": {
"shape": "S9"
},
"Status": {},
"Results": {
"type": "structure",
"members": {
"Steps": {
"shape": "S2r"
},
"OnExceptionSteps": {
"shape": "S2r"
}
}
}
}
}
}
}
},
"DescribeSecurityPolicy": {
"input": {
"type": "structure",
"required": [
"SecurityPolicyName"
],
"members": {
"SecurityPolicyName": {}
}
},
"output": {
"type": "structure",
"required": [
"SecurityPolicy"
],
"members": {
"SecurityPolicy": {
"type": "structure",
"required": [
"SecurityPolicyName"
],
"members": {
"Fips": {
"type": "boolean"
},
"SecurityPolicyName": {},
"SshCiphers": {
"shape": "S31"
},
"SshKexs": {
"shape": "S31"
},
"SshMacs": {
"shape": "S31"
},
"TlsCiphers": {
"shape": "S31"
}
}
}
}
}
},
"DescribeServer": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
},
"output": {
"type": "structure",
"required": [
"Server"
],
"members": {
"Server": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"Certificate": {},
"ProtocolDetails": {
"shape": "S37"
},
"Domain": {},
"EndpointDetails": {
"shape": "Sj"
},
"EndpointType": {},
"HostKeyFingerprint": {},
"IdentityProviderDetails": {
"shape": "Su"
},
"IdentityProviderType": {},
"LoggingRole": {},
"Protocols": {
"shape": "Sy"
},
"SecurityPolicyName": {},
"ServerId": {},
"State": {},
"Tags": {
"shape": "S11"
},
"UserCount": {
"type": "integer"
},
"WorkflowDetails": {
"shape": "S15"
}
}
}
}
}
},
"DescribeUser": {
"input": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"ServerId": {},
"UserName": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"User"
],
"members": {
"ServerId": {},
"User": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"HomeDirectory": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"HomeDirectoryType": {},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"SshPublicKeys": {
"type": "list",
"member": {
"type": "structure",
"required": [
"DateImported",
"SshPublicKeyBody",
"SshPublicKeyId"
],
"members": {
"DateImported": {
"type": "timestamp"
},
"SshPublicKeyBody": {},
"SshPublicKeyId": {}
}
}
},
"Tags": {
"shape": "S11"
},
"UserName": {}
}
}
}
}
},
"DescribeWorkflow": {
"input": {
"type": "structure",
"required": [
"WorkflowId"
],
"members": {
"WorkflowId": {}
}
},
"output": {
"type": "structure",
"required": [
"Workflow"
],
"members": {
"Workflow": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"Description": {},
"Steps": {
"shape": "S1g"
},
"OnExceptionSteps": {
"shape": "S1g"
},
"WorkflowId": {},
"Tags": {
"shape": "S11"
}
}
}
}
}
},
"ImportSshPublicKey": {
"input": {
"type": "structure",
"required": [
"ServerId",
"SshPublicKeyBody",
"UserName"
],
"members": {
"ServerId": {},
"SshPublicKeyBody": {},
"UserName": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"SshPublicKeyId",
"UserName"
],
"members": {
"ServerId": {},
"SshPublicKeyId": {},
"UserName": {}
}
}
},
"ListAccesses": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {},
"ServerId": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"Accesses"
],
"members": {
"NextToken": {},
"ServerId": {},
"Accesses": {
"type": "list",
"member": {
"type": "structure",
"members": {
"HomeDirectory": {},
"HomeDirectoryType": {},
"Role": {},
"ExternalId": {}
}
}
}
}
}
},
"ListExecutions": {
"input": {
"type": "structure",
"required": [
"WorkflowId"
],
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {},
"WorkflowId": {}
}
},
"output": {
"type": "structure",
"required": [
"WorkflowId",
"Executions"
],
"members": {
"NextToken": {},
"WorkflowId": {},
"Executions": {
"type": "list",
"member": {
"type": "structure",
"members": {
"ExecutionId": {},
"InitialFileLocation": {
"shape": "S2g"
},
"ServiceMetadata": {
"shape": "S2k"
},
"Status": {}
}
}
}
}
}
},
"ListSecurityPolicies": {
"input": {
"type": "structure",
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"SecurityPolicyNames"
],
"members": {
"NextToken": {},
"SecurityPolicyNames": {
"type": "list",
"member": {}
}
}
}
},
"ListServers": {
"input": {
"type": "structure",
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"Servers"
],
"members": {
"NextToken": {},
"Servers": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"Domain": {},
"IdentityProviderType": {},
"EndpointType": {},
"LoggingRole": {},
"ServerId": {},
"State": {},
"UserCount": {
"type": "integer"
}
}
}
}
}
}
},
"ListTagsForResource": {
"input": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"NextToken": {},
"Tags": {
"shape": "S11"
}
}
}
},
"ListUsers": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {},
"ServerId": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"Users"
],
"members": {
"NextToken": {},
"ServerId": {},
"Users": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Arn"
],
"members": {
"Arn": {},
"HomeDirectory": {},
"HomeDirectoryType": {},
"Role": {},
"SshPublicKeyCount": {
"type": "integer"
},
"UserName": {}
}
}
}
}
}
},
"ListWorkflows": {
"input": {
"type": "structure",
"members": {
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"Workflows"
],
"members": {
"NextToken": {},
"Workflows": {
"type": "list",
"member": {
"type": "structure",
"members": {
"WorkflowId": {},
"Description": {},
"Arn": {}
}
}
}
}
}
},
"SendWorkflowStepState": {
"input": {
"type": "structure",
"required": [
"WorkflowId",
"ExecutionId",
"Token",
"Status"
],
"members": {
"WorkflowId": {},
"ExecutionId": {},
"Token": {},
"Status": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"StartServer": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
}
},
"StopServer": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
}
},
"TagResource": {
"input": {
"type": "structure",
"required": [
"Arn",
"Tags"
],
"members": {
"Arn": {},
"Tags": {
"shape": "S11"
}
}
}
},
"TestIdentityProvider": {
"input": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"ServerId": {},
"ServerProtocol": {},
"SourceIp": {},
"UserName": {},
"UserPassword": {
"type": "string",
"sensitive": true
}
}
},
"output": {
"type": "structure",
"required": [
"StatusCode",
"Url"
],
"members": {
"Response": {},
"StatusCode": {
"type": "integer"
},
"Message": {},
"Url": {}
}
}
},
"UntagResource": {
"input": {
"type": "structure",
"required": [
"Arn",
"TagKeys"
],
"members": {
"Arn": {},
"TagKeys": {
"type": "list",
"member": {}
}
}
}
},
"UpdateAccess": {
"input": {
"type": "structure",
"required": [
"ServerId",
"ExternalId"
],
"members": {
"HomeDirectory": {},
"HomeDirectoryType": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"ServerId": {},
"ExternalId": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"ExternalId"
],
"members": {
"ServerId": {},
"ExternalId": {}
}
}
},
"UpdateServer": {
"input": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"Certificate": {},
"ProtocolDetails": {
"shape": "S37"
},
"EndpointDetails": {
"shape": "Sj"
},
"EndpointType": {},
"HostKey": {
"shape": "St"
},
"IdentityProviderDetails": {
"shape": "Su"
},
"LoggingRole": {},
"Protocols": {
"shape": "Sy"
},
"SecurityPolicyName": {},
"ServerId": {},
"WorkflowDetails": {
"shape": "S15"
}
}
},
"output": {
"type": "structure",
"required": [
"ServerId"
],
"members": {
"ServerId": {}
}
}
},
"UpdateUser": {
"input": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"HomeDirectory": {},
"HomeDirectoryType": {},
"HomeDirectoryMappings": {
"shape": "S4"
},
"Policy": {},
"PosixProfile": {
"shape": "S9"
},
"Role": {},
"ServerId": {},
"UserName": {}
}
},
"output": {
"type": "structure",
"required": [
"ServerId",
"UserName"
],
"members": {
"ServerId": {},
"UserName": {}
}
}
}
},
"shapes": {
"S4": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Entry",
"Target"
],
"members": {
"Entry": {},
"Target": {}
}
}
},
"S9": {
"type": "structure",
"required": [
"Uid",
"Gid"
],
"members": {
"Uid": {
"type": "long"
},
"Gid": {
"type": "long"
},
"SecondaryGids": {
"type": "list",
"member": {
"type": "long"
}
}
}
},
"Sj": {
"type": "structure",
"members": {
"AddressAllocationIds": {
"type": "list",
"member": {}
},
"SubnetIds": {
"type": "list",
"member": {}
},
"VpcEndpointId": {},
"VpcId": {},
"SecurityGroupIds": {
"type": "list",
"member": {}
}
}
},
"St": {
"type": "string",
"sensitive": true
},
"Su": {
"type": "structure",
"members": {
"Url": {},
"InvocationRole": {},
"DirectoryId": {}
}
},
"Sy": {
"type": "list",
"member": {}
},
"S11": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Key",
"Value"
],
"members": {
"Key": {},
"Value": {}
}
}
},
"S15": {
"type": "structure",
"required": [
"OnUpload"
],
"members": {
"OnUpload": {
"type": "list",
"member": {
"type": "structure",
"required": [
"WorkflowId",
"ExecutionRole"
],
"members": {
"WorkflowId": {},
"ExecutionRole": {}
}
}
}
}
},
"S1g": {
"type": "list",
"member": {
"type": "structure",
"members": {
"Type": {},
"CopyStepDetails": {
"type": "structure",
"members": {
"Name": {},
"DestinationFileLocation": {
"type": "structure",
"members": {
"S3FileLocation": {
"type": "structure",
"members": {
"Bucket": {},
"Key": {}
}
},
"EfsFileLocation": {
"shape": "S1p"
}
}
},
"OverwriteExisting": {}
}
},
"CustomStepDetails": {
"type": "structure",
"members": {
"Name": {},
"Target": {},
"TimeoutSeconds": {
"type": "integer"
}
}
},
"DeleteStepDetails": {
"type": "structure",
"members": {
"Name": {}
}
},
"TagStepDetails": {
"type": "structure",
"members": {
"Name": {},
"Tags": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Key",
"Value"
],
"members": {
"Key": {},
"Value": {}
}
}
}
}
}
}
}
},
"S1p": {
"type": "structure",
"members": {
"FileSystemId": {},
"Path": {}
}
},
"S2g": {
"type": "structure",
"members": {
"S3FileLocation": {
"type": "structure",
"members": {
"Bucket": {},
"Key": {},
"VersionId": {},
"Etag": {}
}
},
"EfsFileLocation": {
"shape": "S1p"
}
}
},
"S2k": {
"type": "structure",
"required": [
"UserDetails"
],
"members": {
"UserDetails": {
"type": "structure",
"required": [
"UserName",
"ServerId"
],
"members": {
"UserName": {},
"ServerId": {},
"SessionId": {}
}
}
}
},
"S2r": {
"type": "list",
"member": {
"type": "structure",
"members": {
"StepType": {},
"Outputs": {},
"Error": {
"type": "structure",
"required": [
"Type",
"Message"
],
"members": {
"Type": {},
"Message": {}
}
}
}
}
},
"S31": {
"type": "list",
"member": {}
},
"S37": {
"type": "structure",
"members": {
"PassiveIp": {}
}
}
}
}