Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
transcribe-dg-125	transcribe-dg.pdf	125	of the custom vocabulary that you want to use. For more information, see Improving transcription accuracy with medical custom vocabularies. To label the speech from diﬀerent speakers, set the show-speaker-label parameter in to true. For more information, see Enabling speaker partitioning. For more information on creating pre-signed URIs, see Setting up a WebSocket stream. Enabling speaker partitioning To enable speaker partitioning in Amazon Transcribe Medical, use speaker diarization. This enables you to see what the patient said and what the clinician said in the transcription output. When you enable speaker diarization, Amazon Transcribe Medical labels each speaker utterance with a unique identiﬁer for each speaker. An utterance is a unit of speech that is typically separated from other utterances by silence. In batch transcription, an utterance from the clinician could receive a label of spk_0 and an utterance the patient could receive a label of spk_1. If an utterance from one speaker overlaps with an utterance from another speaker, Amazon Transcribe Medical orders them in the transcription by their start times. Utterances that overlap in the input audio don't overlap in the transcription output. You can enable speaker diarization when you transcribe an audio ﬁle using batch transcription job, or in a real-time stream. Topics Enabling speaker partitioning 567 Amazon Transcribe Developer Guide • Enabling speaker partitioning in batch transcriptions • Enabling speaker partitioning in real-time streams Enabling speaker partitioning in batch transcriptions You can enable speaker partitioning in a batch transcription job using either the StartMedicalTranscriptionJob API or the AWS Management Console. This enables you to partition the text per speaker in a clinician-patient conversation and determine who said what in the transcription output. AWS Management Console To use the AWS Management Console to enable speaker diarization in your transcription job, you enable audio identiﬁcation and then speaker partitioning. 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. 4. On the Specify job details page, provide information about your transcription job. 5. Choose Next. 6. 7. 8. Enable Audio identiﬁcation. For Audio identiﬁcation type, choose Speaker partitioning. For Maximum number of speakers, enter the maximum number of speakers that you think are speaking in your audio ﬁle. 9. Choose Create. API To enable speaker partitioning using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. For MedicalTranscriptionJobName, specify a name that is unique in your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in the audio ﬁle. Enabling speaker partitioning 568 Amazon Transcribe Developer Guide c. d. e. f. g. For the MediaFileUri parameter of the Media object, specify the name of the audio ﬁle that you want to transcribe. For Specialty, specify the medical specialty of the clinician speaking in the audio ﬁle. For Type, specify CONVERSATION. For OutputBucketName, specify the Amazon S3 bucket to store the transcription results. For the Settings object, specify the following. i. ii. ShowSpeakerLabels – true. MaxSpeakerLabels – An integer between 2 and 10 to indicate the number of speakers that you think are speaking in your audio. The following request uses the AWS SDK for Python (Boto3) to start a batch transcription job of a primary care clinician patient dialogue with speaker partitioning enabled. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media={ 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'my-output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION', OutputBucketName = 'amzn-s3-demo-bucket', Settings = {'ShowSpeakerLabels': True, 'MaxSpeakerLabels': 2 } ) while True: status = transcribe.get_medical_transcription_job(MedicalTranscriptionJobName = job_name) Enabling speaker partitioning 569 Amazon Transcribe Developer Guide if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) The following example code shows the transcription results of a transcription job with speaker partitioning enabled. { "jobName": "job ID", "accountId": "111122223333", "results": { "transcripts": [ { "transcript": "Professional answer." } ], "speaker_labels": { "speakers": 1, "segments": [ { "start_time": "0.000000", "speaker_label": "spk_0", "end_time": "1.430", "items": [ { "start_time": "0.100", "speaker_label": "spk_0", "end_time": "0.690" }, { "start_time": "0.690", "speaker_label": "spk_0", "end_time": "1.210" } ] } ] Enabling speaker partitioning 570 Developer Guide Amazon Transcribe }, "items": [ { "start_time": "0.100", "end_time": "0.690", "alternatives": [ { "confidence": "0.8162", "content": "Professional" } ], "type": "pronunciation" }, { "start_time": "0.690", "end_time": "1.210", "alternatives": [ { "confidence": "0.9939", "content": "answer" } ], "type": "pronunciation" }, { "alternatives": [ { "content": "." } ], "type": "punctuation" } ] }, "status": "COMPLETED" } Enabling speaker partitioning 571 Amazon Transcribe AWS CLI Developer Guide To transcribe an audio ﬁle of a conversation between a clinician practicing primary care and a patient (AWS CLI) • Run the following code. aws transcribe start-transcription-job \ --region us-west-2 \ --cli-input-json file://example-start-command.json The following code
transcribe-dg-126	transcribe-dg.pdf	126	Transcribe }, "items": [ { "start_time": "0.100", "end_time": "0.690", "alternatives": [ { "confidence": "0.8162", "content": "Professional" } ], "type": "pronunciation" }, { "start_time": "0.690", "end_time": "1.210", "alternatives": [ { "confidence": "0.9939", "content": "answer" } ], "type": "pronunciation" }, { "alternatives": [ { "content": "." } ], "type": "punctuation" } ] }, "status": "COMPLETED" } Enabling speaker partitioning 571 Amazon Transcribe AWS CLI Developer Guide To transcribe an audio ﬁle of a conversation between a clinician practicing primary care and a patient (AWS CLI) • Run the following code. aws transcribe start-transcription-job \ --region us-west-2 \ --cli-input-json file://example-start-command.json The following code shows the contents of example-start-command.json. { "MedicalTranscriptionJobName": "my-first-med-transcription-job", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-audio- file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "OutputKey": "my-output-files/", "LanguageCode": "en-US", "Specialty": "PRIMARYCARE", "Type": "CONVERSATION", "Settings":{ "ShowSpeakerLabels": true, "MaxSpeakerLabels": 2 } } Enabling speaker partitioning in real-time streams To partition speakers and label their speech in a real-time stream, use the AWS Management Console or a streaming request. Speaker partitioning works best for between two and ﬁve speakers in a stream. Although Amazon Transcribe Medical can partition more than ﬁve speakers in a stream, the accuracy of the partitions decrease if you exceed that number. Enabling speaker partitioning 572 Amazon Transcribe Developer Guide To start an HTTP/2 request, use the StartMedicalStreamTranscription API. To start a WebSocket request, use a pre-signed URI. The URI contains the information required to set up bi- directional communication between your application and Amazon Transcribe Medical. Enabling speaker partitioning in audio that is spoken into your microphone (AWS Management Console) You can use the AWS Management Console to start a real-time stream of a clinician-patient conversation, or a dictation that is spoken into your microphone in real-time. 1. 2. 3. 4. Sign in to the AWS Management Console. In the navigation pane, for Amazon Transcribe Medical choose Real-time transcription. For Audio input type, choose the type of medical speech that you want to transcribe. For Additional settings, choose Speaker partitioning. 5. Choose Start streaming to start transcribing your real-time audio. 6. Speak into the microphone. Enabling speaker partitioning in an HTTP/2 stream To enable speaker partitioning in an HTTP/2 stream of a medical conversation, use the StartMedicalStreamTranscription API and specify the following: • For LanguageCode, specify the language code that corresponds to the language in the stream. The valid value is en-US. • For MediaSampleHertz, specify the sample rate of the audio. • For Specialty, specify the medical specialty of the provider. • ShowSpeakerLabel – true For more information on setting up an HTTP/2 stream to transcribe a medical conversation, see Setting up an HTTP/2 stream. Enabling speaker partitioning in a WebSocket request To partition speakers in WebSocket streams with the API, use the following format to create a pre- signed URI to start a WebSocket request and set show-speaker-label to true. Enabling speaker partitioning 573 Amazon Transcribe Developer Guide GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket ?language-code=languageCode &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &media-encoding=flac &sample-rate=16000 &session-id=sessionId &specialty=medicalSpecialty &type=CONVERSATION &vocabulary-name=vocabularyName &show-speaker-label=boolean The following code shows the truncated example response of a streaming request. { "Transcript": { "Results": [ { "Alternatives": [ { "Items": [ { "Confidence": 0.97, "Content": "From", "EndTime": 18.98, "Speaker": "0", "StartTime": 18.74, "Type": "pronunciation", "VocabularyFilterMatch": false }, { "Confidence": 1, "Content": "the", Enabling speaker partitioning 574 Amazon Transcribe Developer Guide "EndTime": 19.31, "Speaker": "0", "StartTime": 19, "Type": "pronunciation", "VocabularyFilterMatch": false }, { "Confidence": 1, "Content": "last", "EndTime": 19.86, "Speaker": "0", "StartTime": 19.32, "Type": "pronunciation", "VocabularyFilterMatch": false }, ... { "Confidence": 1, "Content": "chronic", "EndTime": 22.55, "Speaker": "0", "StartTime": 21.97, "Type": "pronunciation", "VocabularyFilterMatch": false }, ... "Confidence": 1, "Content": "fatigue", "EndTime": 24.42, "Speaker": "0", "StartTime": 23.95, "Type": "pronunciation", "VocabularyFilterMatch": false }, { "EndTime": 25.22, "StartTime": 25.22, "Type": "speaker-change", "VocabularyFilterMatch": false }, { "Confidence": 0.99, "Content": "True", "EndTime": 25.63, Enabling speaker partitioning 575 Amazon Transcribe Developer Guide "Speaker": "1", "StartTime": 25.22, "Type": "pronunciation", "VocabularyFilterMatch": false }, { "Content": ".", "EndTime": 25.63, "StartTime": 25.63, "Type": "punctuation", "VocabularyFilterMatch": false } ], "Transcript": "From the last note she still has mild sleep deprivation and chronic fatigue True." } ], "EndTime": 25.63, "IsPartial": false, "ResultId": "XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX", "StartTime": 18.74 } ] } } Amazon Transcribe Medical breaks your incoming audio stream based on natural speech segments, such as a change in speaker or a pause in the audio. The transcription is returned progressively to your application, with each response containing more transcribed speech until the entire segment is transcribed. The preceding code is a truncated example of a fully-transcribed speech segment. Speaker labels only appear for entirely transcribed segments. The following list shows the organization of the objects and parameters in a streaming transcription output. Transcript Each speech segment has its own Transcript object. Enabling speaker partitioning 576 Amazon Transcribe Results Developer Guide Each Transcript object has its own Results object. This object contains the isPartial ﬁeld. When its value
transcribe-dg-127	transcribe-dg.pdf	127	in speaker or a pause in the audio. The transcription is returned progressively to your application, with each response containing more transcribed speech until the entire segment is transcribed. The preceding code is a truncated example of a fully-transcribed speech segment. Speaker labels only appear for entirely transcribed segments. The following list shows the organization of the objects and parameters in a streaming transcription output. Transcript Each speech segment has its own Transcript object. Enabling speaker partitioning 576 Amazon Transcribe Results Developer Guide Each Transcript object has its own Results object. This object contains the isPartial ﬁeld. When its value is false, the results returned are for an entire speech segment. Alternatives Each Results object has an Alternatives object. Items Each Alternatives object has its own Items object that contains information about each word and punctuation mark in the transcription output. When you enable speaker partitioning, each word has a Speaker label for fully-transcribed speech segments. Amazon Transcribe Medical uses this label to assign a unique integer to each speaker in the stream. The Type parameter having a value of speaker-change indicates that one person has stopped speaking and that another person is about to begin. Transcript Each Items object contains a transcribed speech segment as the value of the Transcript ﬁeld. For more information about WebSocket requests, see Setting up a WebSocket stream. Transcribing multi-channel audio If you have an audio ﬁle or stream that has multiple channels, you can use channel identiﬁcation to transcribe the speech from each of those channels. Amazon Transcribe Medical transcribes the speech from each channel separately. It combines the separate transcriptions of each channel into a single transcription output. Use channel identiﬁcation to identify the separate channels in your audio and transcribe the speech from each of those channels. Enable this in situations such as a caller and agent scenario. Use this to distinguish a caller from an agent in recordings or streams from contact centers that perform drug safety monitoring. You can enable channel identiﬁcation for both batch processing and real-time streaming. The following list describes how to enable it for each method. • Batch transcription – AWS Management Console and StartMedicalTranscriptionJob API • Streaming transcription – WebSocket streaming and StartMedicalStreamTranscription API Transcribing multi-channel audio 577 Amazon Transcribe Developer Guide Transcribing multi-channel audio ﬁles When you transcribe an audio ﬁle, Amazon Transcribe Medical returns a list of items for each channel. An item is a transcribed word or punctuation mark. Each word has a start time and an end time. If a person on one channel speaks over a person on a separate channel, the start times and end times of the items for each channel overlap while the individuals are speaking over each other. By default, you can transcribe audio ﬁles with two channels. You can request a quota increase if you need to transcribe ﬁles that have more than two channels. For information about requesting a quota increase, see AWS service quotas. To transcribe multi-channel audio in a batch transcription job, use the AWS Management Console or the StartMedicalTranscriptionJob API. AWS Management Console To use the AWS Management Console to enable channel identiﬁcation in your batch transcription job, you enable audio identiﬁcation and then channel identiﬁcation. Channel identiﬁcation is a subset of audio identiﬁcation in the AWS Management Console. 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. 4. On the Specify job details page, provide information about your transcription job. 5. Choose Next. 6. 7. Enable Audio identiﬁcation. For Audio identiﬁcation type, choose Channel identiﬁcation. 8. Choose Create. API To transcribe a multi-channel audio ﬁle (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. For TranscriptionJobName, specify a name unique to your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in the audio ﬁle. The valid value is en-US. Transcribing multi-channel audio 578 Amazon Transcribe Developer Guide c. For the MediaFileUri parameter of the Media object, specify the name of the media ﬁle that you want to transcribe. d. For the Settings object, set ChannelIdentification to true. The following is an example request using the AWS SDK for Python (Boto3). from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-transcription-job" job_name = "my-first-med-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION', Settings = { 'ChannelIdentification': True } ) while True: status = transcribe.get_transcription_job(MedicalTranscriptionJobName = job_name) if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) Transcribing multi-channel audio 579 Amazon Transcribe AWS CLI Developer Guide To transcribe a multi-channel audio ﬁle using a batch transcription job (AWS CLI) • Run
transcribe-dg-128	transcribe-dg.pdf	128	SDK for Python (Boto3). from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-transcription-job" job_name = "my-first-med-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION', Settings = { 'ChannelIdentification': True } ) while True: status = transcribe.get_transcription_job(MedicalTranscriptionJobName = job_name) if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) Transcribing multi-channel audio 579 Amazon Transcribe AWS CLI Developer Guide To transcribe a multi-channel audio ﬁle using a batch transcription job (AWS CLI) • Run the following code. aws transcribe start-medical-transcription-job \ --region us-west-2 \ --cli-input-json file://example-start-command.json The following is the code of example-start-command.json. { "MedicalTranscriptionJobName": "my-first-med-transcription-job", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-audio- file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "OutputKey": "my-output-files/", "LanguageCode": "en-US", "Specialty": "PRIMARYCARE", "Type": "CONVERSATION", "Settings":{ "ChannelIdentification": true } } The following code shows the transcription output for an audio ﬁle that has a conversation on two channels. { "jobName": "job id", "accountId": "111122223333", "results": { "transcripts": [ Transcribing multi-channel audio 580 Amazon Transcribe { "transcript": "When you try ... It seems to ..." } Developer Guide ], "channel_labels": { "channels": [ { "channel_label": "ch_0", "items": [ { "start_time": "12.282", "end_time": "12.592", "alternatives": [ { "confidence": "1.0000", "content": "When" } ], "type": "pronunciation" }, { "start_time": "12.592", "end_time": "12.692", "alternatives": [ { "confidence": "0.8787", "content": "you" } ], "type": "pronunciation" }, { "start_time": "12.702", "end_time": "13.252", "alternatives": [ { "confidence": "0.8318", "content": "try" } ], "type": "pronunciation" }, ... ] Transcribing multi-channel audio 581 Developer Guide Amazon Transcribe }, { "channel_label": "ch_1", "items": [ { "start_time": "12.379", "end_time": "12.589", "alternatives": [ { "confidence": "0.5645", "content": "It" } ], "type": "pronunciation" }, { "start_time": "12.599", "end_time": "12.659", "alternatives": [ { "confidence": "0.2907", "content": "seems" } ], "type": "pronunciation" }, { "start_time": "12.669", "end_time": "13.029", "alternatives": [ { "confidence": "0.2497", "content": "to" } ], "type": "pronunciation" }, ... ] } } Transcribing multi-channel audio 582 Amazon Transcribe Developer Guide Transcribing multi-channel audio streams You can transcribe audio from separate channels in either HTTP/2 or WebSocket streams using the StartMedicalStreamTranscription API. By default, you can transcribe streams with two channels. You can request a quota increase if you need to transcribe streams that have more than two channels. For information about requesting a quota increase, see AWS service quotas. Transcribing multi-channel audio in an HTTP/2 stream To transcribe multi-channel audio in an HTTP/2 stream, use the StartMedicalStreamTranscription API and specify the following: • LanguageCode – The language code of the audio. The valid value is en-US. • MediaEncoding – The encoding of the audio. Valid values are ogg-opus, flac, and pcm. • EnableChannelIdentification – true • NumberOfChannels – the number of channels in your streaming audio. For more information on setting up an HTTP/2 stream to transcribe a medical conversation, see Setting up an HTTP/2 stream. Transcribing multi-channel audio in a WebSocket stream To partition speakers in WebSocket streams, use the following format to create a pre-signed URI and start a WebSocket request. Specify enable-channel-identification as true and the number of channels in your stream in number-of-channels. A pre-signed URI contains the information needed to set up bi-directional communication between your application and Amazon Transcribe Medical. GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket ?language-code=languageCode &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 &X-Amz-Security-Token=security-token Transcribing multi-channel audio 583 Amazon Transcribe Developer Guide &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &media-encoding=flac &sample-rate=16000 &session-id=sessionId &enable-channel-identification=true &number-of-channels=2 Parameter deﬁnitions can be found in the API Reference; parameters common to all AWS API operations are listed in the Common Parameters section. For more information about WebSocket requests, see Setting up a WebSocket stream. Multi-channel streaming output The output of a streaming transcription is the same for HTTP/2 and WebSocket requests. The following is an example output. { "resultId": "XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "startTime": 0.11, "endTime": 0.66, "isPartial": false, "alternatives": [ { "transcript": "Left.", "items": [ { "startTime": 0.11, "endTime": 0.45, "type": "pronunciation", "content": "Left", "vocabularyFilterMatch": false }, { "startTime": 0.45, "endTime": 0.45, "type": "punctuation", "content": ".", "vocabularyFilterMatch": false } ] Transcribing multi-channel audio 584 Amazon Transcribe } ], "channelId": "ch_0" } Developer Guide For each speech segment, there is a channelId ﬂag that indicates which channel the speech belongs to. Transcribing a medical dictation You can use Amazon Transcribe Medical to transcribe clinician-dictated medical notes using either a batch transcription job or a real-time stream. Batch transcription jobs enable you to transcribe audio ﬁles. You specify the medical specialty of the clinician in your transcription job or stream to ensure that Amazon Transcribe Medical produces transcription results with the highest possible accuracy. You can transcribe a medical dictation in the following specialties: • Cardiology – available in streaming transcription only • Neurology – available in streaming transcription only • Oncology – available in streaming transcription only • Primary Care – includes the following types of medical practice:
transcribe-dg-129	transcribe-dg.pdf	129	Amazon Transcribe Medical to transcribe clinician-dictated medical notes using either a batch transcription job or a real-time stream. Batch transcription jobs enable you to transcribe audio ﬁles. You specify the medical specialty of the clinician in your transcription job or stream to ensure that Amazon Transcribe Medical produces transcription results with the highest possible accuracy. You can transcribe a medical dictation in the following specialties: • Cardiology – available in streaming transcription only • Neurology – available in streaming transcription only • Oncology – available in streaming transcription only • Primary Care – includes the following types of medical practice: • Family medicine • Internal medicine • Obstetrics and Gynecology (OB-GYN) • Pediatrics • Radiology – available in streaming transcription only • Urology – available in streaming transcription only You can improve transcription accuracy by using custom vocabularies. For information on how medical custom vocabularies work, see Improving transcription accuracy with medical custom vocabularies. By default, Amazon Transcribe Medical returns the transcription with the highest conﬁdence level. If you'd like to conﬁgure it to return alternative transcriptions, see Generating alternative transcriptions. Transcribing a medical dictation 585 Amazon Transcribe Developer Guide For information about how numbers and medical measurements appear in the transcription output, see Transcribing numbers and Transcribing medical terms and measurements. Topics • Transcribing an audio ﬁle of a medical dictation • Transcribing a medical dictation in a real-time stream Transcribing an audio ﬁle of a medical dictation Use a batch transcription job to transcribe audio ﬁles of medical conversations. You can use this to transcribe a clinician-patient dialogue. You can start a batch transcription job in either the StartMedicalTranscriptionJob API or the AWS Management Console. When you start a medical transcription job with the StartMedicalTranscriptionJob API, you specify PRIMARYCARE as the value of the Specialty parameter. AWS Management Console To transcribe a clinician-patient dialogue (AWS Management Console) To use the AWS Management Console to transcribe a clinician-patient dialogue, create a transcription job and choose Conversation for Audio input type. 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. 4. On the Specify job details page, under Job settings , specify the following. a. Name – the name of the transcription job. b. Audio input type – Dictation 5. For the remaining ﬁelds, specify the Amazon S3 location of your audio ﬁle and where you want to store the output of your transcription job. 6. Choose Next. 7. Choose Create. Transcribing an audio ﬁle 586 Amazon Transcribe API Developer Guide To transcribe a medical conversation using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. c. d. e. f. For MedicalTranscriptionJobName, specify a name unique in your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in your audio ﬁle and the language of your vocabulary ﬁlter. In the MediaFileUri parameter of the Media object, specify the name of the audio ﬁle that you want to transcribe. For Specialty, specify the medical specialty of the clinician speaking in the audio ﬁle. For Type, specify DICTATION. For OutputBucketName, specify the Amazon S3 bucket to store the transcription results. The following is an example request that uses the AWS SDK for Python (Boto3) to transcribe a medical dictation of a clinician in the PRIMARYCARE specialty. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe') job_name = "my-first-med-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-audio-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'my-output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'DICTATION' ) while True: status = transcribe.get_medical_transcription_job(MedicalTranscriptionJobName = job_name) Transcribing an audio ﬁle 587 Amazon Transcribe Developer Guide if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) The following example code shows the transcription results of a medical dictation. { "jobName": "dictation-medical-transcription-job", "accountId": "111122223333", "results": { "transcripts": [ { "transcript": "... came for a follow up visit today..." } ], "items": [ { ... "start_time": "4.85", "end_time": "5.12", "alternatives": [ { "confidence": "1.0", "content": "came" } ], "type": "pronunciation" }, { "start_time": "5.12", "end_time": "5.29", "alternatives": [ { "confidence": "1.0", "content": "for" } ], Transcribing an audio ﬁle 588 Amazon Transcribe Developer Guide "type": "pronunciation" }, { "start_time": "5.29", "end_time": "5.33", "alternatives": [ { "confidence": "0.9955", "content": "a" } ], "type": "pronunciation" }, { "start_time": "5.33", "end_time": "5.66", "alternatives": [ { "confidence": "0.9754", "content": "follow" } ], "type": "pronunciation" }, { "start_time": "5.66", "end_time": "5.75", "alternatives": [ { "confidence": "0.9754", "content": "up" } ], "type": "pronunciation" }, { "start_time": "5.75", "end_time": "6.02", "alternatives": [ { "confidence": "1.0", "content": "visit" } ] Transcribing an audio ﬁle 589 Amazon Transcribe ... }, "status": "COMPLETED" } AWS CLI Developer Guide To enable speaker partitioning in a batch transcription job (AWS
transcribe-dg-130	transcribe-dg.pdf	130	ﬁle 588 Amazon Transcribe Developer Guide "type": "pronunciation" }, { "start_time": "5.29", "end_time": "5.33", "alternatives": [ { "confidence": "0.9955", "content": "a" } ], "type": "pronunciation" }, { "start_time": "5.33", "end_time": "5.66", "alternatives": [ { "confidence": "0.9754", "content": "follow" } ], "type": "pronunciation" }, { "start_time": "5.66", "end_time": "5.75", "alternatives": [ { "confidence": "0.9754", "content": "up" } ], "type": "pronunciation" }, { "start_time": "5.75", "end_time": "6.02", "alternatives": [ { "confidence": "1.0", "content": "visit" } ] Transcribing an audio ﬁle 589 Amazon Transcribe ... }, "status": "COMPLETED" } AWS CLI Developer Guide To enable speaker partitioning in a batch transcription job (AWS CLI) • Run the following code. aws transcribe start-medical-transcription-job \ --region us-west-2 \ --cli-input-json file://example-start-command.json The following code shows the contents of example-start-command.json. { "MedicalTranscriptionJobName": "my-first-med-transcription-job", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-audio-file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "OutputKey": "my-output-files/", "LanguageCode": "en-US", "Specialty": "PRIMARYCARE", "Type": "DICTATION" } Transcribing a medical dictation in a real-time stream Use a WebSocket stream to transcribe a medical dictation as an audio stream. You can also use the AWS Management Console to transcribe speech that you or others speak directly into a microphone. Transcribing a streaming medical dictation 590 Amazon Transcribe Developer Guide For an HTTP/2 or a WebSocket stream, you can transcribe audio in the following medical specialties: • Cardiology • Oncology • Neurology • Primary Care • Radiology • Urology Each medical specialty includes many types of procedures and appointments. Clinicians therefore dictate many diﬀerent types of notes. Use the following examples as guidance to help you specify the value of the specialty URI parameter of the WebSocket request, or the Specialty parameter of the StartMedicalStreamTranscription API: • For a dictation after electrophysiology or echocardiogram procedure, choose CARDIOLOGY. • For a dictation after a surgical oncology or radiation oncology procedure, choose ONCOLOGY. • For a physician dictating notes indicating a diagnosis of encephalitis, choose NEUROLOGY. • For a dictation of procedure notes to break up a bladder stone, choose UROLOGY. • For a dictation of clinician notes after an internal medicine consultation, choose PRIMARYCARE. • For a dictation of a physician communicating the ﬁndings of a CT scan, PET scan, MRI, or radiograph, choose RADIOLOGY. • For a dictation of physician notes after a gynecology consultation, choose PRIMARYCARE. To improve transcription accuracy of speciﬁc terms in a real-time stream, use a custom vocabulary. To enable a custom vocabulary, set the value of vocabulary-name to the name of the custom vocabulary you want to use. Transcribing a dictation spoken into your microphone with the AWS Management Console To use the AWS Management Console to transcribe streaming audio of a medical dictation, choose the option to transcribe a medical dictation, start the stream, and begin speaking into the microphone. Transcribing a streaming medical dictation 591 Amazon Transcribe Developer Guide To transcribe streaming audio of a medical dictation (AWS Management Console) 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Real-time transcription. 3. Choose Dictation. 4. For Medical specialty, choose the medical specialty of the clinician speaking in the stream. 5. Choose Start streaming. 6. Speak into the microphone. Transcribing a dictation in an HTTP/2 stream To transcribe an HTTP/2 stream of a medical dictation, use the StartMedicalStreamTranscription API and specify the following: • LanguageCode – The language code. The valid value is en-US • MediaEncoding – The encoding used for the input audio. Valid values are pcm, ogg-opus, and flac. • Specialty – The specialty of the medical professional. • Type – DICTATION For more information on setting up an HTTP/2 stream to transcribe a medical dictation, see Setting up an HTTP/2 stream. Using a WebSocket streaming request to transcribe a medical dictation To transcribe a medical dictation in a real-time stream using a WebSocket request, you create a presigned URI. This URI contains the information needed to set up the audio stream between your application and Amazon Transcribe Medical. For more information on creating WebSocket requests, see Setting up a WebSocket stream. Use the following template to create your presigned URI. GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket ?language-code=languageCode &X-Amz-Algorithm=AWS4-HMAC-SHA256 Transcribing a streaming medical dictation 592 Amazon Transcribe Developer Guide &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &media-encoding=flac &sample-rate=16000 &session-id=sessionId &specialty=medicalSpecialty &type=DICTATION &vocabulary-name=vocabularyName &show-speaker-label=boolean For more information on creating pre-signed URIs, see Setting up a WebSocket stream. Improving transcription accuracy with medical custom vocabularies To improve transcription accuracy in Amazon Transcribe Medical, create and use one or more medical custom vocabularies. A custom vocabulary is a collection of words or phrases that are domain-speciﬁc. This collection helps improve the performance of Amazon Transcribe Medical in transcribing those words or phrases. You are responsible for the integrity of your own data when you use Amazon Transcribe Medical. Do not enter conﬁdential information, personal information (PII), or protected health information (PHI), into a
transcribe-dg-131	transcribe-dg.pdf	131	&type=DICTATION &vocabulary-name=vocabularyName &show-speaker-label=boolean For more information on creating pre-signed URIs, see Setting up a WebSocket stream. Improving transcription accuracy with medical custom vocabularies To improve transcription accuracy in Amazon Transcribe Medical, create and use one or more medical custom vocabularies. A custom vocabulary is a collection of words or phrases that are domain-speciﬁc. This collection helps improve the performance of Amazon Transcribe Medical in transcribing those words or phrases. You are responsible for the integrity of your own data when you use Amazon Transcribe Medical. Do not enter conﬁdential information, personal information (PII), or protected health information (PHI), into a custom vocabulary. For best results, create separate small custom vocabularies that each help transcribe a speciﬁc audio recording. You receive greater improvements in transcription accuracy than if you created one large custom vocabulary to use with all of your recordings. By default, you can have up to 100 custom vocabularies in your AWS account. A custom vocabulary can't exceed 50 KB in size. For information on requesting an increase to the number of custom vocabularies that you can have in your AWS account, see AWS service quotas. Custom vocabularies are available in US English (en-US). Topics Creating and using medical custom vocabularies 593 Amazon Transcribe Developer Guide • Creating a text ﬁle for your medical custom vocabulary • Using a text ﬁle to create a medical custom vocabulary • Transcribing an audio ﬁle using a medical custom vocabulary • Transcribing a real-time stream using a medical custom vocabulary • Character set for Amazon Transcribe Medical Creating a text ﬁle for your medical custom vocabulary To create a custom vocabulary, you create a text ﬁle that is in UTF-8 format. In this ﬁle, you create a four column table, with each column specifying a ﬁeld. Each ﬁeld tells Amazon Transcribe Medical either how the domain-speciﬁc terms are pronounced or how to display these terms in your transcriptions. You store the text ﬁle containing these ﬁelds in an Amazon S3 bucket. Understanding how to format your text ﬁle To create a medical custom vocabulary, you enter the column names as a header row. You enter the values for each column beneath the header row. The following are the names of the four columns of the table: • Phrase – column required, values required • IPA – column required, values can be optional • SoundsLike – column required, values can be optional • DisplayAs – column required, values can be optional When you create a custom vocabulary, make sure that you: • Separate each column with a single Tab character. Amazon Transcribe throws an error message if you try to separate the columns with spaces or multiple Tab characters. • Make sure that there's no trailing spaces or white space after each value within a column. Make sure that the values that you enter for each column: • Have fewer than 256 characters, including hyphens • Use only characters from the allowed character set, see Character set for Amazon Transcribe Medical. Creating a text ﬁle for your medical custom vocabulary 594 Amazon Transcribe Developer Guide Entering values for the columns of the table The following information shows you how to specify values for the four columns of the table: • Phrase – The word or phrase that should be recognized. You must enter values in this column. If the entry is a phrase, separate the words with a hyphen (-). For example, enter cerebral autosomal dominant arteriopathy with subcortical infarcts and leukoencephalopathy as cerebral-autosomal-dominant-arteriopathy-with- subcortical-infarcts-and-leukoencephalopathy. Enter acronyms or other words whose letters should be pronounced individually as single letters followed by dots, such as D.N.A. or S.T.E.M.I.. To enter the plural form of an acronym, such as "STEMIs," separate the "s" from the acronym with a hyphen: "S.T.E.M.I-s" You can use either uppercase or lowercase letters for acronyms. The Phrase column is required. You can use any of the allowed characters for the input language. For allowed characters, see Character set for Amazon Transcribe Medical. If you don't specify the DisplayAs column, Amazon Transcribe Medical uses the contents of the Phrase column in the output ﬁle. • IPA (column required, values can be optional) – To specify the pronunciation of a word or phrase, you can include characters in the International Phonetic Alphabet (IPA) in this column. The IPA column can't contain leading or trailing spaces, and you must use a single space to separate each phoneme in the input. For example, in English you would enter the phrase acute-respiratory-distress-syndrome as ə k j u t # # s p # # ə t # # i d # s t # # s s # n d # o# m. You would enter the phrase A.L.L. as e# # l # l. Even if you don't specify the contents of the IPA
transcribe-dg-132	transcribe-dg.pdf	132	phrase, you can include characters in the International Phonetic Alphabet (IPA) in this column. The IPA column can't contain leading or trailing spaces, and you must use a single space to separate each phoneme in the input. For example, in English you would enter the phrase acute-respiratory-distress-syndrome as ə k j u t # # s p # # ə t # # i d # s t # # s s # n d # o# m. You would enter the phrase A.L.L. as e# # l # l. Even if you don't specify the contents of the IPA column, you must include a blank IPA column. If you include values in the IPA column, you can't provide values for the SoundsLike column. For a list of allowed IPA characters for a speciﬁc language, see Character set for Amazon Transcribe Medical. US English is the only language available in Amazon Transcribe Medical. • SoundsLike (column required, values can be optional) – You can break a word or phrase down into smaller segments and provide a pronunciation for each segment using the standard orthography of the language to mimic the way that the word sounds. For example, you can provide pronunciation hints for the phrase cerebral-autosomal-dominant- arteriopathy-with-subcortical-infarcts-and-leukoencephalopathy like this: Creating a text ﬁle for your medical custom vocabulary 595 Amazon Transcribe Developer Guide sir-e-brul-aut-o-som-ul-dah-mi-nant-ar-ter-ri-o-pa-thy-with-sub-cor- ti-cul-in-farcts-and-lewk-o-en-ce-phul-ah-pu-thy. The hint for the phrase atrioventricular-nodal-reentrant-tachycardia would look like this: ay-tree-o- ven-trick-u-lar-node-al-re-entr-ant-tack-ih-card-ia. You separate each part of the hint with a hyphen (-). Even if you don't provide values for the SoundsLike column, you must include a blank SoundsLike column. If you include values in the SoundsLike column, you can't provide values for the IPA column. You can use any of the allowed characters for the input language. For the list of allowed characters, see Character set for Amazon Transcribe Medical. • DisplayAs (column required, values can be optional) – Deﬁnes how the word or phrase looks when it's output. For example, if the word or phrase is cerebral-autosomal-dominant- arteriopathy-with-subcortical-infarcts-and-leukoencephalopathy, you can specify the display form as cerebral autosomal dominant arteriopathy with subcortical infarcts and leukoencephalopathy, so that the hyphen is not present. You can also specify DisplayAs as CADASIL if you'd like to show the acronym instead of the full term in the output. If you don't specify the DisplayAs column, Amazon Transcribe Medical uses the Phrase column from the input ﬁle in the output. You can use any UTF-8 character in the DisplayAs column. You can include spaces only for the values in the IPA and DisplayAs columns. To create the text ﬁle of your custom vocabulary, place each word or phrase in your text ﬁle on a separate line. Separate the columns with Tab characters. Include spaces only for values in the IPA and DisplayAs columns. Save the ﬁle with the extension .txt in an Amazon S3 bucket in the same AWS Region where you use Amazon Transcribe Medical to create your custom vocabulary. If you edit your text ﬁle in Windows, make sure that your ﬁle is in LF format and not in CRLF format. Otherwise, you will be unable to create your custom vocabulary. Some text editors enable you to change the formatting with Find and Replace commands. Creating a text ﬁle for your medical custom vocabulary 596 Amazon Transcribe Developer Guide The following examples show text that you can use to create custom vocabularies. To create a custom vocabulary from these examples, copy an example into a text editor, replace [TAB] with a Tab character, and upload the saved text ﬁle to Amazon S3. Phrase[TAB]IPA[TAB]SoundsLike[TAB]DisplayAs acute-respiratory-distress-syndrome[TAB][TAB][TAB]acute respiratory distress syndrome A.L.L.[TAB]e# # l # l[TAB][TAB]ALL atrioventricular-nodal-reentrant-tachycardia[TAB][TAB]ay-tree-o-ven-trick-u-lar-node- al-re-entr-ant-tack-ih-card-ia[TAB] You can enter columns in any order. The following examples show other valid structures for the custom vocabulary input ﬁle. Phrase[TAB]SoundsLike[TAB]IPA[TAB]DisplayAs acute-respiratory-distress-syndrome[TAB][TAB][TAB]acute respiratory distress syndrome A.L.L.[TAB][TAB]e# # l # l[TAB]ALL atrioventricular-nodal-reentrant-tachycardia[TAB]ay-tree-o-ven-trick-u-lar-node-al-re- entr-ant-tack-ih-card-ia[TAB][TAB] DisplayAs[TAB]SoundsLike[TAB]IPA[TAB]Phrase acute respiratory distress syndrome[TAB][TAB][TAB]acute-respiratory-distress-syndrome ALL[TAB][TAB]e# # l # l[TAB]A.L.L. [TAB]ay-tree-o-ven-trick-u-lar-node-al-re-entr-ant-tack-ih-card-ia[TAB] [TAB]atrioventricular-nodal-reentrant-tachycardia For reading ease, the following tables show the preceding examples more clearly in html format. They are meant only to illustrate the examples. Phrase IPA SoundsLike DisplayAs acute-respiratory- distress-syndrome A.L.L. eɪ ɛ l ɛ l acute respiratory distress syndrome ALL Creating a text ﬁle for your medical custom vocabulary 597 Amazon Transcribe Developer Guide Phrase IPA SoundsLike DisplayAs atrioventricular-n odal-reentrant-tac hycardia ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia Phrase SoundsLike IPA DisplayAs acute-respiratory- distress-syndrome atrioventricular-n odal-reentrant-tac hycardia A.L.L. ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia acute respiratory distress syndrome eɪ ɛ l ɛ l ALL DisplayAs SoundsLike IPA Phrase acute respiratory distress syndrome ALL acute-respiratory- distress-syndrome eɪ ɛ l ɛ l A.L.L. ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia atrioventricular-n odal-reentrant-tac hycardia Using a text ﬁle to create a medical custom vocabulary To create a custom vocabulary, you must have prepared a text ﬁle that contains a collection a words or phrases. Amazon Transcribe Medical uses this text ﬁle to create
transcribe-dg-133	transcribe-dg.pdf	133	597 Amazon Transcribe Developer Guide Phrase IPA SoundsLike DisplayAs atrioventricular-n odal-reentrant-tac hycardia ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia Phrase SoundsLike IPA DisplayAs acute-respiratory- distress-syndrome atrioventricular-n odal-reentrant-tac hycardia A.L.L. ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia acute respiratory distress syndrome eɪ ɛ l ɛ l ALL DisplayAs SoundsLike IPA Phrase acute respiratory distress syndrome ALL acute-respiratory- distress-syndrome eɪ ɛ l ɛ l A.L.L. ay-tree-o-ven-trick-u- lar-node-al-re-entr- ant-tack-ih-card-ia atrioventricular-n odal-reentrant-tac hycardia Using a text ﬁle to create a medical custom vocabulary To create a custom vocabulary, you must have prepared a text ﬁle that contains a collection a words or phrases. Amazon Transcribe Medical uses this text ﬁle to create a custom vocabulary that you can use to improve the transcription accuracy of those words or phrases. You can create a custom vocabulary using the CreateMedicalVocabulary API or the Amazon Transcribe Medical console. Using a text ﬁle to create a medical custom vocabulary 598 Amazon Transcribe AWS Management Console Developer Guide To use the AWS Management Console to create a custom vocabulary, you provide the Amazon S3 URI of the text ﬁle containing your words or phrases. 1. 2. 3. 4. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Custom vocabulary. For Name, under Vocabulary settings, choose a name for your custom vocabulary. Specify the location of your audio ﬁle or video ﬁle in Amazon S3: • • For Vocabulary input ﬁle location on S3 under Vocabulary settings, specify the Amazon S3 URI that identiﬁes the text ﬁle you will use to create your custom vocabulary. For Vocabulary input ﬁle location in S3, choose Browse S3 to browse for the text ﬁle and choose it. 5. Choose Create vocabulary. You can see the processing status of your custom vocabulary in the AWS Management Console. API To create a medical custom vocabulary (API) • For the StartTranscriptionJob API, specify the following. a. b. c. For LanguageCode, specify en-US. For VocabularyFileUri, specify the Amazon S3 location of the text ﬁle that you use to deﬁne your custom vocabulary. For VocabularyName, specify a name for your custom vocabulary. The name you specify must be unique within your AWS account. To see the processing status of your custom vocabulary, use the GetMedicalVocabulary API. The following is an example request using the AWS SDK for Python (Boto3) to create a custom vocabulary. from __future__ import print_function import time Using a text ﬁle to create a medical custom vocabulary 599 Amazon Transcribe import boto3 transcribe = boto3.client('transcribe', 'us-west-2') vocab_name = "my-first-vocabulary" response = transcribe.create_medical_vocabulary( VocabularyName = job_name, Developer Guide VocabularyFileUri = 's3://amzn-s3-demo-bucket/my-vocabularies/my-vocabulary- table.txt' LanguageCode = 'en-US', ) while True: status = transcribe.get_medical_vocabulary(VocabularyName = vocab_name) if status['VocabularyState'] in ['READY', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) AWS CLI To enable speaker partitioning in a batch transcription job (AWS CLI) • Run the following code. aws transcribe create-medical-vocabulary \ --vocabulary-name my-first-vocabulary \ --vocabulary-file-uri s3://amzn-s3-demo-bucket/my-vocabularies/my-vocabulary- file.txt \ --language-code en-US Transcribing an audio ﬁle using a medical custom vocabulary Use the StartMedicalTranscriptionJob or the AWS Management Console to start a transcription job that uses a custom vocabulary to improve transcription accuracy. AWS Management Console 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. Transcribing an audio ﬁle using a medical custom vocabulary 600 Amazon Transcribe Developer Guide 4. On the Specify job details page, provide information about your transcription job. 5. Choose Next. 6. Under Customization, enable Custom vocabulary. 7. Under Vocabulary selection, choose a custom vocabulary. 8. Choose Create. API To enable speaker partitioning in an audio ﬁle using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. c. d. e. f. g. For MedicalTranscriptionJobName, specify a name that is unique in your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in your audio ﬁle and the language of your vocabulary ﬁlter. For the MediaFileUri parameter of the Media object, specify the name of the audio ﬁle that you want to transcribe. For Specialty, specify the medical specialty of the clinician speaking in the audio ﬁle. For Type, specify whether the audio ﬁle is a conversation or a dictation. For OutputBucketName, specify the Amazon S3 bucket to store the transcription results. For the Settings object, specify the following. • VocabularyName – the name of your custom vocabulary. The following request uses the AWS SDK for Python (Boto3) to start a batch transcription job with a custom vocabulary. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-med-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Transcribing an audio ﬁle using a medical custom vocabulary 601 Developer Guide Amazon Transcribe Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'my-output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION',
transcribe-dg-134	transcribe-dg.pdf	134	S3 bucket to store the transcription results. For the Settings object, specify the following. • VocabularyName – the name of your custom vocabulary. The following request uses the AWS SDK for Python (Boto3) to start a batch transcription job with a custom vocabulary. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-med-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Transcribing an audio ﬁle using a medical custom vocabulary 601 Developer Guide Amazon Transcribe Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'my-output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION', Settings = { 'VocabularyName': 'example-med-custom-vocab' } ) while True: status = transcribe.get_medical_transcription_job(MedicalTranscriptionJobName = job_name) if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) Transcribing a real-time stream using a medical custom vocabulary To improve transcription accuracy in a real-time stream, you can use a custom vocabulary using either HTTP/2 or WebSocket streams. To start an HTTP/2 request, use the StartMedicalStreamTranscription API. You can use a custom vocabulary in real-time using either the AWS Management Console, the StartMedicalStreamTranscription API, or by using the WebSocket protocol. Transcribing a dictation that is spoken into your Microphone (AWS Management Console) To use the AWS Management Console to transcribe streaming audio of a medical dictation, choose the option to transcribe a medical dictation, start the stream, and begin speaking into the microphone. To transcribe streaming audio of a medical dictation (AWS Management Console) 1. Sign in to the AWS Management Console. Transcribing a real-time stream using a medical custom vocabulary 602 Amazon Transcribe Developer Guide 2. 3. 4. 5. In the navigation pane, under Amazon Transcribe Medical, choose Real-time transcription. For Medical specialty, choose the medical specialty of the clinician speaking in the stream. For Audio input type, choose either Conversation or Dictation. For Additional settings, choose Custom vocabulary. • For Vocabulary selection, choose the custom vocabulary. 6. Choose Start streaming. 7. Speak into the microphone. Enabling speaker partitioning in an HTTP/2 stream The following is the syntax for the parameters of an HTTP/2 request. POST /medical-stream-transcription HTTP/2 host: transcribestreaming.us-west-2.amazonaws.com authorization: Generated value x-amz-target: com.amazonaws.transcribe.Transcribe.StartMedicalStreamTranscription x-amz-content-sha256: STREAMING-MED-AWS4-HMAC-SHA256-EVENTS x-amz-date: 20220208T235959Z x-amzn-transcribe-session-id: my-first-http2-med-stream x-amzn-transcribe-language-code: en-US x-amzn-transcribe-media-encoding: flac x-amzn-transcribe-sample-rate: 16000 x-amzn-transcribe-vocabulary-name: my-first-med-vocab x-amzn-transcribe-specialty: PRIMARYCARE x-amzn-transcribe-type: CONVERSATION x-amzn-transcribe-show-speaker-label: true Content-type: application/vnd.amazon.eventstream transfer-encoding: chunked Parameter descriptions: • host: Update the AWS Region ('us-west-2' in the preceding example) with the AWS Region you are calling. For a list of valid AWS Regions, see AWS Regions and Endpoints. • authorization: This is a generated ﬁeld. To learn more about creating a signature, see Signing AWS requests with Signature Version 4. • x-amz-target: Don't alter this ﬁeld; use the content shown in the preceding example. Transcribing a real-time stream using a medical custom vocabulary 603 Amazon Transcribe Developer Guide • x-amz-content-sha256: This is a generated ﬁeld. To learn more about calculating a signature, see Signing AWS requests with Signature Version 4. • x-amz-date: The date and time the signature is created. The format is YYYYMMDDTHHMMSSZ, where YYYY=year, MM=month, DD=day, HH=hour, MM=minute, SS=seconds, and 'T' and 'Z' are ﬁxed characters. For more information, refer to Handling Dates in Signature Version 4. • x-amzn-transcribe-session-id: The name for your streaming session. • x-amzn-transcribe-language-code: The encoding used for your input audio. Refer to StartMedicalStreamTranscription or Supported languages and language-speciﬁc features for a list of valid values. • x-amzn-transcribe-media-encoding: The encoding used for your input audio. Valid values are pcm, ogg-opus, and flac. • x-amzn-transcribe-sample-rate: The sample rate of the input audio (in Hertz). Amazon Transcribe supports a range from 8,000 Hz to 48,000 Hz. Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. • x-amzn-transcribe-vocabulary-name: The name of the vocabulary you want to use with your transcription. • x-amzn-transcribe-specialty: The medical specialty being transcribed. • x-amzn-transcribe-type: Choose whether this is a dictation or a conversation. • x-amzn-transcribe-show-speaker-label: To enable diarization, this value must be true. • content-type: Don't alter this ﬁeld; use the content shown in the preceding example. Enabling speaker partitioning in a WebSocket request To partition speakers in WebSocket streams with the API, use the following format to create a pre- signed URI to start a WebSocket request and set vocabulary-name to the name of the custom vocabulary. GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket ?language-code=en-US &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 Transcribing a real-time stream using a medical custom vocabulary 604 Amazon Transcribe Developer Guide &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &media-encoding=flac &sample-rate=16000 &session-id=sessionId &specialty=medicalSpecialty &type=CONVERSATION &vocabulary-name=vocabularyName &show-speaker-label=boolean Character set for Amazon Transcribe Medical To use custom vocabularies in Amazon Transcribe Medical, use the following character set. English character set For English custom vocabularies, you can use the following characters in the Phrase and SoundsLike columns: • a - z • A
transcribe-dg-135	transcribe-dg.pdf	135	create a pre- signed URI to start a WebSocket request and set vocabulary-name to the name of the custom vocabulary. GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket ?language-code=en-US &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 Transcribing a real-time stream using a medical custom vocabulary 604 Amazon Transcribe Developer Guide &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &media-encoding=flac &sample-rate=16000 &session-id=sessionId &specialty=medicalSpecialty &type=CONVERSATION &vocabulary-name=vocabularyName &show-speaker-label=boolean Character set for Amazon Transcribe Medical To use custom vocabularies in Amazon Transcribe Medical, use the following character set. English character set For English custom vocabularies, you can use the following characters in the Phrase and SoundsLike columns: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can use the following International Phonetic Alphabet (IPA) characters in the IPA column of the vocabulary input ﬁle. Character Code Character aʊ aɪ b d 0061 028A 0061 026A 0062 0064 w z æ ð Code 0077 007A 00E6 00F0 Character set for Amazon Transcribe Medical 605 Amazon Transcribe Developer Guide Character Code Character eɪ f g h i j k l l̩ m n n̩ oʊ p s t u v 0065 026A 0066 0067 0068 0069 006A 006B 006C 006C 0329 006D 006E 006E 0329 006F 028A 0070 0073 0074 0075 0076 ŋ ɑ ɔ ɔɪ ə ɛ ɝ ɡ ɪ ɹ ʃ ʊ ʌ ʍ ʒ ʤ ʧ θ Code 014B 0251 0254 0254 026A 0259 025B 025D 0261 026A 0279 0283 028A 028C 028D 0292 02A4 02A7 03B8 Character set for Amazon Transcribe Medical 606 Amazon Transcribe Developer Guide Identifying personal health information (PHI) in a transcription Use Personal Health Information Identiﬁcation to label personal health information (PHI) in your transcription results. By reviewing labels, you can ﬁnd PHI that could be used to identify a patient. You can identify PHI using either a real-time stream or batch transcription job. You can use your own post-processing to redact the PHI identiﬁed in the transcription output. Use Personal Health Information Identiﬁcation to identify the following types of PHI: • Personal PHI: • Names – Full name or last name and initial • Gender • Age • Phone numbers • Dates (not including the year) that directly relate to the patient • Email addresses • Geographic PHI: • Physical address • Zip code • Name of medical center or practice • Account PHI: • Fax numbers • Social security numbers (SSNs) • Health insurance beneﬁciary numbers • Account numbers • Certiﬁcate or license numbers • Vehicle PHI: • Vehicle identiﬁcation number (VIN) • License plate number • Other PHI: • Web Uniform Resource Location (URL) • Internet Protocol (IP) address numbers Identifying PHI in a transcript 607 Amazon Transcribe Developer Guide Amazon Transcribe Medical is a Health Insurance Portability and Accountability Act of 1996 (HIPAA) eligible service. For more information, see Amazon Transcribe Medical. For information about identifying PHI in an audio ﬁle, see Identifying PHI in an audio ﬁle. For information about identifying PHI in a stream, see Identifying PHI in a real-time stream. Topics • Identifying PHI in an audio ﬁle • Identifying PHI in a real-time stream Identifying PHI in an audio ﬁle Use a batch transcription job to transcribe audio ﬁles and identify the personal health information (PHI) within them. When you activate Personal Health Information (PHI) Identiﬁcation, Amazon Transcribe Medical labels the PHI that it identiﬁed in the transcription results. For information about the PHI that Amazon Transcribe Medical can identify, see Identifying personal health information (PHI) in a transcription. You can start a batch transcription job using either the StartMedicalTranscriptionJob API or the AWS Management Console. AWS Management Console To use the AWS Management Console to transcribe a clinician-patient dialogue, create a transcription job and choose Conversation for Audio input type. To transcribe an audio ﬁle and identify its PHI (AWS Management Console) 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. 4. On the Specify job details page, under Job settings , specify the following. a. Name – The name of the transcription job that is unique to your AWS account. b. Audio input type – Conversation or Dictation. 5. For the remaining ﬁelds, specify the Amazon S3 location of your audio ﬁle and where you want to store the output of your transcription job. 6. Choose Next. Identifying PHI in an audio ﬁle 608 Amazon Transcribe Developer Guide 7. Under Audio settings, choose PHI Identiﬁcation. 8. Choose Create. API To transcribe an audio ﬁle and identify its PHI using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. c. d. e. f. For MedicalTranscriptionJobName, specify a name that is unique to your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in
transcribe-dg-136	transcribe-dg.pdf	136	specify the Amazon S3 location of your audio ﬁle and where you want to store the output of your transcription job. 6. Choose Next. Identifying PHI in an audio ﬁle 608 Amazon Transcribe Developer Guide 7. Under Audio settings, choose PHI Identiﬁcation. 8. Choose Create. API To transcribe an audio ﬁle and identify its PHI using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. c. d. e. f. For MedicalTranscriptionJobName, specify a name that is unique to your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in your audio ﬁle. For the MediaFileUri parameter of the Media object, specify the name of the audio ﬁle that you want to transcribe. For Specialty, specify the medical specialty of the clinician speaking in the audio ﬁle as PRIMARYCARE. For Type, specify either CONVERSATION or DICTATION. For OutputBucketName, specify the Amazon S3 bucket where you want to store the transcription results. The following is an example request that uses the AWS SDK for Python (Boto3) to transcribe an audio ﬁle and identify the PHI of a patient. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe') job_name = "my-first-transcription-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-audio-file.flac" transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media = {'MediaFileUri': job_uri}, LanguageCode = 'en-US', ContentIdentificationType = 'PHI', Specialty = 'PRIMARYCARE', Identifying PHI in an audio ﬁle 609 Amazon Transcribe Developer Guide Type = 'type', # Specify 'CONVERSATION' for a medical conversation. Specify 'DICTATION' for a medical dictation. OutputBucketName = 'amzn-s3-demo-bucket' ) while True: status = transcribe.get_medical_transcription_job(MedicalTranscriptionJobName = job_name) if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) The following example code shows the transcription results with patient PHI identiﬁed. { "jobName": "my-medical-transcription-job-name", "accountId": "111122223333", "results": { "transcripts": [{ "transcript": "The patient's name is Bertrand." }], "items": [{ "id": 0, "start_time": "0.0", "end_time": "0.37", "alternatives": [{ "confidence": "0.9993", "content": "The" }], "type": "pronunciation" }, { "id": 1, "start_time": "0.37", "end_time": "0.44", "alternatives": [{ "confidence": "0.9981", "content": "patient's" }], Identifying PHI in an audio ﬁle 610 Amazon Transcribe Developer Guide "type": "pronunciation" }, { "id": 2, "start_time": "0.44", "end_time": "0.52", "alternatives": [{ "confidence": "1.0", "content": "name" }], "type": "pronunciation" }, { "id": 3, "start_time": "0.52", "end_time": "0.92", "alternatives": [{ "confidence": "1.0", "content": "is" }], "type": "pronunciation" }, { "id": 4, "start_time": "0.92", "end_time": "0.9989", "alternatives": [{ "confidence": "1.0", "content": "Bertrand" }], "type": "pronunciation" }, { "id": 5, "alternatives": [{ "confidence": "0.0", "content": "." }], "type": "punctuation" }], "entities": [{ "content": "Bertrand", "category": "PHI-Personal", "startTime": 0.92, "endTime": 1.2, "confidence": 0.9989 }], "audio_segments": [ Identifying PHI in an audio ﬁle 611 Amazon Transcribe { "id": 0, "transcript": "The patient's name is Bertrand.", "start_time": "0.0", "end_time": "0.9989", "items": [ Developer Guide 0, 1, 2, 3, 4, 5 ] } ] }, "status": "COMPLETED" } AWS CLI To transcribe an audio ﬁle and identify PHI using a batch transcription job (AWS CLI) • Run the following code. aws transcribe start-medical-transcription-job \ --medical-transcription-job-name my-medical-transcription-job-name\ --language-code en-US \ --media MediaFileUri="s3://amzn-s3-demo-bucket/my-input-files/my-audio-file.flac" \ --output-bucket-name amzn-s3-demo-bucket \ --specialty PRIMARYCARE \ --type type \ # Choose CONVERSATION to transcribe a medical conversation. Choose DICTATION to transcribe a medical dictation. --content-identification-type PHI Identifying PHI in an audio ﬁle 612 Amazon Transcribe Developer Guide Identifying PHI in a real-time stream You can identify Personal Health Information (PHI) in either HTTP/2 or WebSocket streams. When you activate PHI Identiﬁcation, Amazon Transcribe Medical labels the PHI that it identiﬁes in the transcription results. For information about the PHI that Amazon Transcribe Medical can identify, see Identifying personal health information (PHI) in a transcription. Identifying PHI in a dictation that is spoken into your microphone To use the AWS Management Console to transcribe the speech picked up by your microphone and identify any PHI, choose Dictation as the audio input type, start the stream, and begin speaking into the microphone on your computer. To identify PHI in a dictation using the AWS Management Console 1. 2. 3. 4. Sign in to the AWS Management Console. In the navigation pane, choose Real-time transcription. For Audio input type, choose Dictation. For Additional settings, choose PHI identiﬁcation. 5. Choose Start streaming and speak into the microphone. 6. Choose Stop streaming to end the dictation. Identifying PHI in an HTTP/2 stream To start an HTTP/2 stream with PHI Identiﬁcation activated, use the StartMedicalStreamTranscription API and specify the following: • For LanguageCode, specify the language code for the language spoken in the stream. For US English, specify en-US. • For MediaSampleHertz, specify the sample rate of the audio. • For content-identification-type, specify PHI. Identifying PHI in a WebSocket stream To a start a WebSocket stream with PHI Identiﬁcation activated, use the following format to create a presigned URL. Identifying PHI in a real-time stream 613 Amazon Transcribe Developer Guide GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket? &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature
transcribe-dg-137	transcribe-dg.pdf	137	an HTTP/2 stream To start an HTTP/2 stream with PHI Identiﬁcation activated, use the StartMedicalStreamTranscription API and specify the following: • For LanguageCode, specify the language code for the language spoken in the stream. For US English, specify en-US. • For MediaSampleHertz, specify the sample rate of the audio. • For content-identification-type, specify PHI. Identifying PHI in a WebSocket stream To a start a WebSocket stream with PHI Identiﬁcation activated, use the following format to create a presigned URL. Identifying PHI in a real-time stream 613 Amazon Transcribe Developer Guide GET wss://transcribestreaming.us-west-2.amazonaws.com:8443/medical-stream- transcription-websocket? &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20220208%2Fus- west-2%2Ftranscribe%2Faws4_request &X-Amz-Date=20220208T235959Z &X-Amz-Expires=300 &X-Amz-Security-Token=security-token &X-Amz-Signature=Signature Version 4 signature &X-Amz-SignedHeaders=host &language-code=en-US &media-encoding=flac &sample-rate=16000 &specialty=medical-specialty &content-identification-type=PHI Parameter deﬁnitions can be found in the API Reference; parameters common to all AWS API operations are listed in the Common Parameters section. Generating alternative transcriptions When you use Amazon Transcribe Medical, you get the transcription that has the highest conﬁdence level. However, you can conﬁgure Amazon Transcribe Medical to return additional transcriptions with lower conﬁdence levels. Use alternative transcriptions to see diﬀerent interpretations of the transcribed audio. For example, in an application that enables a person to review the transcription, you can present the alternative transcriptions for the person to choose from. You can generate alternative transcriptions with the AWS Management Console or the StartMedicalTranscriptionJob API. AWS Management Console To use the AWS Management Console to generate alternative transcriptions, you enable alternative results when you conﬁgure your job. 1. 2. Sign in to the AWS Management Console. In the navigation pane, under Amazon Transcribe Medical, choose Transcription jobs. 3. Choose Create job. Generating alternative transcriptions 614 Amazon Transcribe Developer Guide 4. On the Specify job details page, provide information about your transcription job. 5. Choose Next. 6. 7. Enable Alternative results. For Maximum alternatives, enter an integer value between 2 and 10, for the maximum number of alternative transcriptions you want in the output. 8. Choose Create. API To separate text per speaker in an audio ﬁle using a batch transcription job (API) • For the StartMedicalTranscriptionJob API, specify the following. a. b. c. d. e. f. g. For MedicalTranscriptionJobName, specify a name that is unique in your AWS account. For LanguageCode, specify the language code that corresponds to the language spoken in your audio ﬁle and the language of your vocabulary ﬁlter. In the MediaFileUri parameter of the Media object, specify the location of the audio ﬁle you want to transcribe. For Specialty, specify the medical specialty of the clinician speaking in the audio ﬁle. For Type, specify whether you're transcribing a medical conversation or a dictation. For OutputBucketName, specify the Amazon S3 bucket to store the transcription results. For the Settings object, specify the following. i. ii. ShowAlternatives – true. MaxAlternatives - An integer between 2 and 10 to indicate the number of alternative transcriptions you want in the transcription output. The following request uses the AWS SDK for Python (Boto3) to start a transcription job that generates up to two alternative transcriptions. from __future__ import print_function import time import boto3 transcribe = boto3.client('transcribe', 'us-west-2') Generating alternative transcriptions 615 Amazon Transcribe Developer Guide job_name = "my-first-transcription-job" job_uri = s3://amzn-s3-demo-bucket/my-input-files/my-audio-file.flac transcribe.start_medical_transcription_job( MedicalTranscriptionJobName = job_name, Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', OutputKey = 'my-output-files/', LanguageCode = 'en-US', Specialty = 'PRIMARYCARE', Type = 'CONVERSATION', Settings = { 'ShowAlternatives': True, 'MaxAlternatives': 2 } ) while True: status = transcribe.get_medical_transcription_job(MedicalTranscriptionJobName = job_name) if status['MedicalTranscriptionJob']['TranscriptionJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) AWS CLI To transcribe an audio ﬁle of a conversation between a primary care clinician and a patient in an audio ﬁle (AWS CLI) • Run the following code. aws transcribe start-transcription-job \ --cli-input-json file://filepath/example-start-command.json Generating alternative transcriptions 616 Amazon Transcribe Developer Guide The following code shows the contents of example-start-command.json. { "MedicalTranscriptionJobName": "my-first-transcription-job", "LanguageCode": "en-US", "Specialty": "PRIMARYCARE", "Type": "CONVERSATION", "OutputBucketName":"amzn-s3-demo-bucket", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-audio- file.flac" }, "Settings":{ "ShowAlternatives": true, "MaxAlternatives": 2 } } Amazon Transcribe Medical and interface VPC endpoints (AWS PrivateLink) You can establish a private connection between your VPC and Amazon Transcribe Medical by creating an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLink, a technology that enables you to privately access Amazon Transcribe Medical APIs without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with Amazon Transcribe Medical APIs. Traﬃc between your VPC and Amazon Transcribe Medical does not leave the Amazon network. Each interface endpoint is represented by one or more Elastic Network Interfaces in your subnets. For more information, see Interface VPC endpoints (AWS PrivateLink) in the Amazon VPC User Guide. Considerations for Amazon Transcribe Medical VPC endpoints Before you set up an interface VPC endpoint for Amazon Transcribe Medical, ensure that you review Interface endpoint properties and limitations in the Amazon VPC User
transcribe-dg-138	transcribe-dg.pdf	138	VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with Amazon Transcribe Medical APIs. Traﬃc between your VPC and Amazon Transcribe Medical does not leave the Amazon network. Each interface endpoint is represented by one or more Elastic Network Interfaces in your subnets. For more information, see Interface VPC endpoints (AWS PrivateLink) in the Amazon VPC User Guide. Considerations for Amazon Transcribe Medical VPC endpoints Before you set up an interface VPC endpoint for Amazon Transcribe Medical, ensure that you review Interface endpoint properties and limitations in the Amazon VPC User Guide. VPC endpoints (AWS PrivateLink) 617 Amazon Transcribe Developer Guide Amazon Transcribe Medical supports making calls to all of its API actions from your VPC. Creating an interface VPC endpoint for Amazon Transcribe Medical You can create a VPC endpoint for the Amazon Transcribe Medical service using either the AWS Management Console or the AWS CLI. For more information, see Creating an interface endpoint in the Amazon VPC User Guide. For batch transcription in Amazon Transcribe Medical, create a VPC endpoint using the following service name: • com.amazonaws.us-west-2.transcribe For streaming transcription in Amazon Transcribe Medical, create a VPC endpoint using the following service name: • com.amazonaws.us-west-2.transcribestreaming If you enable private DNS for the endpoint, you can make API requests to Amazon Transcribe Medical using its default DNS name for the AWS Region, for example, transcribestreaming.us-east-2.amazonaws.com. For more information, see Accessing a service through an interface endpoint in the Amazon VPC User Guide. Creating a VPC endpoint policy for Amazon Transcribe Medical streaming You can attach an endpoint policy to your VPC endpoint that controls access to Amazon Transcribe Medical. The policy speciﬁes the following information: • The principal that can perform actions. • The actions that can be performed. • The resources on which actions can be performed. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Creating an interface VPC endpoint for Amazon Transcribe Medical 618 Amazon Transcribe Developer Guide Example: VPC endpoint policy for Amazon Transcribe Medical streaming transcription actions The following is an example of an endpoint policy for streaming transcription in Amazon Transcribe Medical. When attached to an endpoint, this policy grants access to the listed Amazon Transcribe Medical actions for all principals on all resources. { "Statement":[ { "Principal":"", "Effect":"Allow", "Action":[ "transcribe:StartMedicalStreamTranscription", ], "Resource":"" } ] } Example: VPC endpoint policy for Amazon Transcribe Medical batch transcription actions The following is an example of an endpoint policy for batch transcription in Amazon Transcribe Medical. When attached to an endpoint, this policy grants access to the listed Amazon Transcribe Medical actions for all principals on all resources. { "Statement":[ { "Principal":"", "Effect":"Allow", "Action":[ "transcribe:StartMedicalTranscriptionJob" ], "Resource":"" } ] } Shared subnets You cannot create, describe, modify, or delete VPC endpoints in subnets that are shared with you. However, you can use the VPC endpoints in subnets that are shared with you. For information Shared subnets 619 Amazon Transcribe Developer Guide about VPC sharing, see Share your VPC with other accounts in the Amazon Virtual Private Cloud guide. Shared subnets 620 Amazon Transcribe Developer Guide AWS HealthScribe AWS HealthScribe is a HIPAA-eligible machine learning (ML) capability that combines speech recognition and generative AI to transcribe patient-clinician conversations and generate easy- to-review clinical notes. AWS HealthScribe helps healthcare software vendors build clinical applications that reduce the documentation burden and improve consultation experience. The service automatically provides rich conversation transcripts, identiﬁes speaker roles, classiﬁes dialogues, extracts medical terms, and generates preliminary clinical notes. AWS HealthScribe combines these capabilities to remove the need to integrate and optimize separate AI services, enabling you to expedite implementation. Common use cases: • Reduce documentation time — Enable clinicians to quickly complete clinical documentation with AI-generated clinical notes that are easy to review, adjust, and ﬁnalize in your application. • Boost medical scribe eﬃciency — Equip medical scribes with AI-generated transcript and clinical notes, along with the consultation audio, to expedite documentation turn-around time. • Eﬃcient patient visit recap — Create an experience that enables users to quickly recollect key highlights of their conversation in your application. Important The results produced by AWS HealthScribe are probabilistic and may not always be accurate due to various factors, including audio quality, background noise, speaker clarity, the complexity of medical terminology, context-speciﬁc language nuances, and the nature of machine learning and generative AI. AWS HealthScribe is designed to be used in an assistive role for clinicians and medical scribes. AWS HealthScribe output should only be used in patient care scenarios, including, but not limited to as part of Electronic Health Records, after review for accuracy and imposition of sound medical judgment by trained medical professionals. AWS HealthScribe output is not a substitute for professional medical advice, diagnosis, or treatment,
transcribe-dg-139	transcribe-dg.pdf	139	and may not always be accurate due to various factors, including audio quality, background noise, speaker clarity, the complexity of medical terminology, context-speciﬁc language nuances, and the nature of machine learning and generative AI. AWS HealthScribe is designed to be used in an assistive role for clinicians and medical scribes. AWS HealthScribe output should only be used in patient care scenarios, including, but not limited to as part of Electronic Health Records, after review for accuracy and imposition of sound medical judgment by trained medical professionals. AWS HealthScribe output is not a substitute for professional medical advice, diagnosis, or treatment, and is not intended to cure, treat, mitigate, prevent, or diagnose any disease or health condition. Topics • Security 621 Developer Guide Amazon Transcribe • Service availability • Technical requirements • Supported Medical Specialties • Workﬂows • AWS HealthScribe Transcript ﬁle • AWS HealthScribe Clinical Documentation ﬁle • AWS HealthScribe transcription jobs • AWS HealthScribe streaming • Data Encryption at rest for AWS HealthScribe Security AWS HealthScribe operates under a shared responsibility model, whereby AWS is responsible for protecting the infrastructure that runs AWS HealthScribe and you are responsible for managing your data. For more information, see Shared Responsibility Model. By default, AWS HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. When you create AWS HealthScribe transcription job or start a stream, you can specify a customer managed key. This adds a second layer of encryption. For more information, see Data Encryption at rest for AWS HealthScribe. Service availability AWS HealthScribe is available in the US East (N. Virginia) region. Technical requirements • Supported Language: US English (en-US) • Recommended Audio Format: Lossless audio (such as FLAC or WAV) • Encoding: PCM 16-bit • Sample Rate: 16,000 Hz or higher Security 622 Amazon Transcribe Developer Guide Supported Medical Specialties AWS HealthScribe currently supports the following specialties: • General Medicine • Orthopedics Workﬂows AWS HealthScribe workﬂows include transcription jobs and streaming. After you run a transcription job or complete a stream, AWS HealthScribe generates a transcript ﬁle, with turn-by-turn transcription output and insights for each conversation turn. Also it generates a clinical documentation ﬁle, with summaries and evidence links. For more information see AWS HealthScribe Transcript ﬁle and AWS HealthScribe Clinical Documentation ﬁle. • Transcription jobs – With transcription jobs, AWS HealthScribe analyzes completed medical consultation media ﬁles from an Amazon S3 bucket. The following are API operations speciﬁc to AWS HealthScribe transcription jobs. • StartMedicalScribeJob • ListMedicalScribeJobs • GetMedicalScribeJob • DeleteMedicalScribeJob For more information, including code examples, see AWS HealthScribe transcription jobs. • Streaming – AWS HealthScribe streaming is a real-time HTTP2 based bi-directional service that accepts audio stream on one channel and vends an audio transcription on the other channel. The following are API operations speciﬁc to AWS HealthScribe streaming: • StartMedicalScribeStream • GetMedicalScribeStream For more information, including code examples, see AWS HealthScribe streaming. Supported Medical Specialties 623 Amazon Transcribe Developer Guide AWS HealthScribe Transcript ﬁle In the transcript ﬁle, in addition to standard turn-by-turn transcription output with word level timestamps, AWS HealthScribe provides you with: • Participant role detection so you can distinguish the patients from the clinicians in the conversation transcript. • Transcript sectioning, which categorizes transcript dialogues based on their clinical relevance like small talk, subjective, objective, etc. This can be used to show speciﬁc portions of the transcript. • Clinical entities, which includes structured information like medications, medical conditions, and treatments mentioned in the conversation. In addition, the following insights are provided for each conversation turn: • Participant role — Each participant is labeled as either a clinician or a patient. If a conversation has more than one participant in each category, each participant is assigned a number. For example, CLINICIAN_0, CLINICIAN_1 and PATIENT_0, PATIENT_1. • Section — Each dialogue turn is assigned to one of four possible sections based on the content identiﬁed. • Subjective — Information provided by the patient about their health concerns. • Objective — Information observed by the clinician through physical exam, lab, imaging, or diagnostic tests. • Assessment and Plan — Information that relates to the doctor's assessment and treatment plan. • Visit Flow Management — Information related to small talk or transitions. • Insights — Extract clinically relevant entities (ClinicalEntity) present in the conversation. AWS HealthScribe detects all clinical entities supported by Amazon Comprehend Medical. For an example of a transcript from a transcription job, see the transcript output in Transcription job output examples. For an example of a transcript from streaming, see the transcript output in Streaming transcription output examples. Transcript ﬁle 624 Amazon Transcribe Developer Guide AWS HealthScribe Clinical Documentation ﬁle AWS HealthScribe can use one of the following templates for the clinical note summary. The default is HISTORY_AND_PHYSICAL. • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation.
transcribe-dg-140	transcribe-dg.pdf	140	• Insights — Extract clinically relevant entities (ClinicalEntity) present in the conversation. AWS HealthScribe detects all clinical entities supported by Amazon Comprehend Medical. For an example of a transcript from a transcription job, see the transcript output in Transcription job output examples. For an example of a transcript from streaming, see the transcript output in Streaming transcription output examples. Transcript ﬁle 624 Amazon Transcribe Developer Guide AWS HealthScribe Clinical Documentation ﬁle AWS HealthScribe can use one of the following templates for the clinical note summary. The default is HISTORY_AND_PHYSICAL. • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan. • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan. To specify what template to use, do the following: • For transcription jobs, specify the template to use in the NoteTemplate of the ClinicalNoteGenerationSettings of the Settings of your StartMedicalScribeJob API operation. • For streaming, you specify the template to use in the NoteTemplate of the ClinicalNoteGenerationSettings of the PostStreamAnalyticsSettings of your MedicalScribeConﬁgurationEvent. Topics • HISTORY_AND_PHYSICAL template sections • GIRPP template sections HISTORY_AND_PHYSICAL template sections The HISTORY_AND_PHYSICAL insights template includes the following sections. Section CHIEF COMPLAINT HISTORY OF PRESENT ILLNESS Description Brief description for the patient's reason for visiting the clinician. Notes that provide information on patient's illness, including reference to severity, onset, Clinical Documentation ﬁle 625 Amazon Transcribe Section REVIEW OF SYSTEMS PAST MEDICAL HISTORY ASSESSMENT PLAN PHYSICAL_EXAMINATION PAST_FAMILY_HISTORY PAST_SOCIAL_HISTORY DIAGNOSTIC_TESTING Developer Guide Description timing of symptoms, current treatments, and the aﬀected areas. Patient-reported evaluation of symptoms across diﬀerent body systems. Details a patient's previous medical conditions, surgeries, and treatments. Notes that provide information on clinician's assessment of patient's health. Notes that reference any medical treatments, lifestyle adjustments, and further appointme nts. Documentation of clinician's ﬁndings from physical examination of patient's body systems and vital signs. Information about health conditions that run in the patient's family. Details about patient's social life, habits, occupation, and environmental factors aﬀecting health. Results and interpretation of laboratory tests, imaging studies, and other diagnostic procedures. Each sentence present in the Summary includes EvidenceLinks that provide the SegmentId for the relevant dialogues in the transcript that were summarized. This helps users validate accuracy of the summary in your application. Like explainability, providing traceability and transparency for AI-generated insights is consistent with Responsible AI principles. Providing these references along with the summary notes to clinicians or medical scribes helps foster trust and encourage the safe use of AI in the clinical settings. HISTORY_AND_PHYSICAL template sections 626 Amazon Transcribe Developer Guide For an example of a Clinical Documentation ﬁle from a transcription job, see the a Clinical Documentation ﬁle example in Transcription job output examples. For an example of a Clinical Documentation ﬁle from streaming, see the a Clinical Documentation ﬁle example in Streaming transcription output examples. GIRPP template sections The GIRPP insights template includes the following sections. Section Goal Intervention Response Progress Plan Description The identiﬁed problem, challenge, or behavior that needs to be addressed through treatment . The speciﬁc treatment, method, or technique used by the clinician to help the patient address the identiﬁed goal. How the patient responded to the intervent ion, including their participation level, reactions, and feedback. The clinician's assessment of movement toward treatment goals, including observati ons of patient improvement or barriers. The next steps in treatment, including future interventions, homework assignments, and referrals. AWS HealthScribe transcription jobs An AWS HealthScribe transcription job processes media ﬁles from an Amazon S3 bucket. When it processes a media ﬁle, it transcribes patient-clinician conversations and analyzes medical consultation to produces two JSON output ﬁles: a transcript ﬁle and a clinical documentation ﬁle. The following are API operations speciﬁc to AWS HealthScribe transcription jobs: GIRPP template sections 627 Amazon Transcribe • StartMedicalScribeJob • ListMedicalScribeJobs • GetMedicalScribeJob • DeleteMedicalScribeJob Developer Guide Starting an AWS HealthScribe transcription job You can start an AWS HealthScribe job using the AWS CLI or AWS SDKs. AWS CLI This example uses the start-medical-scribe-job command. For more information, see StartMedicalScribeJob. aws transcribe start-medical-scribe-job \ --region us-west-2 \ --medical-scribe-job-name my-first-medical-scribe-job \ --media MediaFileUri=s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac \ --output-bucket-name amzn-s3-demo-bucket \ --DataAccessRoleArn=arn:aws:iam::111122223333:role/ExampleRole \ --settings ShowSpeakerLabels=false,ChannelIdentification=true \ --channel-definitions ChannelId=0,ParticipantRole=CLINICIAN ChannelId=1,ParticipantRole=PATIENT Here is another example using the start-medical-scribe-job command, and a request body with additional settings. aws transcribe start-medical-scribe-job \ --region us-west-2 \ --cli-input-json file://filepath/my-first-medical-scribe-job.json The ﬁle my-first-medical-scribe-job.json contains the following request body. { "MedicalScribeJobName": "my-first-medical-scribe-job", Starting an AWS HealthScribe transcription job 628 Amazon Transcribe "Media": { Developer Guide "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/ExampleRole", "Settings": { "ShowSpeakerLabels": false, "ChannelIdentification": true }, "ChannelDefinitions": [ { "ChannelId": 0, "ParticipantRole":"CLINICIAN" }, { "ChannelId": 1, "ParticipantRole":"PATIENT" } ] } AWS SDK for Python (Boto3) The following example uses the AWS SDK
transcribe-dg-141	transcribe-dg.pdf	141	\ --output-bucket-name amzn-s3-demo-bucket \ --DataAccessRoleArn=arn:aws:iam::111122223333:role/ExampleRole \ --settings ShowSpeakerLabels=false,ChannelIdentification=true \ --channel-definitions ChannelId=0,ParticipantRole=CLINICIAN ChannelId=1,ParticipantRole=PATIENT Here is another example using the start-medical-scribe-job command, and a request body with additional settings. aws transcribe start-medical-scribe-job \ --region us-west-2 \ --cli-input-json file://filepath/my-first-medical-scribe-job.json The ﬁle my-first-medical-scribe-job.json contains the following request body. { "MedicalScribeJobName": "my-first-medical-scribe-job", Starting an AWS HealthScribe transcription job 628 Amazon Transcribe "Media": { Developer Guide "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/ExampleRole", "Settings": { "ShowSpeakerLabels": false, "ChannelIdentification": true }, "ChannelDefinitions": [ { "ChannelId": 0, "ParticipantRole":"CLINICIAN" }, { "ChannelId": 1, "ParticipantRole":"PATIENT" } ] } AWS SDK for Python (Boto3) The following example uses the AWS SDK for Python (Boto3) to make a start_medical_scribe_job request. For more information, see StartMedicalScribeJob. from __future__ import print_functionimport timeimport boto3 transcribe = boto3.client('transcribe', 'us-west-2') job_name = "my-first-medical-scribe-job" job_uri = "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" transcribe.start_medical_scribe_job( MedicalScribeJobName = job_name, Media = { 'MediaFileUri': job_uri }, OutputBucketName = 'amzn-s3-demo-bucket', DataAccessRoleArn = 'arn:aws:iam::111122223333:role/ExampleRole', Settings = { 'ShowSpeakerLabels': false, 'ChannelIdentification': true }, ChannelDefinitions = [ Starting an AWS HealthScribe transcription job 629 Amazon Transcribe { 'ChannelId': 0, 'ParticipantRole': 'CLINICIAN' }, { 'ChannelId': 1, 'ParticipantRole': 'PATIENT' } ] ) while True: Developer Guide status = transcribe.get_medical_scribe_job(MedicalScribeJobName = job_name) if status['MedicalScribeJob']['MedicalScribeJobStatus'] in ['COMPLETED', 'FAILED']: break print("Not ready yet...") time.sleep(5) print(status) Note The AWS Management Console does not currently support AWS HealthScribe jobs. Transcription job output examples In addition to a transcript, StartMedicalScribeJob requests generate a separate clinical documentation ﬁle. Both ﬁles are in JSON format and are stored in the output location you specify in your request. Here are examples of each output type: Example transcript output An AWS HealthScribe transcript ﬁle (from a StartMedicalScribeJob request) has the following format: { "Conversation": { "ConversationId": "sampleConversationUUID", "JobName": "sampleJobName", "JobType": "ASYNC", "LanguageCode": "en-US", "ClinicalInsights": [ Starting an AWS HealthScribe transcription job 630 Developer Guide Amazon Transcribe { "Attributes": [], "Category": "MEDICAL_CONDITION", "InsightId": "insightUUID1", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 12, "Content": "pain", "EndCharacterOffset": 15, "SegmentId": "uuid1" } ], "Type": "DX_NAME" }, { "Attributes": [], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID2", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 4, "Content": "mammogram", "EndCharacterOffset": 12, "SegmentId": "uuid2" } ], "Type": "TEST_NAME" }, { "Attributes": [], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID3", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 15, "Content": "pap smear", "EndCharacterOffset": 23, "SegmentId": "uuid3" } ], "Type": "TEST_NAME" Starting an AWS HealthScribe transcription job 631 Developer Guide Amazon Transcribe }, { "Attributes": [], "Category": "MEDICATION", "InsightId": "insightUUID4", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 28, "Content": "phentermine", "EndCharacterOffset": 38, "SegmentId": "uuid4" } ], "Type": "GENERIC_NAME" }, { "Attributes": [ { "AttributeId": "attributeUUID1", "Spans": [ { "BeginCharacterOffset": 38, "Content": "high", "EndCharacterOffset": 41, "SegmentId": "uuid5" } ], "Type": "TEST_VALUE" } ], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID5", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 14, "Content": "weight", "EndCharacterOffset": 19, "SegmentId": "uuid6" } ], "Type": "TEST_NAME" }, Starting an AWS HealthScribe transcription job 632 Developer Guide Amazon Transcribe { "Attributes": [], "Category": "ANATOMY", "InsightId": "insightUUID6", "InsightType": "ClinicalEntity", "Spans": [ { "BeginCharacterOffset": 60, "Content": "heart", "EndCharacterOffset": 64, "SegmentId": "uuid7" } ], "Type": "SYSTEM_ORGAN_SITE" } ], "TranscriptItems": [ { "Alternatives": [ { "Confidence": 0.7925, "Content": "Okay" } ], "BeginAudioTime": 0.16, "EndAudioTime": 0.6, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 0, "Content": "." } ], "BeginAudioTime": 0.17, "EndAudioTime": 0.9, "Type": "PUNCTUATION" }, { "Alternatives": [ { "Confidence": 1, "Content": "Good" Starting an AWS HealthScribe transcription job 633 Developer Guide Amazon Transcribe } ], "BeginAudioTime": 0.61, "EndAudioTime": 0.92, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 1, "Content": "afternoon" } ], "BeginAudioTime": 0.92, "EndAudioTime": 1.54, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 0, "Content": "." } ], "BeginAudioTime": 0, "EndAudioTime": 0, "Type": "PUNCTUATION" }, { "Alternatives": [ { "Confidence": 0.9924, "Content": "You" } ], "BeginAudioTime": 1.55, "EndAudioTime": 1.88, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 1, "Content": "lost" Starting an AWS HealthScribe transcription job 634 Developer Guide Amazon Transcribe } ], "BeginAudioTime": 1.88, "EndAudioTime": 2.19, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 1, "Content": "one" } ], "BeginAudioTime": 2.19, "EndAudioTime": 2.4, "Type": "PRONUNCIATION" }, { "Alternatives": [ { "Confidence": 1, "Content": "lb" } ], "BeginAudioTime": 2.4, "EndAudioTime": 2.97, "Type": "PRONUNCIATION" } ], "TranscriptSegments": [ { "BeginAudioTime": 0.16, "Content": "Okay.", "EndAudioTime": 0.6, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid1" }, { "BeginAudioTime": 0.61, Starting an AWS HealthScribe transcription job 635 Amazon Transcribe Developer Guide "Content": "Good afternoon.", "EndAudioTime": 1.54, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "OTHER" }, "SegmentId": "uuid2" }, { "BeginAudioTime": 1.55, "Content": "You lost one lb.", "EndAudioTime": 2.97, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid3" }, { "BeginAudioTime": 2.98, "Content": "Yeah, I think it, uh, do you feel more energy?", "EndAudioTime": 6.95, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid5" }, { "BeginAudioTime": 6.96, "Content": "Yes.", "EndAudioTime": 7.88, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, Starting an AWS HealthScribe transcription job 636 Amazon Transcribe Developer Guide "SegmentId":
transcribe-dg-142	transcribe-dg.pdf	142	Guide "Content": "Good afternoon.", "EndAudioTime": 1.54, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "OTHER" }, "SegmentId": "uuid2" }, { "BeginAudioTime": 1.55, "Content": "You lost one lb.", "EndAudioTime": 2.97, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid3" }, { "BeginAudioTime": 2.98, "Content": "Yeah, I think it, uh, do you feel more energy?", "EndAudioTime": 6.95, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid5" }, { "BeginAudioTime": 6.96, "Content": "Yes.", "EndAudioTime": 7.88, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, Starting an AWS HealthScribe transcription job 636 Amazon Transcribe Developer Guide "SegmentId": "uuid6" }, { "BeginAudioTime": 7.89, "Content": "Uh, how about craving for the carbohydrate or sugar or fat or anything?", "EndAudioTime": 17.93, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid7" } ] } } Here is another example using the start-medical-scribe-job command, and a request body with additional settings. aws transcribe start-medical-scribe-job \ --region us-west-2 \ --cli-input-json file://filepath/my-first-medical-scribe-job.json The ﬁle my-first-medical-scribe-job.json contains the following request body. { "MedicalScribeJobName": "my-first-medical-scribe-job", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/my-input-files/my-media-file.flac" }, "OutputBucketName": "amzn-s3-demo-bucket", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/ExampleRole", "Settings": { "ShowSpeakerLabels": false, "ChannelIdentification": true }, Starting an AWS HealthScribe transcription job 637 Developer Guide Amazon Transcribe "ChannelDefinitions": [ { "ChannelId": 0, "ParticipantRole":"CLINICIAN" }, { "ChannelId": 1, "ParticipantRole":"PATIENT" } ] } Example clinical documentation output A documentation insights ﬁle (from a StartMedicalScribeJob request) has the following format: { "ClinicalDocumentation": { "Sections": [ { "SectionName": "CHIEF_COMPLAINT", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid1" }, { "SegmentId": "uuid2" }, { "SegmentId": "uuid3" }, { "SegmentId": "uuid4" }, { "SegmentId": "uuid5" }, { "SegmentId": "uuid6" Starting an AWS HealthScribe transcription job 638 Developer Guide Amazon Transcribe } ], "SummarizedSegment": "Weight loss." } ] }, { "SectionName": "HISTORY_OF_PRESENT_ILLNESS", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid7" }, { "SegmentId": "uuid8" }, { "SegmentId": "uuid9" }, { "SegmentId": "uuid10" } ], "SummarizedSegment": "The patient is seen today for a follow-up of weight loss." }, { "EvidenceLinks": [ { "SegmentId": "uuid11" }, { "SegmentId": "uuid12" }, { "SegmentId": "uuid13" } ], "SummarizedSegment": "They report feeling more energy and craving carbohydrates, sugar, and fat." }, { "EvidenceLinks": [ Starting an AWS HealthScribe transcription job 639 Amazon Transcribe { "SegmentId": "uuid14" }, { "SegmentId": "uuid15" }, { "SegmentId": "uuid16" } ], Developer Guide "SummarizedSegment": "The patient is up to date on their mammogram and pap smear." }, { "EvidenceLinks": [ { "SegmentId": "uuid17" }, { "SegmentId": "uuid18" }, { "SegmentId": "uuid19" }, { "SegmentId": "uuid20" } ], "SummarizedSegment": "The patient is taking phentermine and would like to continue." } ] }, { "SectionName": "REVIEW_OF_SYSTEMS", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid21" }, { "SegmentId": "uuid22" } Starting an AWS HealthScribe transcription job 640 Amazon Transcribe ], Developer Guide "SummarizedSegment": "Patient reports intermittent headaches, occasional chest pains but denies any recent fevers or chills." }, { "EvidenceLinks": [ { "SegmentId": "uuid23" }, { "SegmentId": "uuid24" } ], "SummarizedSegment": "No recent changes in vision, hearing, or any respiratory complaints." } ] }, { "SectionName": "PAST_MEDICAL_HISTORY", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid25" }, { "SegmentId": "uuid26" } ], "SummarizedSegment": "Patient has a history of hypertension and was diagnosed with Type II diabetes 5 years ago." }, { "EvidenceLinks": [ { "SegmentId": "uuid27" }, { "SegmentId": "uuid28" } ], "SummarizedSegment": "Underwent an appendectomy in the early '90s and had a fracture in the left arm during childhood." Starting an AWS HealthScribe transcription job 641 Developer Guide Amazon Transcribe } ] }, { "SectionName": "ASSESSMENT", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid29" }, { "SegmentId": "uuid30" } ], "SummarizedSegment": "Weight loss" } ] }, { "SectionName": "PLAN", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid31" }, { "SegmentId": "uuid32" }, { "SegmentId": "uuid33" }, { "SegmentId": "uuid34" } ], "SummarizedSegment": "For the condition of Weight loss: The patient was given a 30-day supply of phentermine and was advised to follow up in 30 days." } ] } ] } Starting an AWS HealthScribe transcription job 642 Amazon Transcribe } Developer Guide AWS HealthScribe streaming With AWS HealthScribe streaming, you can transcribe medical conversations in real-time. AWS HealthScribe streaming is a real-time HTTP2 based bi-directional service that accepts audio stream on one channel and vends an audio transcription on the other channel. After streaming is complete, AWS HealthScribe analyzes the stream contents and produces a transcript JSON ﬁle and a clinical note JSON ﬁle. To start streaming, use the StartMedicalScribeStream API operation. This API starts an HTTP2 based bi-directional channel that you use to stream audio events. When you start a stream, ﬁrst specify the stream conﬁguration in a MedicalScribeConfigurationEvent. This event includes channel deﬁnitions, encryption settings, and post-stream analytics settings, such as the output conﬁguration for aggregated transcript and clinical note generation. After you start streaming audio, you manage the stream as follows: • When you
transcribe-dg-143	transcribe-dg.pdf	143	transcription on the other channel. After streaming is complete, AWS HealthScribe analyzes the stream contents and produces a transcript JSON ﬁle and a clinical note JSON ﬁle. To start streaming, use the StartMedicalScribeStream API operation. This API starts an HTTP2 based bi-directional channel that you use to stream audio events. When you start a stream, ﬁrst specify the stream conﬁguration in a MedicalScribeConfigurationEvent. This event includes channel deﬁnitions, encryption settings, and post-stream analytics settings, such as the output conﬁguration for aggregated transcript and clinical note generation. After you start streaming audio, you manage the stream as follows: • When you are ﬁnished, to start processing the results with post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of END_OF_SESSION and AWS HealthScribe starts the analytics. • To pause streaming, complete the input stream without sending the MedicalScribeSessionControlEvent. • To resume a paused stream, use the StartMedicalScribeStream API operation and specify the same SessionId. This is the SessionId you used when you originally started the stream. Topics • Guidelines and requirements • ResourceAccessRoleArn role permissions • Starting AWS HealthScribe streaming transcription Guidelines and requirements The following are guidelines and requirements for AWS HealthScribe streaming: Streaming 643 Amazon Transcribe Developer Guide • Before you send audio events, you must ﬁrst specify the stream conﬁguration in a MedicalScribeConfigurationEvent. • To run post-stream analytics, the ResourceAccessRoleArn in your MedicalScribeConfigurationEvent must have the correct permissions. For more information, see ResourceAccessRoleArn role permissions. • You can resume a session any number of times within 5 hours from the initial stream creation. • You can stream at most 2 hours of audio over a session across all streaming requests. • By default, AWS HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. When you start a stream, you can specify a AWS KMS key for a second layer of encryption. Your ResourceAccessRoleArn must have permission to use your AWS KMS key. For more information, see Data Encryption at rest for AWS HealthScribe. • You can use AWS HealthScribe streaming with the AWS SDKs, excluding the SDK for Python (Boto3) and SDK for PHP. • If a LimitExceededException exception occurs after you end a stream, you can restart the session and still generate post-stream analytics. To restart the stream, use the StartMedicalScribeStream API and use same SessionID. Then send a MedicalScribeSessionControlEvent with a Type of END_OF_SESSION and AWS HealthScribe starts the analytics. ResourceAccessRoleArn role permissions To run post-stream analytics, the ResourceAccessRoleArn in your MedicalScribeConfigurationEvent must be able to access your Amazon S3 output bucket and, if you provide it, your AWS KMS key. Also, the role's trust policy must grant the transcribe.streaming.amazonaws.com service permission to assume the role. The following is an example IAM policy that grants Amazon S3 bucket permissions and AWS KMS key permissions. For more information, see Data Encryption at rest for AWS HealthScribe. { "Version": "2012-10-17", "Statement": [ { "Action": [ "s3:PutObject" ], "Resource": [ ResourceAccessRoleArn role permissions 644 Amazon Transcribe Developer Guide "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/" ], "Effect": "Allow" }, { "Action": [ "kms:DescribeKey", "kms:Decrypt", "kms:Encrypt", "kms:GenerateDataKey" ], "Resource": "arn:aws:kms:us- west-2:123456789012:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "Effect": "Allow", } ] } The following is an example trust policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "transcribe.streaming.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] } Starting AWS HealthScribe streaming transcription The following code example shows how to set up a AWS HealthScribe streaming transcription using the AWS SDKs. Topics Starting AWS HealthScribe streaming transcription 645 Amazon Transcribe • SDK for Java 2.x • Streaming transcription output examples SDK for Java 2.x Developer Guide The following example uses the SDK for Java 2.x to set up streaming and make a StartMedicalScribeStream request. package org.example; import io.reactivex.rxjava3.core.BackpressureStrategy; import io.reactivex.rxjava3.core.Flowable; import org.reactivestreams.Publisher; import org.reactivestreams.Subscriber; import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; import software.amazon.awssdk.core.SdkBytes; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.transcribestreaming.TranscribeStreamingAsyncClient; import software.amazon.awssdk.services.transcribestreaming.model.ClinicalNoteGenerationSettings; import software.amazon.awssdk.services.transcribestreaming.model.LanguageCode; import software.amazon.awssdk.services.transcribestreaming.model.MediaEncoding; import software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeInputStream; import software.amazon.awssdk.services.transcribestreaming.model.MedicalScribePostStreamAnalyticsSettings; import software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeSessionControlEventType; import software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeTranscriptEvent; import software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeTranscriptSegment; import software.amazon.awssdk.services.transcribestreaming.model.StartMedicalScribeStreamRequest; import software.amazon.awssdk.services.transcribestreaming.model.StartMedicalScribeStreamResponseHandler; import software.amazon.awssdk.services.transcribestreaming.model.medicalscribeinputstream.DefaultConfigurationEvent; Starting AWS HealthScribe streaming transcription 646 Amazon Transcribe Developer Guide import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; import javax.sound.sampled.AudioFormat; import javax.sound.sampled.AudioInputStream; import javax.sound.sampled.AudioSystem; import javax.sound.sampled.DataLine; import javax.sound.sampled.LineUnavailableException; import javax.sound.sampled.TargetDataLine; import java.io.BufferedInputStream; import java.io.IOException; import java.io.InputStream; import java.io.UncheckedIOException; import java.util.Arrays; import java.util.concurrent.CompletableFuture; public class HealthScribeStreamingDemoApp { private static final int CHUNK_SIZE_IN_BYTES = 6400; private static final int SAMPLE_RATE = 16000; private static final Region REGION = Region.US_EAST_1; private static final String sessionId = "1234abcd-12ab-34cd-56ef-123456SAMPLE"; private static final String bucketName = "amzn-s3-demo-bucket"; private static final String resourceAccessRoleArn = "arn:aws:iam::123456789012:role/resource-access-role"; private static TranscribeStreamingAsyncClient client; public static void main(String args[]) { client = TranscribeStreamingAsyncClient.builder() .credentialsProvider(getCredentials()) .httpClientBuilder(NettyNioAsyncHttpClient.builder()) .region(REGION) .build(); try { StartMedicalScribeStreamRequest request = StartMedicalScribeStreamRequest.builder() .languageCode(LanguageCode.EN_US.toString()) .mediaSampleRateHertz(SAMPLE_RATE) .mediaEncoding(MediaEncoding.PCM.toString()) .sessionId(sessionId) .build(); MedicalScribeInputStream endSessionEvent = MedicalScribeInputStream.sessionControlEventBuilder() Starting AWS HealthScribe streaming transcription 647 Amazon Transcribe Developer Guide .type(MedicalScribeSessionControlEventType.END_OF_SESSION) .build(); CompletableFuture<Void> result = client.startMedicalScribeStream( request, new AudioStreamPublisher(getStreamFromMic(), getConfigurationEvent(),endSessionEvent), getMedicalScribeResponseHandler()); result.get(); client.close(); } catch (Exception e) { System.err.println("Error occurred: " + e.getMessage()); e.printStackTrace(); } }
transcribe-dg-144	transcribe-dg.pdf	144	int SAMPLE_RATE = 16000; private static final Region REGION = Region.US_EAST_1; private static final String sessionId = "1234abcd-12ab-34cd-56ef-123456SAMPLE"; private static final String bucketName = "amzn-s3-demo-bucket"; private static final String resourceAccessRoleArn = "arn:aws:iam::123456789012:role/resource-access-role"; private static TranscribeStreamingAsyncClient client; public static void main(String args[]) { client = TranscribeStreamingAsyncClient.builder() .credentialsProvider(getCredentials()) .httpClientBuilder(NettyNioAsyncHttpClient.builder()) .region(REGION) .build(); try { StartMedicalScribeStreamRequest request = StartMedicalScribeStreamRequest.builder() .languageCode(LanguageCode.EN_US.toString()) .mediaSampleRateHertz(SAMPLE_RATE) .mediaEncoding(MediaEncoding.PCM.toString()) .sessionId(sessionId) .build(); MedicalScribeInputStream endSessionEvent = MedicalScribeInputStream.sessionControlEventBuilder() Starting AWS HealthScribe streaming transcription 647 Amazon Transcribe Developer Guide .type(MedicalScribeSessionControlEventType.END_OF_SESSION) .build(); CompletableFuture<Void> result = client.startMedicalScribeStream( request, new AudioStreamPublisher(getStreamFromMic(), getConfigurationEvent(),endSessionEvent), getMedicalScribeResponseHandler()); result.get(); client.close(); } catch (Exception e) { System.err.println("Error occurred: " + e.getMessage()); e.printStackTrace(); } } private static AudioInputStream getStreamFromMic() throws LineUnavailableException { // Signed PCM AudioFormat with 16kHz, 16 bit sample size, mono AudioFormat format = new AudioFormat(SAMPLE_RATE, 16, 1, true, false); DataLine.Info info = new DataLine.Info(TargetDataLine.class, format); if (!AudioSystem.isLineSupported(info)) { System.out.println("Line not supported"); throw new LineUnavailableException("The audio system microphone line is not supported."); } TargetDataLine line = (TargetDataLine) AudioSystem.getLine(info); int bufferSize = (CHUNK_SIZE_IN_BYTES / format.getFrameSize()) * format.getFrameSize(); line.open(format); line.start(); // Create a wrapper class that can be closed when Enter is pressed AudioInputStream audioStream = new AudioInputStream(line); // Start a thread to monitor for Enter key System.out.println("Recording... Press Enter to stop"); Thread monitorThread = new Thread(() -> { try { System.in.read(); line.stop(); line.close(); } catch (IOException e) { Starting AWS HealthScribe streaming transcription 648 Amazon Transcribe Developer Guide e.printStackTrace(); } }); monitorThread.setDaemon(true); // Set as daemon thread so it doesn't prevent JVM shutdown monitorThread.start(); return new AudioInputStream( new BufferedInputStream(new AudioInputStream(line)), format, AudioSystem.NOT_SPECIFIED ); } private static AwsCredentialsProvider getCredentials() { return DefaultCredentialsProvider.create(); } private static StartMedicalScribeStreamResponseHandler getMedicalScribeResponseHandler() { return StartMedicalScribeStreamResponseHandler.builder() .onResponse(r -> { System.out.println("Received Initial response"); }) .onError(Throwable::printStackTrace) .onComplete(() -> { System.out.println("=== All records streamed successfully ==="); }) .subscriber(event -> { if (event instanceof MedicalScribeTranscriptEvent) { MedicalScribeTranscriptSegment segment = ((MedicalScribeTranscriptEvent) event).transcriptSegment(); if (segment != null && segment.content() != null && ! segment.content().isEmpty()) { System.out.println(segment.content()); } } }) .build(); } private static DefaultConfigurationEvent getConfigurationEvent() { Starting AWS HealthScribe streaming transcription 649 Amazon Transcribe Developer Guide MedicalScribePostStreamAnalyticsSettings postStreamSettings = MedicalScribePostStreamAnalyticsSettings .builder() .clinicalNoteGenerationSettings( ClinicalNoteGenerationSettings.builder() .outputBucketName(bucketName) .build() ) .build(); return (DefaultConfigurationEvent) MedicalScribeInputStream.configurationEventBuilder() .resourceAccessRoleArn(resourceAccessRoleArn) .postStreamAnalyticsSettings(postStreamSettings) .build(); } private static class AudioStreamPublisher implements Publisher<MedicalScribeInputStream> { private final InputStream audioInputStream; private final MedicalScribeInputStream configEvent; private final MedicalScribeInputStream endSessionEvent; private AudioStreamPublisher(AudioInputStream audioInputStream, MedicalScribeInputStream configEvent, MedicalScribeInputStream endSessionEvent) { this.audioInputStream = audioInputStream; this.configEvent = configEvent; this.endSessionEvent = endSessionEvent; } @Override public void subscribe(Subscriber<? super MedicalScribeInputStream> subscriber) { createAudioFlowable() .doOnComplete(() -> { try { audioInputStream.close(); } catch (IOException e) { throw new UncheckedIOException(e); } }) .subscribe(subscriber); } Starting AWS HealthScribe streaming transcription 650 Amazon Transcribe Developer Guide private Flowable<MedicalScribeInputStream> createAudioFlowable() { // Start with config event Flowable<MedicalScribeInputStream> configFlow = Flowable.just(configEvent); // Create audio chunk flowable Flowable<MedicalScribeInputStream> audioFlow = Flowable.create(emitter -> { byte[] buffer = new byte[CHUNK_SIZE_IN_BYTES]; int bytesRead; try { while (!emitter.isCancelled() && (bytesRead = audioInputStream.read(buffer)) > 0) { byte[] audioData = bytesRead < buffer.length ? Arrays.copyOfRange(buffer, 0, bytesRead) : buffer; MedicalScribeInputStream audioEvent = MedicalScribeInputStream.audioEventBuilder() .audioChunk(SdkBytes.fromByteArray(audioData)) .build(); emitter.onNext(audioEvent); } emitter.onComplete(); } catch (IOException e) { emitter.onError(e); } }, BackpressureStrategy.BUFFER); // End with session end event Flowable<MedicalScribeInputStream> endFlow = Flowable.just(endSessionEvent); // Concatenate all flows return Flowable.concat(configFlow, audioFlow, endFlow); } } } Streaming transcription output examples After streaming is complete, AWS HealthScribe analyzes the stream contents and produces a transcript JSON ﬁle and a clinical note JSON ﬁle. Here are examples of each output type: Starting AWS HealthScribe streaming transcription 651 Amazon Transcribe Example transcript output Developer Guide The following is an example of a AWS HealthScribe transcript ﬁle from a streaming session. { "Conversation": { "ClinicalInsights": [{ "Attributes": [], "Category": "MEDICAL_CONDITION", "InsightId": "insightUUID1", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 12, "Content": "pain", "EndCharacterOffset": 15, "SegmentId": "uuid1" }], "Type": "DX_NAME" }, { "Attributes": [], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID2", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 4, "Content": "mammogram", "EndCharacterOffset": 12, "SegmentId": "uuid2" }], "Type": "TEST_NAME" }, { "Attributes": [], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID3", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 15, "Content": "pap smear", "EndCharacterOffset": 23, "SegmentId": "uuid3" }], "Type": "TEST_NAME" }, { "Attributes": [], Starting AWS HealthScribe streaming transcription 652 Amazon Transcribe Developer Guide "Category": "MEDICATION", "InsightId": "insightUUID4", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 28, "Content": "phentermine", "EndCharacterOffset": 38, "SegmentId": "uuid4" }], "Type": "GENERIC_NAME" }, { "Attributes": [{ "AttributeId": "attributeUUID1", "Spans": [{ "BeginCharacterOffset": 38, "Content": "high", "EndCharacterOffset": 41, "SegmentId": "uuid5" }], "Type": "TEST_VALUE" }], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID5", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 14, "Content": "weight", "EndCharacterOffset": 19, "SegmentId": "uuid6" }], "Type": "TEST_NAME" }, { "Attributes": [], "Category": "ANATOMY", "InsightId": "insightUUID6", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 60, "Content": "heart", "EndCharacterOffset": 64, "SegmentId": "uuid7" }], "Type": "SYSTEM_ORGAN_SITE" }], Starting AWS HealthScribe streaming transcription 653 Amazon Transcribe Developer Guide "ConversationId": "sampleConversationUUID", "LanguageCode": "en-US", "SessionId": "sampleSessionUUID", "TranscriptItems": [{ "Alternatives": [{ "Confidence": 0.7925, "Content": "Okay" }], "BeginAudioTime": 0.16, "EndAudioTime": 0.6, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 0, "Content": "." }], "BeginAudioTime": 0, "EndAudioTime": 0, "Type": "PUNCTUATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "Good" }], "BeginAudioTime":
transcribe-dg-145	transcribe-dg.pdf	145	}], "Category": "TEST_TREATMENT_PROCEDURE", "InsightId": "insightUUID5", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 14, "Content": "weight", "EndCharacterOffset": 19, "SegmentId": "uuid6" }], "Type": "TEST_NAME" }, { "Attributes": [], "Category": "ANATOMY", "InsightId": "insightUUID6", "InsightType": "ClinicalEntity", "Spans": [{ "BeginCharacterOffset": 60, "Content": "heart", "EndCharacterOffset": 64, "SegmentId": "uuid7" }], "Type": "SYSTEM_ORGAN_SITE" }], Starting AWS HealthScribe streaming transcription 653 Amazon Transcribe Developer Guide "ConversationId": "sampleConversationUUID", "LanguageCode": "en-US", "SessionId": "sampleSessionUUID", "TranscriptItems": [{ "Alternatives": [{ "Confidence": 0.7925, "Content": "Okay" }], "BeginAudioTime": 0.16, "EndAudioTime": 0.6, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 0, "Content": "." }], "BeginAudioTime": 0, "EndAudioTime": 0, "Type": "PUNCTUATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "Good" }], "BeginAudioTime": 0.61, "EndAudioTime": 0.92, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "afternoon" }], "BeginAudioTime": 0.92, "EndAudioTime": 1.54, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 0, "Content": "." }], Starting AWS HealthScribe streaming transcription 654 Amazon Transcribe Developer Guide "BeginAudioTime": 0, "EndAudioTime": 0, "Type": "PUNCTUATION" }, { "Alternatives": [{ "Confidence": 0.9924, "Content": "You" }], "BeginAudioTime": 1.55, "EndAudioTime": 1.88, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "lost" }], "BeginAudioTime": 1.88, "EndAudioTime": 2.19, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "one" }], "BeginAudioTime": 2.19, "EndAudioTime": 2.4, "Type": "PRONUNCIATION" }, { "Alternatives": [{ "Confidence": 1, "Content": "lb" }], "BeginAudioTime": 2.4, "EndAudioTime": 2.97, "Type": "PRONUNCIATION" } ], "TranscriptSegments": [{ "BeginAudioTime": 0.16, "Content": "Okay.", Starting AWS HealthScribe streaming transcription 655 Amazon Transcribe Developer Guide "EndAudioTime": 0.6, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid1" }, { "BeginAudioTime": 0.61, "Content": "Good afternoon.", "EndAudioTime": 1.54, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "OTHER" }, "SegmentId": "uuid2" }, { "BeginAudioTime": 1.55, "Content": "You lost one lb.", "EndAudioTime": 2.97, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid3" }, { "BeginAudioTime": 2.98, "Content": "Yeah, I think it, uh, do you feel more energy?", "EndAudioTime": 6.95, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid4" }, { "BeginAudioTime": 6.96, "Content": "Yes.", Starting AWS HealthScribe streaming transcription 656 Amazon Transcribe Developer Guide "EndAudioTime": 7.88, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid5" }, { "BeginAudioTime": 7.89, "Content": "Uh, how about craving for the carbohydrate or sugar or fat or anything?", "EndAudioTime": 17.93, "ParticipantDetails": { "ParticipantRole": "CLINICIAN_0" }, "SectionDetails": { "SectionName": "SUBJECTIVE" }, "SegmentId": "uuid6" }] } } Example Clinical Documentation output The following is an example of a AWS HealthScribe clinical documentation insights ﬁle from a streaming session. { "ClinicalDocumentation": { "Sections": [ { "SectionName": "CHIEF_COMPLAINT", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid1" }, { "SegmentId": "uuid2" }, Starting AWS HealthScribe streaming transcription 657 Developer Guide Amazon Transcribe { "SegmentId": "uuid3" }, { "SegmentId": "uuid4" }, { "SegmentId": "uuid5" }, { "SegmentId": "uuid6" } ], "SummarizedSegment": "Weight loss." } ] }, { "SectionName": "HISTORY_OF_PRESENT_ILLNESS", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid7" }, { "SegmentId": "uuid8" }, { "SegmentId": "uuid9" }, { "SegmentId": "uuid10" } ], "SummarizedSegment": "The patient is seen today for a follow-up of weight loss." }, { "EvidenceLinks": [ { "SegmentId": "uuid11" }, { Starting AWS HealthScribe streaming transcription 658 Amazon Transcribe Developer Guide "SegmentId": "uuid12" }, { "SegmentId": "uuid13" } ], "SummarizedSegment": "They report feeling more energy and craving carbohydrates, sugar, and fat." }, { "EvidenceLinks": [ { "SegmentId": "uuid14" }, { "SegmentId": "uuid15" }, { "SegmentId": "uuid16" } ], "SummarizedSegment": "The patient is up to date on their mammogram and pap smear." }, { "EvidenceLinks": [ { "SegmentId": "uuid17" }, { "SegmentId": "uuid18" }, { "SegmentId": "uuid19" }, { "SegmentId": "uuid20" } ], "SummarizedSegment": "The patient is taking phentermine and would like to continue." } ] }, Starting AWS HealthScribe streaming transcription 659 Developer Guide Amazon Transcribe { "SectionName": "REVIEW_OF_SYSTEMS", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid21" }, { "SegmentId": "uuid22" } ], "SummarizedSegment": "Patient reports intermittent headaches, occasional chest pains but denies any recent fevers or chills." }, { "EvidenceLinks": [ { "SegmentId": "uuid23" }, { "SegmentId": "uuid24" } ], "SummarizedSegment": "No recent changes in vision, hearing, or any respiratory complaints." } ] }, { "SectionName": "PAST_MEDICAL_HISTORY", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid25" }, { "SegmentId": "uuid26" } ], "SummarizedSegment": "Patient has a history of hypertension and was diagnosed with Type II diabetes 5 years ago." }, Starting AWS HealthScribe streaming transcription 660 Amazon Transcribe { "EvidenceLinks": [ { "SegmentId": "uuid27" }, { "SegmentId": "uuid28" } ], Developer Guide "SummarizedSegment": "Underwent an appendectomy in the early '90s and had a fracture in the left arm during childhood." } ] }, { "SectionName": "ASSESSMENT", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid29" }, { "SegmentId": "uuid30" } ], "SummarizedSegment": "Weight loss" } ] }, { "SectionName": "PLAN", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid31" }, { "SegmentId": "uuid32" }, { "SegmentId": "uuid33" }, Starting AWS HealthScribe streaming transcription 661 Amazon Transcribe { "SegmentId": "uuid34" } ], Developer Guide "SummarizedSegment": "For the condition
transcribe-dg-146	transcribe-dg.pdf	146	660 Amazon Transcribe { "EvidenceLinks": [ { "SegmentId": "uuid27" }, { "SegmentId": "uuid28" } ], Developer Guide "SummarizedSegment": "Underwent an appendectomy in the early '90s and had a fracture in the left arm during childhood." } ] }, { "SectionName": "ASSESSMENT", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid29" }, { "SegmentId": "uuid30" } ], "SummarizedSegment": "Weight loss" } ] }, { "SectionName": "PLAN", "Summary": [ { "EvidenceLinks": [ { "SegmentId": "uuid31" }, { "SegmentId": "uuid32" }, { "SegmentId": "uuid33" }, Starting AWS HealthScribe streaming transcription 661 Amazon Transcribe { "SegmentId": "uuid34" } ], Developer Guide "SummarizedSegment": "For the condition of Weight loss: The patient was given a 30-day supply of phentermine and was advised to follow up in 30 days." } ] } ], "SessionId": "sampleSessionUUID" } } Data Encryption at rest for AWS HealthScribe By default, AWS HealthScribe provides encryption at rest to protect sensitive customer data using AWS HealthScribe managed AWS Key Management Service (AWS KMS) keys. Encryption of data at rest by default helps reduce the operational overhead and complexity involved in protecting sensitive data. Also, it enables you to build secure applications that meet strict encryption compliance and regulatory requirements. When you create an AWS HealthScribe transcription job or start a stream, you can specify a customer managed key. This adds a second layer of encryption. • AWS HealthScribe managed AWS KMS keys — AWS HealthScribe uses AWS HealthScribe managed AWS Key Management Service (AWS KMS) keys by default to automatically encrypt intermediate ﬁles. You can't disable this layer of encryption or choose an alternate encryption type. You can't view, manage, or use the keys, or audit their use. However, you don't have to take any action or change any programs to protect the keys that encrypt your data. • Customer managed keys — AWS HealthScribe supports the use of a symmetric customer managed key that you create, own, and manage to add a second layer of encryption over the existing AWS owned encryption. Because you have full control of this layer of encryption, you can perform such tasks as: • Establishing and maintaining key policies • Establishing and maintaining IAM policies and grants • Enabling and disabling key policies • Rotating key cryptographic material • Adding tags Data Encryption at rest for AWS HealthScribe 662 Amazon Transcribe • Creating key aliases • Scheduling keys for deletion Developer Guide For more information, see customer managed key in the AWS Key Management Service Developer Guide. Note AWS HealthScribe automatically enables encryption at rest using AWS-owned keys to protect personally identiﬁable data at no charge. However, AWS KMS charges apply for using a customer managed key. For more information about pricing, see AWS Key Management Service pricing. For more information on AWS KMS, see What is AWS Key Management Service. Topics • Creating a customer managed key • Specifying a customer managed key for AWS HealthScribe • AWS KMS encryption context • Monitoring your encryption keys for AWS HealthScribe Creating a customer managed key You can create a symmetric customer managed key by using the AWS Management Console, or the AWS KMS APIs. To create a symmetric customer managed key, follow the steps for Creating symmetric customer managed key in the AWS Key Management Service Developer Guide. Key policies control access to your customer managed key. Every customer managed key must have exactly one key policy, which contains statements that determine who can use the key and how they can use it. When you create your customer managed key, you can specify a key policy. For more information, see Managing access to customer managed keys in the AWS Key Management Service Developer Guide. Creating a customer managed key 663 Amazon Transcribe Developer Guide AWS KMS key policies for AWS HealthScribe If you are using a key in the same account as the IAM role you specify as the DataAccessRole in your StartMedicalScribeJob or ResourceAccessRole in your StartMedicalScribeStream request, you don't need to update the Key Policy. To use your customer managed key in a diﬀerent account as your DataAccessRole (for transcription jobs) or ResourceAccessRole (for streaming), you must trust the respective role in the Key Policy for the following actions: • kms:Encrypt — Allows encryption using the customer managed key • kms:Decrypt — Allows decryption using the customer managed key • kms:DescribeKey — Provides the customer managed key details to allow AWS HealthScribe to validate the key The following is an example key policy you can use to grant your ResourceAccessRole cross account permissions to use your customer managed key for AWS HealthScribe streaming. To use this policy for transcription jobs, update the Principal to use the DataAccessRole ARN, and remove or modify the encryption context. { "Version":"2012-10-17", "Statement":[ { "Sid": "Allow access for key administrators", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:root" }, "Action" : [ "kms:*"
transcribe-dg-147	transcribe-dg.pdf	147	customer managed key • kms:Decrypt — Allows decryption using the customer managed key • kms:DescribeKey — Provides the customer managed key details to allow AWS HealthScribe to validate the key The following is an example key policy you can use to grant your ResourceAccessRole cross account permissions to use your customer managed key for AWS HealthScribe streaming. To use this policy for transcription jobs, update the Principal to use the DataAccessRole ARN, and remove or modify the encryption context. { "Version":"2012-10-17", "Statement":[ { "Sid": "Allow access for key administrators", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:root" }, "Action" : [ "kms:" ], "Resource": "" }, { "Sid":"Allow access to the ResourceAccessRole for StartMedicalScribeStream", "Effect":"Allow", "Principal":{ "AWS": "arn:aws:iam::123456789012:role/ResourceAccessRole" }, "Action":[ "kms:Encrypt", Creating a customer managed key 664 Amazon Transcribe Developer Guide "kms:Decrypt", "kms:GenerateDataKey" ] "Resource":"", "Condition": { "StringEquals": { "EncryptionContext":[ "aws:us-east-1:transcribe:medical-scribe:session- id": "1234abcd-12ab-34cd-56ef-123456SAMPLE" ] } } }, { "Sid":"Allow access to the ResourceAccessRole for DescribeKey", "Effect":"Allow", "Principal":{ "AWS": "arn:aws:iam::123456789012:role/ResourceAccessRole" }, "Action": "kms:DescribeKey", "Resource":"" } ] } IAM policy permissions for access roles The IAM policy attached to your DataAccessRole or ResourceAccessRole must grant permissions to perform the necessary AWS KMS actions, regardless of whether the customer-managed key and role are in the same or diﬀerent accounts. Also, the role's trust policy must grant AWS HealthScribe permission to assume the role. The following IAM policy example shows how to grant a ResourceAccessRole permissions for AWS HealthScribe streaming. To use this policy for transcription jobs, replace transcribe.streaming.amazonaws.com with transcribe.amazonaws.com and remove or modify the encryption context. { "Version": "2012-10-17", "Statement": [ { "Action": [ Creating a customer managed key 665 Amazon Transcribe Developer Guide "kms:Encrypt", "kms:Decrypt", "kms:GenerateDataKey" ], "Resource": "arn:aws:kms:us-west-2:123456789012:key/Key_ID", "Effect": "Allow", "Condition": { "StringEquals": { "kms:ViaService": "transcribe.streaming.amazonaws.com", "EncryptionContext":[ "aws:us-east-1:transcribe:medical-scribe:session-id": "1234abcd-12ab-34cd-56ef-123456SAMPLE" ] } } }, { "Action": [ "kms:DescribeKey" ], "Resource": "arn:aws:kms:us-west-2:123456789012:key/Key_ID", "Effect": "Allow", "Condition": { "StringEquals": { "kms:ViaService": "transcribe.streaming.amazonaws.com" } } } ] } The following is trust policy example for the ResourceAccessRole. For DataAccessRole, replace transcribe.streaming.amazonaws.com with transcribe.amazonaws.com. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "transcribe.streaming.amazonaws.com" }, "Action": "sts:AssumeRole", Creating a customer managed key 666 Amazon Transcribe "Condition": { "StringEquals": { "aws:SourceAccount": "123456789012" }, "StringLike": { Developer Guide "aws:SourceArn": "arn:aws:transcribe:us-west-2:123456789012:*" } } } ] } For more information about specifying permissions in a policy or troubleshooting key access, see the AWS Key Management Service Developer Guide. Specifying a customer managed key for AWS HealthScribe You can specify a customer managed key as a second layer encryption for transcription jobs or streaming. • For transcription jobs, you specify your key in the OutputEncryptionKMSKeyId of your StartMedicalScribeJob API operation. • For streaming, you specify the key in the MedicalScribeEncryptionSettings in your MedicalScribeConﬁgurationEvent. AWS KMS encryption context AWS KMS encryption context is a map of plain text, non-secret key:value pairs. This map represents additional authenticated data, known as encryption context pairs, which provide an added layer of security for your data. AWS HealthScribe requires a symmetric encryption key to encrypt AWS HealthScribe output into a customer-speciﬁed Amazon S3 bucket. To learn more, see Asymmetric keys in AWS KMS. When creating your encryption context pairs, do not include sensitive information. Encryption context is not secret — it is visible in plain text within your CloudTrail logs (so you can use it to identify and categorize your cryptographic operations). Your encryption context pair can include special characters, such as underscores (_), dashes (-), slashes (/, \) and colons (:). Specifying a customer managed key for AWS HealthScribe 667 Amazon Transcribe Tip Developer Guide It can be useful to relate the values in your encryption context pair to the data being encrypted. Although not required, we recommend you use non-sensitive metadata related to your encrypted content, such as ﬁle names, header values, or unencrypted database ﬁelds. To use output encryption with the API, set the KMSEncryptionContext parameter in the StartMedicalScribeJob operation. In order to provide encryption context for the output encryption operation, the OutputEncryptionKMSKeyId parameter must reference a symmetric AWS KMS key ID. For streaming, you specify the key value pairs for the KmsEncryptionContext in the MedicalScribeEncryptionSettings in your MedicalScribeConﬁgurationEvent. You can use AWS KMS condition keys with IAM policies to control access to a symmetric encryption AWS KMS key based on the encryption context that was used in the request for a cryptographic operation. For an example encryption context policy, see AWS KMS encryption context policy. Using encryption context is optional, but recommended. For more information, see Encryption context. AWS HealthScribe encryption context AWS HealthScribe uses the same encryption context in all AWS Key Management Service cryptographic operations. The encryption context is a map of String to String that can be customized to anything you want. "encryptionContext": { "ECKey": "ECValue" ... } For AWS HealthScribe streams, the following is the default service generated encryption context. It applies this context on top of any
transcribe-dg-148	transcribe-dg.pdf	148	context that was used in the request for a cryptographic operation. For an example encryption context policy, see AWS KMS encryption context policy. Using encryption context is optional, but recommended. For more information, see Encryption context. AWS HealthScribe encryption context AWS HealthScribe uses the same encryption context in all AWS Key Management Service cryptographic operations. The encryption context is a map of String to String that can be customized to anything you want. "encryptionContext": { "ECKey": "ECValue" ... } For AWS HealthScribe streams, the following is the default service generated encryption context. It applies this context on top of any encryption context that you provide. "encryptionContext": { "aws:<region>:transcribe:medical-scribe:session-id": "1234abcd-12ab-34cd-56ef-123456SAMPLE" } AWS KMS encryption context 668 Amazon Transcribe Developer Guide For AWS HealthScribe transcription jobs, the following is the default service generated encryption context. It applies this context on top of any encryption context that you provide. "encryptionContext": { "aws:<region>:transcribe:medical-scribe:job-name": "<job-name>", "aws:<region>:transcribe:medical-scribe:start-time-epoch-ms": "<job-start-time>" } If you don’t provide any encryption context, only service generated encryption context will be used for all AWS KMS cryptographic operations. Monitoring AWS HealthScribe with encryption context When you use a symmetric customer managed key to encrypt your data at rest in AWS HealthScribe, you can also use the encryption context in audit records and logs to identify how the customer managed key is being used. The encryption context also appears in logs generated by AWS CloudTrail or CloudWatch Logs. Using encryption context to control access to your customer managed key You can use the encryption context in key policies and IAM policies as conditions to control access to your symmetric customer managed key. The following are example key policy statements to grant access to a customer managed key for a speciﬁc encryption context. The condition in this policy statement requires that the KMS key usages have an encryption context constraint that speciﬁes the encryption context. { "Version": "2012-10-17", "Statement": [ { "Sid":"Allow access to the ResourceAccessRole for StartMedicalScribeStream", "Effect":"Allow", "Principal":{ "AWS": "arn:aws:iam::123456789012:role/ResourceAccessRole" }, "Action":[ "kms:Encrypt", "kms:Decrypt", "kms:GenerateDataKey*" ], AWS KMS encryption context 669 Amazon Transcribe Developer Guide "Resource":"arn:aws:kms:us-west-2:123456789012:key/Key_ID", "Condition": { "StringEquals": { // below is the service generated encryption context example "kms:EncryptionContext:aws:us-east-1:transcribe:medical- scribe:session-id":"1234abcd-12ab-34cd-56ef-123456SAMPLE", // plus any encryption context that you specify in the request "kms:EncryptionContext:${ECKey}": "${ECValue}" } } }, { "Sid":"Allow access to the ResourceAccessRole for DescribeKey", "Effect":"Allow", "Principal":{ "AWS": "arn:aws:iam::123456789012:role/ResourceAccessRole" }, "Action": "kms:DescribeKey", "Resource":"arn:aws:kms:us-west-2:123456789012:key/Key_ID" } } Monitoring your encryption keys for AWS HealthScribe When you use an AWS Key Management Service customer managed key with AWS HealthScribe, you can use AWS CloudTrail or CloudWatch logs to track requests that AWS HealthScribe sends to AWS KMS. The following examples are CloudTrail Encrypt and Decrypt events you can use that allow you to monitor how AWS HealthScribe uses of your customer managed key. Encrypt { "eventVersion":"1.09", "userIdentity":{ "type":"AssumedRole", "principalId":"AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn":"arn:aws:sts::123456789012:assumed-role/Admin/Sampleuser01", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE3", "sessionContext":{ "sessionIssuer":{ Monitoring your encryption keys for AWS HealthScribe 670 Amazon Transcribe "type":"Role", Developer Guide "principalId":"AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn":"arn:aws:sts::123456789012:assumed-role/Admin/Sampleuser01", "accountId":"123456789012", "userName":"Admin" }, "attributes":{ "creationDate":"2024-08-16T01:10:05Z", "mfaAuthenticated":"false" } }, "invokedBy":"transcribe.streaming.amazonaws.com" }, "eventTime":"2024-08-16T01:10:05Z", "eventSource":"kms.amazonaws.com", "eventName":"Encrypt", "awsRegion":"us-east-1", "sourceIPAddress":"transcribe.streaming.amazonaws.com", "userAgent":"transcribe.streaming.amazonaws.com", "requestParameters":{ "encryptionContext":{ "aws:us-east-1:transcribe:medical-scribe:session- id":"1234abcd-12ab-34cd-56ef-123456SAMPLE" }, "encryptionAlgorithm":"SYMMETRIC_DEFAULT", "keyId":"1234abcd-12ab-34cd-56ef-1234567890ab" }, "responseElements":null, "requestID":"cbe0ac33-8cca-49e5-9bb5-dc2b8dfcb389", "eventID":"1b9fedde-aa96-48cc-9dd9-a2cce2964b3c", "readOnly":true, "resources":[ { "accountId":"123456789012", "type":"AWS::KMS::Key", "ARN":"arn:aws:kms:us- west-2:123456789012:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType":"AwsApiCall", "managementEvent":true, "recipientAccountId":"123456789012", "eventCategory":"Management" } Monitoring your encryption keys for AWS HealthScribe 671 Amazon Transcribe Developer Guide Decrypt { "eventVersion":"1.09", "userIdentity":{ "type":"AssumedRole", "principalId":"AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn":"arn:aws:sts::123456789012:assumed-role/Admin/Sampleuser01", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE3", "sessionContext":{ "sessionIssuer":{ "type":"Role", "principalId":"AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn":"arn:aws:sts::123456789012:assumed-role/Admin/Sampleuser01", "accountId":"123456789012", "userName":"Admin" }, "attributes":{ "creationDate":"2024-08-16T20:47:04Z", "mfaAuthenticated":"false" } }, "invokedBy":"transcribe.streaming.amazonaws.com" }, "eventTime":"2024-08-16T20:47:04Z", "eventSource":"kms.amazonaws.com", "eventName":"Decrypt", "awsRegion":"us-east-1", "sourceIPAddress":"transcribe.streaming.amazonaws.com", "userAgent":"transcribe.streaming.amazonaws.com", "requestParameters":{ "keyId":"mrk-de27f019178f4fbf86512ab03ba860be", "encryptionAlgorithm":"SYMMETRIC_DEFAULT", "encryptionContext":{ "aws:us-east-1:transcribe:medical-scribe:session- id":"1234abcd-12ab-34cd-56ef-123456SAMPLE" } }, "responseElements":null, Monitoring your encryption keys for AWS HealthScribe 672 Amazon Transcribe Developer Guide "requestID":"8b7fb865-48be-4e03-ac3d-e7bee3ba30a1", "eventID":"68b7a263-d410-4701-9e2b-20c196628966", "readOnly":true, "resources":[ { "accountId":"123456789012", "type":"AWS::KMS::Key", "ARN":"arn:aws:kms:us- west-2:123456789012:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType":"AwsApiCall", "managementEvent":true, "recipientAccountId":"123456789012", "eventCategory":"Management" } Monitoring your encryption keys for AWS HealthScribe 673 Amazon Transcribe Developer Guide Document history for Amazon Transcribe • Latest documentation update: 13 November 2023 The following table describes important changes in each release of Amazon Transcribe. For notiﬁcation about updates to this documentation, you can subscribe to an RSS feed. Change New feature New feature Section Update Section Update Section Update Description Date AWS HealthScribe now supports a GIRPP template for the clinical note summary. For more information, see AWS HealthScribe Clinical Documentation ﬁle. AWS HealthScribe now supports streaming for transcribing medical conversations in real time. February 4, 2025 January 29, 2025 Updating ar-SA language support for 8000 frequency. January 16, 2025 Updating ar-SA language support for 8000 frequency. January 16, 2025 January 14, 2025 Updating the supported language section with unsupported language code that we do not support in AWS GovCloud (US) (US- West, us-gov-west-1), AWS GovCloud (US) (US-East, us- gov-east-1), or Africa (Cape Town, af-south-1) regions. 674 Amazon Transcribe Section Update Feature Update Section Update Section Update Feature Update Section Update Feature Update Feature Update Section Update New languages Extend Transcribe Batch json output with new ﬁeld called "audio_segments". July 15, 2024 Update Max Speakers in
transcribe-dg-149	transcribe-dg.pdf	149	2025 January 29, 2025 Updating ar-SA language support for 8000 frequency. January 16, 2025 Updating ar-SA language support for 8000 frequency. January 16, 2025 January 14, 2025 Updating the supported language section with unsupported language code that we do not support in AWS GovCloud (US) (US- West, us-gov-west-1), AWS GovCloud (US) (US-East, us- gov-east-1), or Africa (Cape Town, af-south-1) regions. 674 Amazon Transcribe Section Update Feature Update Section Update Section Update Feature Update Section Update Feature Update Feature Update Section Update New languages Extend Transcribe Batch json output with new ﬁeld called "audio_segments". July 15, 2024 Update Max Speakers in diarization to be 30 instead of May 10, 2024 10. Updates to generative call summarization and add error output details. Updates on custom vocabular y columns - IPA and SoundsLike. April 30, 2024 April 30, 2024 Amazon Transcribe Call Analytics now supports generative call summariza tion. Update new PII redaction and Language Identiﬁcation output format. Diarization can now be combined with channel identiﬁcation. Channel identiﬁcation can now be combined with diarization. November 29, 2023 November 13, 2023 March 6, 2023 March 6, 2023 IAM best practices have been updated. February 13, 2023 Amazon Transcribe now supports Vietnamese and Swedish. December 6, 2022 Developer Guide 675 Amazon Transcribe New feature Feature Update Section Update Section Update Section Update Guide Update New chapter New chapter Feature update Chapter update Developer Guide November 28, 2022 November 11, 2022 September 14, 2022 Amazon Transcribe now supports real-time Call Analytics. Streaming redaction and identiﬁcation is now available with Hindi and Thai. New PII categories are available for streaming redaction and identiﬁcation. The custom language model section has been revised. June 18, 2022 Batch language identiﬁcation can now identify multiple languages per audio ﬁle. May 31, 2022 The Amazon Transcribe API Reference is now a standalone April 1, 2022 guide. March 21, 2022 A new comparison table for Amazon Transcribe, Amazon Transcribe Medical, and Amazon Transcribe Call Analytics is included. A new SDK code examples chapter is included. March 21, 2022 Call Analytics now provides call summarization. March 21, 2022 The introductory chapter now showcases Amazon Transcribe use cases. March 21, 2022 676 Amazon Transcribe Chapter update The Getting started chapter has been updated to be method-speciﬁc. March 21, 2022 Developer Guide Chapter update The Streaming chapter has been updated and restructu March 21, 2022 Feature update New event Section update New feature New feature New feature red. Language identiﬁcation now supports custom vocabularies and custom vocabulary ﬁlters with streaming transcriptions. March 11, 2022 There is a new event type: Vocabulary events. February 7, 2022 Updates have been made to the custom vocabularies section. Language identiﬁcation can now be used with streaming transcriptions. Language identiﬁcation can now be used with custom language models, custom vocabularies, vocabular y ﬁltering, and content redaction. Amazon Transcribe now supports custom language models with streaming transcriptions. January 20, 2022 November 23, 2021 October 29, 2021 October 20, 2021 677 Amazon Transcribe New feature New feature New feature New languages New feature New feature New feature New feature Amazon Transcribe can now generate subtitles for your video ﬁles. Amazon Transcribe now supports PII redaction and identiﬁcation for streaming. Amazon Transcribe now supports AWS KMS encryptio n context for an added level of security for your AWS account resources. Amazon Transcribe now supports Afrikaans, Danish, Mandarin Chinese (Traditio nal), Thai, New Zealand English, and South African English. Amazon Transcribe now supports resource tagging. Amazon Transcribe now supports Call Analytics for batch transcription jobs. Amazon Transcribe now supports using custom vocabularies with batch custom language models. Amazon Transcribe now supports partial result stabilization for streaming transcription. Developer Guide September 16, 2021 September 14, 2021 September 10, 2021 August 26, 2021 August 24, 2021 August 4, 2021 May 12, 2021 May 11, 2021 678 Amazon Transcribe New feature New feature New languages AWS Region expansion New feature New feature New feature New feature Amazon Transcribe now supports Australian English, British English, Hindi, and US Spanish for custom language models. Amazon Transcribe now supports OGG/OPUS and FLAC codecs for streaming audio transcription. Amazon Transcribe adds support for Italian and German for streaming audio transcription. Amazon Transcribe is now available in the Frankfurt (eu- central-1) and London (eu- west-2). Amazon Transcribe adds support for interface VPC endpoints in batch transcrip tion. Amazon Transcribe adds support for channel identiﬁc ation in streaming. Amazon Transcribe adds support for automatic language identiﬁcation in batch transcription. Amazon Transcribe adds support for speaker partition ing in streaming. Developer Guide March 19, 2021 November 24, 2020 November 4, 2020 November 4, 2020 October 9, 2020 September 17, 2020 September 15, 2020 August 19, 2020 679 Amazon Transcribe New feature New feature New feature New feature New feature New feature New languages AWS Region expansion Amazon Transcribe adds support for custom language August 5,
transcribe-dg-150	transcribe-dg.pdf	150	(eu- west-2). Amazon Transcribe adds support for interface VPC endpoints in batch transcrip tion. Amazon Transcribe adds support for channel identiﬁc ation in streaming. Amazon Transcribe adds support for automatic language identiﬁcation in batch transcription. Amazon Transcribe adds support for speaker partition ing in streaming. Developer Guide March 19, 2021 November 24, 2020 November 4, 2020 November 4, 2020 October 9, 2020 September 17, 2020 September 15, 2020 August 19, 2020 679 Amazon Transcribe New feature New feature New feature New feature New feature New feature New languages AWS Region expansion Amazon Transcribe adds support for custom language August 5, 2020 Developer Guide models. Amazon Transcribe adds support for interface VPC endpoints in streaming. Amazon Transcribe adds support for vocabulary ﬁltering in streaming. Amazon Transcribe adds support for automatically redacting personally identiﬁa ble information. Amazon Transcribe adds support for creating a custom vocabulary of words to ﬁlter from a transcription. Amazon Transcribe adds support for queueing transcription jobs. Amazon Transcribe adds support for Gulf Arabic, Hebrew, Japanese, Malay, Swiss German, Telugu, and Turkish. Amazon Transcribe is now available in the Asia Paciﬁc (Tokyo) (ap-northeast-1). June 26, 2020 May 20, 2020 February 26, 2020 December 20, 2019 December 19, 2019 November 21, 2019 November 21, 2019 680 Amazon Transcribe New feature New languages New language AWS Region expansion New feature New languages New feature Amazon Transcribe adds support for alternative transcriptions. Amazon Transcribe adds support for Dutch, Farsi, Indonesian, Irish English, Portuguese, Scottish English, Tamil, and Welsh English. Amazon Transcribe now supports streaming transcrip tion for Australian English (en-AU). Amazon Transcribe is now available in the China (Beijing) (cn-north-1) and China (Ningxia) (cn-northwest-1). Amazon Transcribe allows you to provide your own KMS key to encrypt your transcription output ﬁles. For more information, see the OutputEncryptionKMSKeyId parameter of the StartStre amTranscription API. Amazon Transcribe adds support for Chinese (Mandarin), Simpliﬁed, Mainland China and Russian. Amazon Transcribe adds support for streaming audio transcription using the WebSocket protocol. Developer Guide November 20, 2019 November 12, 2019 October 25, 2019 October 9, 2019 September 24, 2019 August 23, 2019 July 19, 2019 681 Amazon Transcribe New feature AWS Region expansion New language New feature New language New SDK New language AWS Region expansion New language AWS CloudTrail now records events for the StartStre amTranscription API. Amazon Transcribe is now available in the US West (N. California) (us-west-1). July 19, 2019 June 27, 2019 Amazon Transcribe adds support for Modern Standard May 28, 2019 Arabic. May 23, 2019 Amazon Transcribe now transcribes numeric words into numbers for US English. For example, "forty-two" is transcribed as "42". Amazon Transcribe adds support for Hindi and Indian May 15, 2019 English. The AWS SDK for C++ now supports Amazon Transcribe. May 8, 2019 Amazon Transcribe adds support for Spanish. April 19, 2019 April 18, 2019 April 5, 2019 Amazon Transcribe is now available in the EU (Frankfurt) (eu-central-1) and Asia Paciﬁc (Seoul) (ap-northeast-2). Amazon Transcribe adds support for streaming transcription in British English, French, and Canadian French. Developer Guide 682 Amazon Transcribe New feature New feature New languages New language AWS Region expansion AWS Region expansion New languages The AWS SDK for Ruby V3 now supports Amazon Transcribe Amazon Transcribe allows custom vocabularies, which are lists of speciﬁc words that you want Amazon Transcrib e to recognize in your audio input. Amazon Transcribe adds support for German and Korean. Amazon Transcribe now supports streaming transcrip tion for US Spanish (es-US). Amazon Transcribe is now available in the South America (São Paulo) (sa-east- 1). Amazon Transcribe is now available in the Asia Paciﬁc (Mumbai) (ap-south-1), Asia Paciﬁc (Singapore) (ap-south east-1), EU (London) (eu- west-2), and EU (Paris) (eu- west3). Amazon Transcribe adds support for French, Italian, and Brazilian Portuguese. March 25, 2019 March 25, 2019 March 22, 2019 February 7, 2019 February 7, 2019 January 24, 2019 December 20, 2018 Developer Guide 683 Amazon Transcribe New feature New languages AWS Region expansion New feature New feature New feature New guide Developer Guide November 19, 2018 November 15, 2018 July 17, 2018 July 11, 2018 June 28, 2018 Amazon Transcribe now supports transcription of audio streams. Amazon Transcribe adds support for Australian English, British English, and Canadian French. Amazon Transcribe is now available in Canada (Central) (ca-central-1) and Asia Paciﬁc (Sydney) (ap-southeast-2). You can now specify your own location to store the output from a transcription job. Added AWS CloudTrail and Amazon CloudWatch Events integration. Amazon Transcribe adds support for custom vocabular April 4, 2018 ies. This is the ﬁrst release of the Amazon Transcribe Developer Guide. November 29, 2017 684 Amazon Transcribe Developer Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. 685
transferfamily-api-001	transferfamily-api.pdf	1	API Reference AWS Transfer Family Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Transfer Family API Reference AWS Transfer Family: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Transfer Family Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 4 CreateAccess .................................................................................................................................................. 7 Request Syntax ........................................................................................................................................ 7 Request Parameters ................................................................................................................................ 7 Response Syntax ................................................................................................................................... 11 Response Elements ............................................................................................................................... 11 Errors ....................................................................................................................................................... 12 See Also .................................................................................................................................................. 13 CreateAgreement ........................................................................................................................................ 14 Request Syntax ...................................................................................................................................... 14 Request Parameters .............................................................................................................................. 15 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 19 Examples ................................................................................................................................................. 20 See Also .................................................................................................................................................. 21 CreateConnector ......................................................................................................................................... 22 Request Syntax ...................................................................................................................................... 22 Request Parameters .............................................................................................................................. 23 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 25 Errors ....................................................................................................................................................... 26 Examples ................................................................................................................................................. 26 See Also .................................................................................................................................................. 28 CreateProﬁle ................................................................................................................................................ 30 Request Syntax ...................................................................................................................................... 30 Request Parameters .............................................................................................................................. 30 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 32 Examples ................................................................................................................................................. 33 See Also .................................................................................................................................................. 33 CreateServer ................................................................................................................................................ 35 iii AWS Transfer Family API Reference Request Syntax ...................................................................................................................................... 35 Request Parameters .............................................................................................................................. 36 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 45 Examples ................................................................................................................................................. 46 See Also .................................................................................................................................................. 47 CreateUser .................................................................................................................................................... 48 Request Syntax ...................................................................................................................................... 48 Request Parameters .............................................................................................................................. 49 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 54 Examples ................................................................................................................................................. 55 See Also .................................................................................................................................................. 55 CreateWebApp ............................................................................................................................................ 57 Request Syntax ...................................................................................................................................... 57 Request Parameters .............................................................................................................................. 57 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 59 See Also .................................................................................................................................................. 60 CreateWorkﬂow .......................................................................................................................................... 61 Request Syntax ...................................................................................................................................... 61 Request Parameters .............................................................................................................................. 64 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 66 Examples ................................................................................................................................................. 67 See Also .................................................................................................................................................. 68 DeleteAccess ................................................................................................................................................ 70 Request Syntax ...................................................................................................................................... 70 Request Parameters .............................................................................................................................. 70 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 72 iv AWS Transfer Family API Reference DeleteAgreement ........................................................................................................................................ 73 Request Syntax ...................................................................................................................................... 73 Request Parameters .............................................................................................................................. 73 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 74 DeleteCertiﬁcate ......................................................................................................................................... 76 Request Syntax ...................................................................................................................................... 76 Request Parameters .............................................................................................................................. 76 Response Elements ............................................................................................................................... 76 Errors ....................................................................................................................................................... 76 See Also .................................................................................................................................................. 77 DeleteConnector ......................................................................................................................................... 78 Request Syntax ...................................................................................................................................... 78 Request Parameters .............................................................................................................................. 78 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 DeleteHostKey ............................................................................................................................................. 80 Request Syntax ...................................................................................................................................... 80 Request Parameters .............................................................................................................................. 80 Response Elements ............................................................................................................................... 81 Errors ....................................................................................................................................................... 81 See Also .................................................................................................................................................. 81 DeleteProﬁle ................................................................................................................................................ 83 Request Syntax ...................................................................................................................................... 83 Request Parameters .............................................................................................................................. 83 Response Elements ............................................................................................................................... 83 Errors ....................................................................................................................................................... 83 See Also .................................................................................................................................................. 84 DeleteServer ................................................................................................................................................ 85 Request Syntax ...................................................................................................................................... 85 Request Parameters .............................................................................................................................. 85 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 85 Examples ................................................................................................................................................. 86 v AWS Transfer Family API Reference See Also .................................................................................................................................................. 87 DeleteSshPublicKey .................................................................................................................................... 88 Request Syntax ...................................................................................................................................... 88 Request Parameters .............................................................................................................................. 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 89 Examples ................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 DeleteUser .................................................................................................................................................... 91 Request Syntax ...................................................................................................................................... 91 Request Parameters .............................................................................................................................. 91 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 92 Examples ................................................................................................................................................. 92 See Also .................................................................................................................................................. 93 DeleteWebApp ............................................................................................................................................ 94 Request Syntax ...................................................................................................................................... 94 Request Parameters .............................................................................................................................. 94 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 94 See Also .................................................................................................................................................. 95 DeleteWebAppCustomization .................................................................................................................. 96 Request Syntax ...................................................................................................................................... 96 Request Parameters .............................................................................................................................. 96 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 96 See Also .................................................................................................................................................. 97 DeleteWorkﬂow .......................................................................................................................................... 99 Request Syntax ...................................................................................................................................... 99 Request Parameters .............................................................................................................................. 99 Response Elements ............................................................................................................................... 99 Errors ....................................................................................................................................................... 99 See Also ................................................................................................................................................ 100 DescribeAccess .......................................................................................................................................... 101 Request Syntax .................................................................................................................................... 101 Request Parameters ........................................................................................................................... 101 vi AWS Transfer Family API Reference Response Syntax ................................................................................................................................. 102 Response Elements ............................................................................................................................ 102 Errors ..................................................................................................................................................... 103 See Also ................................................................................................................................................ 104 DescribeAgreement .................................................................................................................................. 105 Request Syntax .................................................................................................................................... 105 Request Parameters ........................................................................................................................... 105 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 106 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 107 DescribeCertiﬁcate ................................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Syntax ................................................................................................................................. 109 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 110 See Also ................................................................................................................................................ 111 DescribeConnector ................................................................................................................................... 112 Request Syntax .................................................................................................................................... 112 Request Parameters ........................................................................................................................... 112 Response Syntax ................................................................................................................................. 112 Response Elements ............................................................................................................................ 113 Errors ..................................................................................................................................................... 113 See Also ................................................................................................................................................ 114 DescribeExecution .................................................................................................................................... 115 Request Syntax .................................................................................................................................... 115 Request Parameters ........................................................................................................................... 115 Response Syntax ................................................................................................................................. 116 Response Elements ............................................................................................................................ 117 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 118 DescribeHostKey ....................................................................................................................................... 120 Request Syntax .................................................................................................................................... 120 Request Parameters ........................................................................................................................... 120 Response Syntax ................................................................................................................................. 121 vii AWS Transfer Family API Reference Response Elements ............................................................................................................................
transferfamily-api-002	transferfamily-api.pdf	2	109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Syntax ................................................................................................................................. 109 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 110 See Also ................................................................................................................................................ 111 DescribeConnector ................................................................................................................................... 112 Request Syntax .................................................................................................................................... 112 Request Parameters ........................................................................................................................... 112 Response Syntax ................................................................................................................................. 112 Response Elements ............................................................................................................................ 113 Errors ..................................................................................................................................................... 113 See Also ................................................................................................................................................ 114 DescribeExecution .................................................................................................................................... 115 Request Syntax .................................................................................................................................... 115 Request Parameters ........................................................................................................................... 115 Response Syntax ................................................................................................................................. 116 Response Elements ............................................................................................................................ 117 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 118 DescribeHostKey ....................................................................................................................................... 120 Request Syntax .................................................................................................................................... 120 Request Parameters ........................................................................................................................... 120 Response Syntax ................................................................................................................................. 121 vii AWS Transfer Family API Reference Response Elements ............................................................................................................................ 121 Errors ..................................................................................................................................................... 121 See Also ................................................................................................................................................ 122 DescribeProﬁle .......................................................................................................................................... 123 Request Syntax .................................................................................................................................... 123 Request Parameters ........................................................................................................................... 123 Response Syntax ................................................................................................................................. 123 Response Elements ............................................................................................................................ 124 Errors ..................................................................................................................................................... 124 See Also ................................................................................................................................................ 125 DescribeSecurityPolicy ............................................................................................................................ 126 Request Syntax .................................................................................................................................... 126 Request Parameters ........................................................................................................................... 126 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 127 Errors ..................................................................................................................................................... 127 Examples ............................................................................................................................................... 128 See Also ................................................................................................................................................ 129 DescribeServer .......................................................................................................................................... 130 Request Syntax .................................................................................................................................... 130 Request Parameters ........................................................................................................................... 130 Response Syntax ................................................................................................................................. 130 Response Elements ............................................................................................................................ 132 Errors ..................................................................................................................................................... 132 Examples ............................................................................................................................................... 133 See Also ................................................................................................................................................ 134 DescribeUser .............................................................................................................................................. 135 Request Syntax .................................................................................................................................... 135 Request Parameters ........................................................................................................................... 135 Response Syntax ................................................................................................................................. 136 Response Elements ............................................................................................................................ 137 Errors ..................................................................................................................................................... 137 Examples ............................................................................................................................................... 138 See Also ................................................................................................................................................ 139 DescribeWebApp ...................................................................................................................................... 140 Request Syntax .................................................................................................................................... 140 viii AWS Transfer Family API Reference Request Parameters ........................................................................................................................... 140 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 141 See Also ................................................................................................................................................ 142 DescribeWebAppCustomization ............................................................................................................ 143 Request Syntax .................................................................................................................................... 143 Request Parameters ........................................................................................................................... 143 Response Syntax ................................................................................................................................. 143 Response Elements ............................................................................................................................ 144 Errors ..................................................................................................................................................... 144 See Also ................................................................................................................................................ 145 DescribeWorkﬂow .................................................................................................................................... 146 Request Syntax .................................................................................................................................... 146 Request Parameters ........................................................................................................................... 146 Response Syntax ................................................................................................................................. 146 Response Elements ............................................................................................................................ 149 Errors ..................................................................................................................................................... 149 See Also ................................................................................................................................................ 150 ImportCertiﬁcate ...................................................................................................................................... 151 Request Syntax .................................................................................................................................... 151 Request Parameters ........................................................................................................................... 151 Response Syntax ................................................................................................................................. 154 Response Elements ............................................................................................................................ 154 Errors ..................................................................................................................................................... 154 Examples ............................................................................................................................................... 155 See Also ................................................................................................................................................ 155 ImportHostKey .......................................................................................................................................... 157 Request Syntax .................................................................................................................................... 157 Request Parameters ........................................................................................................................... 157 Response Syntax ................................................................................................................................. 158 Response Elements ............................................................................................................................ 158 Errors ..................................................................................................................................................... 159 See Also ................................................................................................................................................ 160 ImportSshPublicKey ................................................................................................................................. 161 Request Syntax .................................................................................................................................... 161 ix AWS Transfer Family API Reference Request Parameters ........................................................................................................................... 161 Response Syntax ................................................................................................................................. 162 Response Elements ............................................................................................................................ 162 Errors ..................................................................................................................................................... 163 Examples ............................................................................................................................................... 164 See Also ................................................................................................................................................ 164 ListAccesses ............................................................................................................................................... 166 Request Syntax .................................................................................................................................... 166 Request Parameters ........................................................................................................................... 166 Response Syntax ................................................................................................................................. 167 Response Elements ............................................................................................................................ 167 Errors ..................................................................................................................................................... 168 See Also ................................................................................................................................................ 169 ListAgreements ......................................................................................................................................... 170 Request Syntax .................................................................................................................................... 170 Request Parameters ........................................................................................................................... 170 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 171 Errors ..................................................................................................................................................... 172 See Also ................................................................................................................................................ 173 ListCertiﬁcates .......................................................................................................................................... 174 Request Syntax .................................................................................................................................... 174 Request Parameters ........................................................................................................................... 174 Response Syntax ................................................................................................................................. 175 Response Elements ............................................................................................................................ 175 Errors ..................................................................................................................................................... 175 See Also ................................................................................................................................................ 176 ListConnectors .......................................................................................................................................... 178 Request Syntax .................................................................................................................................... 178 Request Parameters ........................................................................................................................... 178 Response Syntax ................................................................................................................................. 178 Response Elements ............................................................................................................................ 179 Errors ..................................................................................................................................................... 179 See Also ................................................................................................................................................ 180 ListExecutions ........................................................................................................................................... 181 Request Syntax .................................................................................................................................... 181 x AWS Transfer Family API Reference Request Parameters ........................................................................................................................... 181 Response Syntax ................................................................................................................................. 182 Response Elements ............................................................................................................................ 183 Errors ..................................................................................................................................................... 184 See Also ................................................................................................................................................ 184 ListFileTransferResults ............................................................................................................................. 186 Request Syntax .................................................................................................................................... 186 Request Parameters ........................................................................................................................... 186 Response Syntax ................................................................................................................................. 187 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 188 Examples ............................................................................................................................................... 189 See Also ................................................................................................................................................ 190 ListHostKeys .............................................................................................................................................. 191 Request Syntax .................................................................................................................................... 191 Request Parameters ........................................................................................................................... 191 Response Syntax ................................................................................................................................. 192 Response Elements ............................................................................................................................ 192 Errors ..................................................................................................................................................... 193 See Also ................................................................................................................................................ 194 ListProﬁles ................................................................................................................................................. 195 Request Syntax .................................................................................................................................... 195 Request Parameters ........................................................................................................................... 195 Response Syntax ................................................................................................................................. 196 Response Elements ............................................................................................................................ 196 Errors ..................................................................................................................................................... 197 See Also ................................................................................................................................................ 197 ListSecurityPolicies ................................................................................................................................... 199 Request Syntax .................................................................................................................................... 199 Request Parameters ........................................................................................................................... 199 Response Syntax ................................................................................................................................. 200 Response Elements ............................................................................................................................ 200 Errors ..................................................................................................................................................... 200 Examples ............................................................................................................................................... 201 See Also ................................................................................................................................................ 202 ListServers ................................................................................................................................................. 203 xi AWS Transfer Family API Reference Request Syntax .................................................................................................................................... 203 Request Parameters ........................................................................................................................... 203 Response Syntax ................................................................................................................................. 203 Response Elements ............................................................................................................................ 204 Errors ..................................................................................................................................................... 204 Examples ............................................................................................................................................... 205 See Also ................................................................................................................................................ 206 ListTagsForResource ................................................................................................................................ 207 Request Syntax .................................................................................................................................... 207 Request Parameters ........................................................................................................................... 207 Response Syntax ................................................................................................................................. 208 Response Elements ............................................................................................................................ 208 Errors ..................................................................................................................................................... 209 Examples ............................................................................................................................................... 210 See Also ................................................................................................................................................ 210 ListUsers ..................................................................................................................................................... 212 Request Syntax .................................................................................................................................... 212 Request Parameters ........................................................................................................................... 212 Response Syntax ................................................................................................................................. 213 Response Elements ............................................................................................................................ 213 Errors ..................................................................................................................................................... 214 Examples ............................................................................................................................................... 215 See Also ................................................................................................................................................ 216 ListWebApps .............................................................................................................................................. 217 Request Syntax .................................................................................................................................... 217 Request Parameters ........................................................................................................................... 217 Response Syntax ................................................................................................................................. 217 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 218 See Also ................................................................................................................................................ 219 ListWorkﬂows ............................................................................................................................................ 220 Request Syntax .................................................................................................................................... 220 Request Parameters ........................................................................................................................... 220 Response Syntax ................................................................................................................................. 220 Response Elements ............................................................................................................................ 221 Errors ..................................................................................................................................................... 221 xii AWS Transfer Family API Reference See Also ................................................................................................................................................ 222 SendWorkﬂowStepState ......................................................................................................................... 223 Request Syntax .................................................................................................................................... 223 Request
transferfamily-api-003	transferfamily-api.pdf	3	210 See Also ................................................................................................................................................ 210 ListUsers ..................................................................................................................................................... 212 Request Syntax .................................................................................................................................... 212 Request Parameters ........................................................................................................................... 212 Response Syntax ................................................................................................................................. 213 Response Elements ............................................................................................................................ 213 Errors ..................................................................................................................................................... 214 Examples ............................................................................................................................................... 215 See Also ................................................................................................................................................ 216 ListWebApps .............................................................................................................................................. 217 Request Syntax .................................................................................................................................... 217 Request Parameters ........................................................................................................................... 217 Response Syntax ................................................................................................................................. 217 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 218 See Also ................................................................................................................................................ 219 ListWorkﬂows ............................................................................................................................................ 220 Request Syntax .................................................................................................................................... 220 Request Parameters ........................................................................................................................... 220 Response Syntax ................................................................................................................................. 220 Response Elements ............................................................................................................................ 221 Errors ..................................................................................................................................................... 221 xii AWS Transfer Family API Reference See Also ................................................................................................................................................ 222 SendWorkﬂowStepState ......................................................................................................................... 223 Request Syntax .................................................................................................................................... 223 Request Parameters ........................................................................................................................... 223 Response Elements ............................................................................................................................ 224 Errors ..................................................................................................................................................... 224 See Also ................................................................................................................................................ 225 StartDirectoryListing ............................................................................................................................... 227 Request Syntax .................................................................................................................................... 227 Request Parameters ........................................................................................................................... 228 Response Syntax ................................................................................................................................. 229 Response Elements ............................................................................................................................ 229 Errors ..................................................................................................................................................... 230 Examples ............................................................................................................................................... 230 See Also ................................................................................................................................................ 232 StartFileTransfer ....................................................................................................................................... 233 Request Syntax .................................................................................................................................... 233 Request Parameters ........................................................................................................................... 233 Response Syntax ................................................................................................................................. 235 Response Elements ............................................................................................................................ 235 Errors ..................................................................................................................................................... 236 Examples ............................................................................................................................................... 236 See Also ................................................................................................................................................ 238 StartRemoteDelete .................................................................................................................................. 239 Request Syntax .................................................................................................................................... 239 Request Parameters ........................................................................................................................... 239 Response Syntax ................................................................................................................................. 240 Response Elements ............................................................................................................................ 240 Errors ..................................................................................................................................................... 240 Examples ............................................................................................................................................... 241 See Also ................................................................................................................................................ 241 StartRemoteMove .................................................................................................................................... 243 Request Syntax .................................................................................................................................... 243 Request Parameters ........................................................................................................................... 243 Response Syntax ................................................................................................................................. 244 Response Elements ............................................................................................................................ 244 xiii AWS Transfer Family API Reference Errors ..................................................................................................................................................... 244 Examples ............................................................................................................................................... 245 See Also ................................................................................................................................................ 245 StartServer ................................................................................................................................................ 247 Request Syntax .................................................................................................................................... 247 Request Parameters ........................................................................................................................... 247 Response Elements ............................................................................................................................ 247 Errors ..................................................................................................................................................... 247 Examples ............................................................................................................................................... 248 See Also ................................................................................................................................................ 249 StopServer ................................................................................................................................................. 250 Request Syntax .................................................................................................................................... 250 Request Parameters ........................................................................................................................... 250 Response Elements ............................................................................................................................ 251 Errors ..................................................................................................................................................... 251 Examples ............................................................................................................................................... 251 See Also ................................................................................................................................................ 252 TagResource .............................................................................................................................................. 253 Request Syntax .................................................................................................................................... 253 Request Parameters ........................................................................................................................... 253 Response Elements ............................................................................................................................ 254 Errors ..................................................................................................................................................... 254 Examples ............................................................................................................................................... 254 See Also ................................................................................................................................................ 255 TestConnection ......................................................................................................................................... 257 Request Syntax .................................................................................................................................... 257 Request Parameters ........................................................................................................................... 257 Response Syntax ................................................................................................................................. 257 Response Elements ............................................................................................................................ 258 Errors ..................................................................................................................................................... 259 Examples ............................................................................................................................................... 259 See Also ................................................................................................................................................ 260 TestIdentityProvider ................................................................................................................................ 261 Request Syntax .................................................................................................................................... 261 Request Parameters ........................................................................................................................... 262 Response Syntax ................................................................................................................................. 263 xiv AWS Transfer Family API Reference Response Elements ............................................................................................................................ 263 Errors ..................................................................................................................................................... 264 Examples ............................................................................................................................................... 265 See Also ................................................................................................................................................ 267 UntagResource .......................................................................................................................................... 268 Request Syntax .................................................................................................................................... 268 Request Parameters ........................................................................................................................... 268 Response Elements ............................................................................................................................ 269 Errors ..................................................................................................................................................... 269 Examples ............................................................................................................................................... 269 See Also ................................................................................................................................................ 270 UpdateAccess ............................................................................................................................................ 271 Request Syntax .................................................................................................................................... 271 Request Parameters ........................................................................................................................... 271 Response Syntax ................................................................................................................................. 275 Response Elements ............................................................................................................................ 275 Errors ..................................................................................................................................................... 276 See Also ................................................................................................................................................ 277 UpdateAgreement .................................................................................................................................... 278 Request Syntax .................................................................................................................................... 278 Request Parameters ........................................................................................................................... 278 Response Syntax ................................................................................................................................. 282 Response Elements ............................................................................................................................ 283 Errors ..................................................................................................................................................... 283 See Also ................................................................................................................................................ 284 UpdateCertiﬁcate ..................................................................................................................................... 285 Request Syntax .................................................................................................................................... 285 Request Parameters ........................................................................................................................... 285 Response Syntax ................................................................................................................................. 286 Response Elements ............................................................................................................................ 286 Errors ..................................................................................................................................................... 286 Examples ............................................................................................................................................... 287 See Also ................................................................................................................................................ 288 UpdateConnector ..................................................................................................................................... 289 Request Syntax .................................................................................................................................... 289 Request Parameters ........................................................................................................................... 289 xv AWS Transfer Family API Reference Response Syntax ................................................................................................................................. 292 Response Elements ............................................................................................................................ 292 Errors ..................................................................................................................................................... 292 See Also ................................................................................................................................................ 293 UpdateHostKey ......................................................................................................................................... 295 Request Syntax .................................................................................................................................... 295 Request Parameters ........................................................................................................................... 295 Response Syntax ................................................................................................................................. 296 Response Elements ............................................................................................................................ 296 Errors ..................................................................................................................................................... 297 See Also ................................................................................................................................................ 297 UpdateProﬁle ............................................................................................................................................ 299 Request Syntax .................................................................................................................................... 299 Request Parameters ........................................................................................................................... 299 Response Syntax ................................................................................................................................. 300 Response Elements ............................................................................................................................ 300 Errors ..................................................................................................................................................... 300 See Also ................................................................................................................................................ 301 UpdateServer ............................................................................................................................................ 302 Request Syntax .................................................................................................................................... 302 Request Parameters ........................................................................................................................... 303 Response Syntax ................................................................................................................................. 310 Response Elements ............................................................................................................................ 311 Errors ..................................................................................................................................................... 311 Examples ............................................................................................................................................... 312 See Also ................................................................................................................................................ 313 UpdateUser ................................................................................................................................................ 314 Request Syntax .................................................................................................................................... 314 Request Parameters ........................................................................................................................... 315 Response Syntax ................................................................................................................................. 318 Response Elements ............................................................................................................................ 318 Errors ..................................................................................................................................................... 319 Examples ............................................................................................................................................... 320 See Also ................................................................................................................................................ 321 UpdateWebApp ........................................................................................................................................ 322 Request Syntax .................................................................................................................................... 322 xvi AWS Transfer Family API Reference Request Parameters ........................................................................................................................... 322 Response Syntax ................................................................................................................................. 323 Response Elements ............................................................................................................................ 323 Errors ..................................................................................................................................................... 324 See Also ................................................................................................................................................ 324 UpdateWebAppCustomization .............................................................................................................. 326 Request Syntax .................................................................................................................................... 326 Request Parameters ........................................................................................................................... 326 Response Syntax ................................................................................................................................. 327 Response Elements ............................................................................................................................ 327 Errors ..................................................................................................................................................... 327 See Also ................................................................................................................................................ 328 Data Types ................................................................................................................................... 330 As2ConnectorConﬁg ................................................................................................................................ 333 Contents ............................................................................................................................................... 333 See Also ................................................................................................................................................ 336 ConnectorFileTransferResult .................................................................................................................. 337 Contents ............................................................................................................................................... 337 See Also ................................................................................................................................................ 338 CopyStepDetails ....................................................................................................................................... 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 340 CustomDirectoriesType ........................................................................................................................... 341 Contents ............................................................................................................................................... 341 See Also ................................................................................................................................................ 342 CustomStepDetails ................................................................................................................................... 343 Contents ............................................................................................................................................... 343 See Also ................................................................................................................................................ 344 DecryptStepDetails .................................................................................................................................. 345 Contents ............................................................................................................................................... 345 See Also ................................................................................................................................................ 346 DeleteStepDetails ..................................................................................................................................... 348 Contents ............................................................................................................................................... 348 See Also ................................................................................................................................................ 348 DescribedAccess ........................................................................................................................................ 350 Contents ............................................................................................................................................... 350 xvii AWS Transfer Family API Reference See Also ................................................................................................................................................ 353 DescribedAgreement ............................................................................................................................... 354 Contents ............................................................................................................................................... 354 See Also ................................................................................................................................................ 358 DescribedCertiﬁcate ................................................................................................................................. 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 362 DescribedConnector ................................................................................................................................. 363 Contents ............................................................................................................................................... 363 See Also ................................................................................................................................................
transferfamily-api-004	transferfamily-api.pdf	4	337 See Also ................................................................................................................................................ 338 CopyStepDetails ....................................................................................................................................... 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 340 CustomDirectoriesType ........................................................................................................................... 341 Contents ............................................................................................................................................... 341 See Also ................................................................................................................................................ 342 CustomStepDetails ................................................................................................................................... 343 Contents ............................................................................................................................................... 343 See Also ................................................................................................................................................ 344 DecryptStepDetails .................................................................................................................................. 345 Contents ............................................................................................................................................... 345 See Also ................................................................................................................................................ 346 DeleteStepDetails ..................................................................................................................................... 348 Contents ............................................................................................................................................... 348 See Also ................................................................................................................................................ 348 DescribedAccess ........................................................................................................................................ 350 Contents ............................................................................................................................................... 350 xvii AWS Transfer Family API Reference See Also ................................................................................................................................................ 353 DescribedAgreement ............................................................................................................................... 354 Contents ............................................................................................................................................... 354 See Also ................................................................................................................................................ 358 DescribedCertiﬁcate ................................................................................................................................. 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 362 DescribedConnector ................................................................................................................................. 363 Contents ............................................................................................................................................... 363 See Also ................................................................................................................................................ 366 DescribedExecution .................................................................................................................................. 367 Contents ............................................................................................................................................... 367 See Also ................................................................................................................................................ 368 DescribedHostKey .................................................................................................................................... 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 371 DescribedIdentityCenterConﬁg ............................................................................................................. 373 Contents ............................................................................................................................................... 373 See Also ................................................................................................................................................ 374 DescribedProﬁle ....................................................................................................................................... 375 Contents ............................................................................................................................................... 375 See Also ................................................................................................................................................ 376 DescribedSecurityPolicy .......................................................................................................................... 378 Contents ............................................................................................................................................... 378 See Also ................................................................................................................................................ 380 DescribedServer ........................................................................................................................................ 381 Contents ............................................................................................................................................... 381 See Also ................................................................................................................................................ 388 DescribedUser ........................................................................................................................................... 390 Contents ............................................................................................................................................... 390 See Also ................................................................................................................................................ 393 DescribedWebApp .................................................................................................................................... 394 Contents ............................................................................................................................................... 394 See Also ................................................................................................................................................ 396 DescribedWebAppCustomization .......................................................................................................... 397 Contents ............................................................................................................................................... 397 xviii AWS Transfer Family API Reference See Also ................................................................................................................................................ 398 DescribedWebAppIdentityProviderDetails .......................................................................................... 399 Contents ............................................................................................................................................... 399 See Also ................................................................................................................................................ 399 DescribedWorkﬂow .................................................................................................................................. 400 Contents ............................................................................................................................................... 400 See Also ................................................................................................................................................ 401 EfsFileLocation .......................................................................................................................................... 402 Contents ............................................................................................................................................... 402 See Also ................................................................................................................................................ 402 EndpointDetails ........................................................................................................................................ 404 Contents ............................................................................................................................................... 404 See Also ................................................................................................................................................ 407 ExecutionError ........................................................................................................................................... 408 Contents ............................................................................................................................................... 408 See Also ................................................................................................................................................ 409 ExecutionResults ....................................................................................................................................... 410 Contents ............................................................................................................................................... 410 See Also ................................................................................................................................................ 410 ExecutionStepResult ................................................................................................................................ 411 Contents ............................................................................................................................................... 411 See Also ................................................................................................................................................ 412 FileLocation ............................................................................................................................................... 413 Contents ............................................................................................................................................... 413 See Also ................................................................................................................................................ 413 HomeDirectoryMapEntry ........................................................................................................................ 414 Contents ............................................................................................................................................... 414 See Also ................................................................................................................................................ 415 IdentityCenterConﬁg ............................................................................................................................... 416 Contents ............................................................................................................................................... 416 See Also ................................................................................................................................................ 416 IdentityProviderDetails ........................................................................................................................... 417 Contents ............................................................................................................................................... 417 See Also ................................................................................................................................................ 418 InputFileLocation ...................................................................................................................................... 419 Contents ............................................................................................................................................... 419 xix AWS Transfer Family API Reference See Also ................................................................................................................................................ 419 ListedAccess ............................................................................................................................................... 420 Contents ............................................................................................................................................... 420 See Also ................................................................................................................................................ 422 ListedAgreement ...................................................................................................................................... 423 Contents ............................................................................................................................................... 423 See Also ................................................................................................................................................ 424 ListedCertiﬁcate ....................................................................................................................................... 426 Contents ............................................................................................................................................... 426 See Also ................................................................................................................................................ 428 ListedConnector ....................................................................................................................................... 429 Contents ............................................................................................................................................... 429 See Also ................................................................................................................................................ 429 ListedExecution ......................................................................................................................................... 431 Contents ............................................................................................................................................... 431 See Also ................................................................................................................................................ 432 ListedHostKey ........................................................................................................................................... 433 Contents ............................................................................................................................................... 433 See Also ................................................................................................................................................ 434 ListedProﬁle .............................................................................................................................................. 435 Contents ............................................................................................................................................... 435 See Also ................................................................................................................................................ 436 ListedServer ............................................................................................................................................... 437 Contents ............................................................................................................................................... 437 See Also ................................................................................................................................................ 439 ListedUser .................................................................................................................................................. 440 Contents ............................................................................................................................................... 440 See Also ................................................................................................................................................ 442 ListedWebApp ........................................................................................................................................... 443 Contents ............................................................................................................................................... 443 See Also ................................................................................................................................................ 444 ListedWorkﬂow ......................................................................................................................................... 445 Contents ............................................................................................................................................... 445 See Also ................................................................................................................................................ 446 LoggingConﬁguration ............................................................................................................................. 447 Contents ............................................................................................................................................... 447 xx AWS Transfer Family API Reference See Also ................................................................................................................................................ 447 PosixProﬁle ................................................................................................................................................ 449 Contents ............................................................................................................................................... 449 See Also ................................................................................................................................................ 450 ProtocolDetails ......................................................................................................................................... 451 Contents ............................................................................................................................................... 451 See Also ................................................................................................................................................ 453 S3FileLocation ........................................................................................................................................... 455 Contents ............................................................................................................................................... 455 See Also ................................................................................................................................................ 456 S3InputFileLocation ................................................................................................................................. 457 Contents ............................................................................................................................................... 457 See Also ................................................................................................................................................ 458 S3StorageOptions .................................................................................................................................... 459 Contents ............................................................................................................................................... 459 See Also ................................................................................................................................................ 459 S3Tag .......................................................................................................................................................... 460 Contents ............................................................................................................................................... 460 See Also ................................................................................................................................................ 460 ServiceMetadata ....................................................................................................................................... 461 Contents ............................................................................................................................................... 461 See Also ................................................................................................................................................ 461 SftpConnectorConﬁg ............................................................................................................................... 462 Contents ............................................................................................................................................... 462 See Also ................................................................................................................................................ 464 SftpConnectorConnectionDetails .......................................................................................................... 465 Contents ............................................................................................................................................... 465 See Also ................................................................................................................................................ 465 SshPublicKey ............................................................................................................................................. 466 Contents ............................................................................................................................................... 466 See Also ................................................................................................................................................ 467 Tag ............................................................................................................................................................... 468 Contents ............................................................................................................................................... 468 See Also ................................................................................................................................................ 468 TagStepDetails .......................................................................................................................................... 469 Contents ............................................................................................................................................... 469 xxi AWS Transfer Family API Reference See Also ................................................................................................................................................ 470 UpdateWebAppIdentityCenterConﬁg .................................................................................................. 471 Contents ............................................................................................................................................... 471 See Also ................................................................................................................................................ 471 UpdateWebAppIdentityProviderDetails ............................................................................................... 472 Contents ............................................................................................................................................... 472 See Also ................................................................................................................................................ 472 UserDetails ................................................................................................................................................. 473 Contents ............................................................................................................................................... 473 See Also ................................................................................................................................................ 474 WebAppIdentityProviderDetails ............................................................................................................ 475 Contents ............................................................................................................................................... 475 See Also ................................................................................................................................................ 475 WebAppUnits ............................................................................................................................................ 476 Contents ............................................................................................................................................... 476 See Also ................................................................................................................................................ 476 WorkﬂowDetail ......................................................................................................................................... 477 Contents ............................................................................................................................................... 477 See Also ................................................................................................................................................ 477 WorkﬂowDetails ....................................................................................................................................... 479 Contents ............................................................................................................................................... 479 See Also ................................................................................................................................................ 480 WorkﬂowStep ........................................................................................................................................... 481 Contents ............................................................................................................................................... 481 See Also ................................................................................................................................................ 482 Making API requests ................................................................................................................... 484 Transfer Family required request headers .......................................................................................... 484 Transfer Family request inputs and signing ....................................................................................... 485 Error responses ......................................................................................................................................... 485 Error response examples ................................................................................................................... 487 Available libraries ..................................................................................................................................... 488 Common Parameters ................................................................................................................... 489 Common Errors ............................................................................................................................ 492 xxii AWS Transfer Family API Reference Welcome to the AWS Transfer Family API AWS Transfer Family oﬀers fully managed support for the transfer of ﬁles over SFTP, AS2, FTPS, FTP, and web browser-based transfers directly into and out of AWS storage services. File transfer protocols are used in data exchange workﬂows across diﬀerent industries such as ﬁnancial services, healthcare, advertising, and retail, among others. AWS Transfer Family simpliﬁes the migration of ﬁle transfer workﬂows to AWS. To use the AWS Transfer Family service, you instantiate a server in the AWS Region of your choice. You can create the server, list available servers, and update
transferfamily-api-005	transferfamily-api.pdf	5	API Reference Welcome to the AWS Transfer Family API AWS Transfer Family oﬀers fully managed support for the transfer of ﬁles over SFTP, AS2, FTPS, FTP, and web browser-based transfers directly into and out of AWS storage services. File transfer protocols are used in data exchange workﬂows across diﬀerent industries such as ﬁnancial services, healthcare, advertising, and retail, among others. AWS Transfer Family simpliﬁes the migration of ﬁle transfer workﬂows to AWS. To use the AWS Transfer Family service, you instantiate a server in the AWS Region of your choice. You can create the server, list available servers, and update and delete servers. The server is the entity that requests ﬁle operations from AWS Transfer Family. Servers have a number of important properties. The server is a named instance as identiﬁed by a system assigned ServerId identiﬁer. You can optionally assign a hostname, or even a custom hostname to a server. The service bills for any instantiated servers (even ones OFFLINE), and for the amount of data transferred. Users must be known to the server that requests ﬁle operations. A user as identiﬁed by their username is assigned to a server. Usernames are used to authenticate requests. A server can have only one authentication method: AWS_DIRECTORY_SERVICE, SERVICE_MANAGED, AWS_LAMBDA, or API_GATEWAY. You can use any of the following identity provider types to authenticate users: • For SERVICE_MANAGED, an SSH public key is stored with the user's properties on a server. A user can have one or more SSH public keys on ﬁle for the SERVICE_MANAGED authentication method. When a client requests a ﬁle operation for SERVICE_MANAGED method, the client provides the username and SSH private key, which is authenticated, and access is provided. • You can manage user authentication and access with your Microsoft Active Directory groups by selecting the AWS_DIRECTORY_SERVICE authentication method. • You can connect to a custom identity provider by using AWS Lambda. Choose the AWS_LAMBDA authentication method. • You can also authenticate user requests using a custom authentication method that provides both user authentication and access. This method relies on the Amazon API Gateway to use your API call from your identity provider to validate user requests. This method is referred to as API_GATEWAY in API calls, and as Custom in the console. You might use this custom method to authenticate users against a directory service, a database name/password pair, or some other mechanism. 1 AWS Transfer Family API Reference Users are assigned a policy with a trust relationship between themselves and an Amazon S3 bucket. They might be able to access all or part of a bucket. For a server to act on a user's behalf, the server must inherit the trust relationship from the user. An AWS Identity and Access Management (IAM) role is created that contains the trust relationship, and that role is assigned an AssumeRole action. The server then can perform ﬁle operations as if it were the user. Users who have a home directory property set will have that directory (or folder) act as the target and source of ﬁle operations. When no home directory is set, the bucket's root directory becomes the landing directory. Servers, users, and roles are all identiﬁed by their Amazon Resource Name (ARN). You can assign tags, which are key-value pairs, to entities with an ARN. Tags are metadata that can be used to group or search for these entities. One example where tags are useful is for accounting purposes. The following conventions are observed in AWS Transfer Family ID formats: • ServerId values take the form s-01234567890abcdef. • SshPublicKeyId values take the form key-01234567890abcdef. Amazon Resource Name (ARN) formats take the following form: • For servers, ARNs take the form arn:aws:transfer:region:account-id:server/server- id. An example of a server ARN is: arn:aws:transfer:us-east-1:123456789012:server/ s-01234567890abcdef. • For users, ARNs take the form arn:aws:transfer:region:account-id:user/server- id/username. An example is arn:aws:transfer:us-east-1:123456789012:user/ s-01234567890abcdef/user1. DNS entries (endpoints) in use are as follows: • API endpoints take the form transfer.region.amazonaws.com. • Server endpoints take the form server.transfer.region.amazonaws.com. 2 AWS Transfer Family API Reference For a list of Transfer Family endpoints by AWS Region, see the AWS Transfer Family endpoints and quotas in the AWS General Reference. This API interface reference for AWS Transfer Family contains documentation for a programming interface that you can use to manage AWS Transfer Family. The reference structure is as follows: • For the alphabetical list of API actions, see Actions. • For the alphabetical list of data types, see Data Types. • For a list of common query parameters, see Common Parameters. • For descriptions of the error codes, see Common Errors. Tip Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a
transferfamily-api-006	transferfamily-api.pdf	6	for a programming interface that you can use to manage AWS Transfer Family. The reference structure is as follows: • For the alphabetical list of API actions, see Actions. • For the alphabetical list of data types, see Data Types. • For a list of common query parameters, see Common Parameters. • For descriptions of the error codes, see Common Errors. Tip Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton ﬁle. 3 AWS Transfer Family Actions The following actions are supported: • CreateAccess • CreateAgreement • CreateConnector • CreateProﬁle • CreateServer • CreateUser • CreateWebApp • CreateWorkﬂow • DeleteAccess • DeleteAgreement • DeleteCertiﬁcate • DeleteConnector • DeleteHostKey • DeleteProﬁle • DeleteServer • DeleteSshPublicKey • DeleteUser • DeleteWebApp • DeleteWebAppCustomization • DeleteWorkﬂow • DescribeAccess • DescribeAgreement • DescribeCertiﬁcate • DescribeConnector • DescribeExecution • DescribeHostKey • DescribeProﬁle API Reference 4 AWS Transfer Family • DescribeSecurityPolicy • DescribeServer • DescribeUser • DescribeWebApp • DescribeWebAppCustomization • DescribeWorkﬂow • ImportCertiﬁcate • ImportHostKey • ImportSshPublicKey • ListAccesses • ListAgreements • ListCertiﬁcates • ListConnectors • ListExecutions • ListFileTransferResults • ListHostKeys • ListProﬁles • ListSecurityPolicies • ListServers • ListTagsForResource • ListUsers • ListWebApps • ListWorkﬂows • SendWorkﬂowStepState • StartDirectoryListing • StartFileTransfer • StartRemoteDelete • StartRemoteMove • StartServer • StopServer API Reference 5 AWS Transfer Family • TagResource • TestConnection • TestIdentityProvider • UntagResource • UpdateAccess • UpdateAgreement • UpdateCertiﬁcate • UpdateConnector • UpdateHostKey • UpdateProﬁle • UpdateServer • UpdateUser • UpdateWebApp • UpdateWebAppCustomization API Reference 6 AWS Transfer Family CreateAccess API Reference Used by administrators to choose which groups in the directory should have access to upload and download ﬁles over the enabled protocols using AWS Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer ﬁles to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability. Request Syntax { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExternalId A unique identiﬁer that is required to identify speciﬁc groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the CreateAccess 7 AWS Transfer Family API Reference enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName"} -Properties \| Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ Required: Yes HomeDirectory The landing directory (folder) for a user when they log in to the server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. Note The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.*) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Request Parameters 8 AWS Transfer Family API Reference Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. 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" } ] Type: Array of HomeDirectoryMapEntry
transferfamily-api-007	transferfamily-api.pdf	7	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" } ] Type: Array of HomeDirectoryMapEntry objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No HomeDirectoryType The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their ﬁle 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. Type: String Valid Values: PATH \| LOGICAL Request Parameters 9 AWS Transfer Family Required: No Policy API Reference A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Note This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, AWS 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 AWS Security Token Service API Reference. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No PosixProﬁle 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in your ﬁle system determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS ﬁle system. The policies attached to this role determine the level of access that you want to provide your users when Request Parameters 10 AWS Transfer Family API Reference transferring ﬁles into and out of your Amazon S3 bucket or Amazon EFS ﬁle system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.*role/\S+ Required: Yes ServerId A system-assigned unique identiﬁer for a server instance. This is the speciﬁc server that you added your user to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "ExternalId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ExternalId The external identiﬁer of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. Response Syntax 11 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ ServerId The identiﬁer of the server that the user is attached to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found
transferfamily-api-008	transferfamily-api.pdf	8	the user is attached to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 12 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 13 AWS Transfer Family CreateAgreement API Reference Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an AWS Transfer Family server and an AS2 process. The agreement deﬁnes the ﬁle and message transfer relationship between the server and the AS2 process. To deﬁne an agreement, Transfer Family combines a server, local proﬁle, partner proﬁle, certiﬁcate, and other attributes. The partner is identiﬁed with the PartnerProfileId, and the AS2 process is identiﬁed with the LocalProfileId. Note Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail. Request Syntax { "AccessRole": "string", "BaseDirectory": "string", "CustomDirectories": { "FailedFilesDirectory": "string", "MdnFilesDirectory": "string", "PayloadFilesDirectory": "string", "StatusFilesDirectory": "string", "TemporaryFilesDirectory": "string" }, "Description": "string", "EnforceMessageSigning": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "PreserveFilename": "string", "ServerId": "string", "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ] CreateAgreement 14 AWS Transfer Family } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Request Parameters 15 AWS Transfer Family Required: Yes BaseDirectory API Reference The landing directory (folder) for ﬁles transferred by using the AS2 protocol. A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: No CustomDirectories A CustomDirectoriesType structure. This structure speciﬁes custom directories for storing various AS2 message ﬁles. You can specify directories for the following types of ﬁles. • Failed ﬁles • MDN ﬁles • Payload ﬁles • Status ﬁles • Temporary ﬁles Type: CustomDirectoriesType object Required: No Description A name or short description to identify the agreement. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: [\p{Graph}]+ Required: No EnforceMessageSigning Determines whether or not unsigned messages from your trading partners will be accepted. Request Parameters 16 AWS Transfer Family API Reference • ENABLED: Transfer Family rejects unsigned messages from your trading partner. • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner. Type: String Valid Values: ENABLED \| DISABLED Required:
transferfamily-api-009	transferfamily-api.pdf	9	• Failed ﬁles • MDN ﬁles • Payload ﬁles • Status ﬁles • Temporary ﬁles Type: CustomDirectoriesType object Required: No Description A name or short description to identify the agreement. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: [\p{Graph}]+ Required: No EnforceMessageSigning Determines whether or not unsigned messages from your trading partners will be accepted. Request Parameters 16 AWS Transfer Family API Reference • ENABLED: Transfer Family rejects unsigned messages from your trading partner. • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner. Type: String Valid Values: ENABLED \| DISABLED Required: No LocalProﬁleId A unique identiﬁer for the AS2 local proﬁle. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: Yes PartnerProﬁleId A unique identiﬁer for the partner proﬁle used in the agreement. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: Yes PreserveFilename Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload ﬁlename when saving it. • ENABLED: the ﬁlename provided by your trading parter is preserved when the ﬁle is saved. • DISABLED (default value): when Transfer Family saves the ﬁle, the ﬁlename is adjusted, as described in File names and locations. Type: String Valid Values: ENABLED \| DISABLED Request Parameters 17 AWS Transfer Family Required: No ServerId API Reference A system-assigned unique identiﬁer for a server instance. This is the speciﬁc server that the agreement uses. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Status The status of the agreement. The agreement can be either ACTIVE or INACTIVE. Type: String Valid Values: ACTIVE \| INACTIVE Required: No Tags Key-value pairs that can be used to group and search for agreements. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Response Syntax { "AgreementId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 18 AWS Transfer Family API Reference The following data is returned in JSON format by the service. AgreementId The unique identiﬁer for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. Errors 19 API Reference AWS Transfer Family HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example creates an agreement, and returns the agreement ID. aws transfer create-agreement --server-id s-021345abcdef6789 --local-profile- id p-1234567890abcdef0 \ --partner-profile-id p-abcdef01234567890 --base-directory/amzn-s3-demo-bucket/AS2- files \ --access-role arn:aws:iam::111122223333:role/AS2-role Sample Response The API call returns the agreement ID for the new agreement. { "AgreementId": "a-11112222333344444" } Example The following example creates an agreement, using custom directories, and returns the agreement ID. Create a ﬁle that lists the custom directories to use for the agreement, and save it as custom- directories.json, then run the command that follows. (Replace the sample directories with your actual values.) { "FailedFilesDirectory": "amzn-s3-demo-bucket/AS2-failed", "MdnFilesDirectory": "/amzn-s3-demo-bucket/AS2-mdn", "PayloadFilesDirectory": "amzn-s3-demo-bucket/AS2-payload", "StatusFilesDirectory": "/amzn-s3-demo-bucket/AS2-status", "TemporaryFilesDirectory": "amzn-s3-demo-bucket/AS2-temp" Examples 20 AWS Transfer Family } API Reference aws transfer create-agreement --server-id s-021345abcdef6789 --local-profile- id p-1234567890abcdef0 \ --partner-profile-id p-abcdef01234567890 --custom-directories file://custom- directories.json \ --access-role arn:aws:iam::111122223333:role/AS2-role Sample Response The API call returns the agreement ID for the new agreement. { "AgreementId": "a-11112222333344444" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 21 AWS Transfer Family CreateConnector API Reference Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending ﬁles to an externally hosted AS2 server. For SFTP, the connector is required when sending ﬁles to an SFTP server or receiving ﬁles
transferfamily-api-010	transferfamily-api.pdf	10	AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 21 AWS Transfer Family CreateConnector API Reference Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending ﬁles to an externally hosted AS2 server. For SFTP, the connector is required when sending ﬁles to an SFTP server or receiving ﬁles from an SFTP server. For more details about connectors, see Conﬁgure AS2 connectors and Create SFTP connectors. Note You must specify exactly one conﬁguration object: either for AS2 (As2Config) or SFTP (SftpConfig). Request Syntax { "AccessRole": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "PreserveContentType": "string", "SigningAlgorithm": "string" }, "LoggingRole": "string", "SecurityPolicyName": "string", "SftpConfig": { "MaxConcurrentConnections": number, "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Tags": [ { "Key": "string", "Value": "string" CreateConnector 22 AWS Transfer Family } ], "Url": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Request Parameters 23 AWS Transfer Family API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: Yes As2Conﬁg A structure that contains the parameters for an AS2 connector object. Type: As2ConnectorConﬁg object Required: No LoggingRole The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No SecurityPolicyName Speciﬁes the name of the security policy for the connector. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ Required: No SftpConﬁg A structure that contains the parameters for an SFTP connector object. Type: SftpConnectorConﬁg object Required: No Request Parameters 24 AWS Transfer Family Tags API Reference Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Url The URL of the partner's AS2 or SFTP endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: Yes Response Syntax { "ConnectorId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectorId The unique identiﬁer for the connector, returned after the API call succeeds. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Response Syntax 25 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for
transferfamily-api-011	transferfamily-api.pdf	11	service. ConnectorId The unique identiﬁer for the connector, returned after the API call succeeds. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Response Syntax 25 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example creates an AS2 connector. In the command, replace items as follows: Errors 26 AWS Transfer Family API Reference • url: provide the URL for the trading partner's AS2 server. • your-IAM-role-for-bucket-access: an IAM role that has access to the Amazon S3 bucket you are using to store your ﬁles. • Use the ARN for your logging role, which includes your AWS account ID. • Provide a path to a ﬁle that contains the AS2 connector conﬁguration parameters. The AS2 connector conﬁguration object is described in As2ConnectorConﬁg. // Listing for testAs2Config.json { "LocalProfileId": "your-profile-id", "PartnerProfileId": "partner-profile-id", "MdnResponse": "SYNC", "Compression": "ZLIB", "EncryptionAlgorithm": "AES256_CBC", "SigningAlgorithm": "SHA256", "MdnSigningAlgorithm": "DEFAULT", "MessageSubject": "Your Message Subject" } aws transfer create-connector --url "http://partner-as2-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/ AWSTransferLoggingAccess \ --as2-config file://path/to/testAS2Config.json Example The following example creates an SFTP connector. In the command, replace items as follows: • sftp-server-url: provide the URL for the SFTP server with which you are exchanging ﬁles. • your-IAM-role-for-bucket-access: an IAM role that has access to the Amazon S3 bucket you are using to store your ﬁles. • Use the ARN for your logging role, which includes your AWS account ID. • Provide a path to a ﬁle that contains the SFTP connector conﬁguration parameters. The SFTP connector conﬁguration object is described in SftpConnectorConﬁg. Examples 27 AWS Transfer Family API Reference // Listing for testSFTPConfig.json { "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/ example-username-key", "TrustedHostKeys": [ "sftp.example.com ssh-rsa AAAAbbbb...EEEE=" ] } aws transfer create-connector --url "sftp://sftp-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --sftp-config file://path/to/testSFTPConfig.json Example The API call returns the connector ID for the new connector. Sample Response { "ConnectorId": "c-11112222333344444" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also 28 AWS Transfer Family • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 29 AWS Transfer Family CreateProﬁle Creates the local or partner proﬁle to use for AS2 transfers. API Reference Request Syntax { "As2Id": "string", "CertificateIds": [ "string" ], "ProfileType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. As2Id The As2Id is the AS2-name, as deﬁned 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\p{Print}\s]* Required: Yes CertiﬁcateIds An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. CreateProﬁle 30 AWS Transfer Family Type: Array of strings Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: No ProﬁleType API Reference Determines the type of proﬁle to create: • Specify LOCAL to create a local proﬁle. A local proﬁle represents the AS2-enabled Transfer Family server organization or party. • Specify PARTNER to create a partner proﬁle. A partner proﬁle represents a remote organization, external to Transfer Family. Type: String Valid Values: LOCAL \| PARTNER Required: Yes Tags Key-value pairs that can be used to group and search for AS2 proﬁles. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Response Syntax { "ProfileId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 31
transferfamily-api-012	transferfamily-api.pdf	12	a local proﬁle. A local proﬁle represents the AS2-enabled Transfer Family server organization or party. • Specify PARTNER to create a partner proﬁle. A partner proﬁle represents a remote organization, external to Transfer Family. Type: String Valid Values: LOCAL \| PARTNER Required: Yes Tags Key-value pairs that can be used to group and search for AS2 proﬁles. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Response Syntax { "ProfileId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 31 AWS Transfer Family API Reference The following data is returned in JSON format by the service. ProﬁleId The unique identiﬁer for the AS2 proﬁle, returned after the API call succeeds. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Errors 32 AWS Transfer Family Examples Example API Reference The following example creates a proﬁle, and returns the proﬁle ID. The certiﬁcate IDs are created when you run import-certificate, one for the signing certiﬁcate, and one for the encryption certiﬁcate. aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb Sample Response The API call returns the proﬁle ID for the new proﬁle. { "ProfileId": "p-11112222333344444" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Examples 33 AWS Transfer Family API Reference See Also 34 AWS Transfer Family CreateServer API Reference Instantiates an auto-scaling virtual server based on the selected ﬁle transfer protocol in AWS. When you make updates to your ﬁle transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. Request Syntax { "Certificate": "string", "Domain": "string", "EndpointDetails": { "AddressAllocationIds": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" }, "EndpointType": "string", "HostKey": "string", "IdentityProviderDetails": { "DirectoryId": "string", "Function": "string", "InvocationRole": "string", "SftpAuthenticationMethods": "string", "Url": "string" }, "IdentityProviderType": "string", "LoggingRole": "string", "PostAuthenticationLoginBanner": "string", "PreAuthenticationLoginBanner": "string", "ProtocolDetails": { "As2Transports": [ "string" ], "PassiveIp": "string", "SetStatOption": "string", "TlsSessionResumptionMode": "string" }, "Protocols": [ "string" ], "S3StorageOptions": { "DirectoryListingOptimization": "string" }, "SecurityPolicyName": "string", CreateServer 35 AWS Transfer Family API Reference "StructuredLogDestinations": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "WorkflowDetails": { "OnPartialUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ], "OnUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ] } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Certiﬁcate The Amazon Resource Name (ARN) of the AWS Certiﬁcate Manager (ACM) certiﬁcate. Required when Protocols is set to FTPS. To request a new public certiﬁcate, see Request a public certiﬁcate in the AWS Certiﬁcate Manager User Guide. To import an existing certiﬁcate into ACM, see Importing certiﬁcates into ACM in the AWS Certiﬁcate Manager User Guide. To request a private certiﬁcate to use FTPS through private IP addresses, see Request a private certiﬁcate in the AWS Certiﬁcate Manager User Guide. Request Parameters 36 AWS Transfer Family API Reference Certiﬁcates 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 certiﬁcate must be a valid SSL/TLS X.509 version 3 certiﬁcate with FQDN or IP address speciﬁed and information about the issuer. Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Required: No Domain The domain of the storage system that is used for ﬁle transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3. Note After the server is created, the domain cannot be changed. Type: String Valid Values: S3 \| EFS
transferfamily-api-013	transferfamily-api.pdf	13	bit (EC_secp384r1) • Elliptic Prime Curve 521 bit (EC_secp521r1) Note The certiﬁcate must be a valid SSL/TLS X.509 version 3 certiﬁcate with FQDN or IP address speciﬁed and information about the issuer. Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Required: No Domain The domain of the storage system that is used for ﬁle transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3. Note After the server is created, the domain cannot be changed. Type: String Valid Values: S3 \| EFS Required: No EndpointDetails The virtual private cloud (VPC) endpoint settings that are conﬁgured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources Request Parameters 37 AWS Transfer Family API Reference within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint. Type: EndpointDetails object Required: No EndpointType The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it. Note After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021, you will not be aﬀected. After this date, use EndpointType=VPC. For more information, see Discontinuing the use of 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 traﬃc by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT. Type: String Valid Values: PUBLIC \| VPC \| VPC_ENDPOINT Required: No HostKey The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use diﬀerent algorithms. Request Parameters 38 AWS Transfer Family API Reference 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. Important 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 Update host keys for your SFTP-enabled server in the AWS Transfer Family User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No IdentityProviderDetails Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, AWS_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be speciﬁed when IdentityProviderType is set to SERVICE_MANAGED. Request Parameters 39 AWS Transfer Family API Reference Type: IdentityProviderDetails object Required: No IdentityProviderType The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for
transferfamily-api-014	transferfamily-api.pdf	14	Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type. Type: String Valid Values: SERVICE_MANAGED \| API_GATEWAY \| AWS_DIRECTORY_SERVICE \| AWS_LAMBDA Required: No LoggingRole The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: (\|arn:.role/\S+) Required: No Request Parameters 40 AWS Transfer Family PostAuthenticationLoginBanner API Reference Speciﬁes 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Pattern: [\x09-\x0D\x20-\x7E] Required: No PreAuthenticationLoginBanner Speciﬁes a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Pattern: [\x09-\x0D\x20-\x7E]* Required: No ProtocolDetails The protocol settings that are conﬁgured 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 ﬁrewall, router, or load balancer. Request Parameters 41 AWS Transfer Family API Reference • To ignore the error that is generated when the client attempts to use the SETSTAT command on a ﬁle that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the AWS Transfer Family server ignore the SETSTAT command and upload ﬁles without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call. • To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter. • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported. Type: ProtocolDetails object Required: No Protocols Speciﬁes the ﬁle transfer protocol or protocols over which your ﬁle 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 ﬁle transfer • AS2 (Applicability Statement 2): used for transporting structured business-to-business data Note • If you select FTPS, you must choose a certiﬁcate stored in AWS Certiﬁcate 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. Request Parameters 42 AWS Transfer Family API Reference • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: SFTP \| FTP \| FTPS \| AS2 Required: No S3StorageOptions Speciﬁes 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 ﬁle target. Type: S3StorageOptions object Required: No SecurityPolicyName Speciﬁes the name of the security policy for the server. Type: String
transferfamily-api-015	transferfamily-api.pdf	15	Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: SFTP \| FTP \| FTPS \| AS2 Required: No S3StorageOptions Speciﬁes 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 ﬁle target. Type: S3StorageOptions object Required: No SecurityPolicyName Speciﬁes the name of the security policy for the server. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: Transfer[A-Za-z0-9]SecurityPolicy-[A-Za-z0-9-]+ Required: No StructuredLogDestinations Speciﬁes 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: Request Parameters 43 AWS Transfer Family API Reference 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 speciﬁed a log group for a server, you can clear it, and in eﬀect turn oﬀ structured logging, by providing an empty value for this parameter in an update-server call. For example: update-server --server-id s-1234567890abcdef0 --structured-log- destinations Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1 item. Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: No Tags Key-value pairs that can be used to group and search for servers. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No WorkﬂowDetails Speciﬁes the workﬂow ID for the workﬂow to assign and the execution role that's used for executing the workﬂow. In addition to a workﬂow to execute when a ﬁle is uploaded completely, WorkflowDetails can also contain a workﬂow ID (and execution role) for a workﬂow to execute on partial upload. A partial upload occurs when the server session disconnects while the ﬁle is still being uploaded. Type: WorkﬂowDetails object Required: No Request Parameters 44 AWS Transfer Family Response Syntax { "ServerId": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServerId The service-assigned identiﬁer of the server that is created. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Response Syntax 45 AWS Transfer Family ResourceExistsException API Reference The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example creates a new server using a VPC_ENDPOINT. Sample Request { "EndpointType": "VPC", "EndpointDetails":..., "HostKey": "Your RSA private key", "IdentityProviderDetails": "IdentityProvider", "IdentityProviderType": "SERVICE_MANAGED", "LoggingRole": "CloudWatchLoggingRole", "Tags": [ { "Key": "Name", "Value": "MyServer" Examples 46 API Reference AWS Transfer Family } ] } Example This is a sample response for this API call. Sample Response { "ServerId": "s-01234567890abcdef" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 47 AWS Transfer Family CreateUser API Reference Creates a user and associates them with an existing ﬁle 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 AWS 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. Request Syntax { "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [
transferfamily-api-016	transferfamily-api.pdf	16	existing ﬁle 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 AWS 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. Request Syntax { "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "ServerId": "string", "SshPublicKeyBody": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" } CreateUser 48 AWS Transfer Family Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. HomeDirectory The landing directory (folder) for a user when they log in to the server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. Note The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.*) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. 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. Request Parameters 49 AWS Transfer Family API Reference The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] Type: Array of HomeDirectoryMapEntry objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No HomeDirectoryType The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their ﬁle 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. Type: String Valid Values: PATH \| LOGICAL Required: No Policy A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Note This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. Request Parameters 50 AWS Transfer Family API Reference For session policies, AWS 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 AWS Security Token Service API Reference. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No PosixProﬁle Speciﬁes 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in Amazon EFS determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon
transferfamily-api-017	transferfamily-api.pdf	17	length of 2048. Required: No PosixProﬁle Speciﬁes 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in Amazon EFS determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS ﬁle system. The policies attached to this role determine the level of access that you want to provide your users when transferring ﬁles into and out of your Amazon S3 bucket or Amazon EFS ﬁle system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: Yes Request Parameters 51 AWS Transfer Family ServerId API Reference A system-assigned unique identiﬁer for a server instance. This is the speciﬁc server that you added your user to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes SshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the server. The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. AWS 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \s(ssh\|ecdsa)-[a-z0-9-]+[ \t]+(([A-Za-z0-9+/]{4})([A-Za-z0-9+/] {1,3})?(={0,3})?)(\s\|[ \t]+[\S \t]\s) Required: No Tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. Type: Array of Tag objects Request Parameters 52 AWS Transfer Family API Reference Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No UserName A unique string that identiﬁes 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Syntax { "ServerId": "string", "UserName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServerId The identiﬁer of the server that the user is attached to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Response Syntax 53 AWS Transfer Family UserName API Reference A unique string that identiﬁes a Transfer Family user. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 54 AWS Transfer Family Examples Example API Reference To create a user, you can ﬁrst save the parameters into a JSON ﬁle, for example createUserParameters, then run the create-user API command. { "HomeDirectory": "/amzn-s3-demo-bucket", "HomeDirectoryType": "PATH", "Role": "arn:aws:iam::111122223333:role/bob-role", "ServerId": "s-1111aaaa2222bbbb3", "SshPublicKeyBody": "ecdsa-sha2-nistp521 AAAAE2VjZHNhLXNoYTItbmlzdHA... bobusa@mycomputer.us-east-1.amazon.com", "UserName": "bobusa-API" } Sample Request aws transfer create-user --cli-input-json file://createUserParameters Sample Response { "ServerId": ""s-1111aaaa2222bbbb3", "UserName": "bobusa-API" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Examples 55 AWS Transfer Family • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 56 AWS Transfer Family CreateWebApp
transferfamily-api-018	transferfamily-api.pdf	18	transfer create-user --cli-input-json file://createUserParameters Sample Response { "ServerId": ""s-1111aaaa2222bbbb3", "UserName": "bobusa-API" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Examples 55 AWS Transfer Family • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 56 AWS Transfer Family CreateWebApp API Reference Creates a web app based on speciﬁed parameters, and returns the ID for the new web app. Request Syntax { "AccessEndpoint": "string", "IdentityProviderDetails": { ... }, "Tags": [ { "Key": "string", "Value": "string" } ], "WebAppEndpointPolicy": "string", "WebAppUnits": { ... } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessEndpoint 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No IdentityProviderDetails You can provide a structure that contains the details for the identity provider to use with your web app. CreateWebApp 57 AWS Transfer Family API Reference For more details about this parameter, see Conﬁgure your identity provider for Transfer Family web apps. Type: WebAppIdentityProviderDetails object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes Tags Key-value pairs that can be used to group and search for web apps. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No WebAppEndpointPolicy 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 AWS GovCloud (US) Region, you can set this parameter to FIPS. Type: String Valid Values: FIPS \| STANDARD Required: No WebAppUnits A union that contains the value for number of concurrent connections or the user sessions on your web app. Type: WebAppUnits object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No Response Syntax { Response Syntax 58 AWS Transfer Family "WebAppId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference WebAppId Returns a unique identiﬁer for the web app. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Response Elements 59 AWS Transfer Family HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 60 AWS Transfer Family CreateWorkﬂow API Reference Allows you to create a workﬂow with speciﬁed steps and step details the workﬂow invokes after ﬁle transfer completes. After creating a workﬂow, you can associate the workﬂow created with any transfer servers by specifying the workflow-details ﬁeld in CreateServer and UpdateServer operations. Request Syntax { "Description": "string", "OnExceptionSteps": [ { "CopyStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string" }, "CustomStepDetails": { "Name": "string", "SourceFileLocation": "string", "Target": "string", "TimeoutSeconds": number }, "DecryptStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", CreateWorkﬂow 61 AWS Transfer Family API Reference "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string", "Type": "string" }, "DeleteStepDetails": { "Name": "string", "SourceFileLocation":
transferfamily-api-019	transferfamily-api.pdf	19	created with any transfer servers by specifying the workflow-details ﬁeld in CreateServer and UpdateServer operations. Request Syntax { "Description": "string", "OnExceptionSteps": [ { "CopyStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string" }, "CustomStepDetails": { "Name": "string", "SourceFileLocation": "string", "Target": "string", "TimeoutSeconds": number }, "DecryptStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", CreateWorkﬂow 61 AWS Transfer Family API Reference "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string", "Type": "string" }, "DeleteStepDetails": { "Name": "string", "SourceFileLocation": "string" }, "TagStepDetails": { "Name": "string", "SourceFileLocation": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Type": "string" } ], "Steps": [ { "CopyStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string" }, "CustomStepDetails": { "Name": "string", Request Syntax 62 AWS Transfer Family API Reference "SourceFileLocation": "string", "Target": "string", "TimeoutSeconds": number }, "DecryptStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string", "Type": "string" }, "DeleteStepDetails": { "Name": "string", "SourceFileLocation": "string" }, "TagStepDetails": { "Name": "string", "SourceFileLocation": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Type": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] Request Syntax 63 AWS Transfer Family } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description A textual description for the workﬂow. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: [\w- ]* Required: No OnExceptionSteps Speciﬁes the steps (actions) to take if errors are encountered during execution of the workﬂow. Note For custom steps, the Lambda function needs to send FAILURE to the call back API to kick oﬀ the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the exception steps are executed. Type: Array of WorkﬂowStep objects Array Members: Minimum number of 0 items. Maximum number of 8 items. Required: No Steps Speciﬁes the details for the steps that are in the speciﬁed workﬂow. The TYPE speciﬁes which of the following actions is being taken for this step. • COPY - Copy the ﬁle to another location. Request Parameters 64 AWS Transfer Family API Reference • CUSTOM - Perform a custom step with an AWS Lambda function target. • DECRYPT - Decrypt a ﬁle that was encrypted before it was uploaded. • DELETE - Delete the ﬁle. • TAG - Add a tag to the ﬁle. Note Currently, copying and tagging are supported only on S3. For ﬁle location, you specify either the Amazon S3 bucket and key, or the Amazon EFS ﬁle system ID and path. Type: Array of WorkﬂowStep objects Array Members: Minimum number of 0 items. Maximum number of 8 items. Required: Yes Tags Key-value pairs that can be used to group and search for workﬂows. Tags are metadata attached to workﬂows for any purpose. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Response Syntax { "WorkflowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 65 AWS Transfer Family API Reference The following data is returned in JSON format by the service. WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. Errors 66 API Reference AWS Transfer Family HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example You can save workﬂow step information into a text ﬁle, and then use that ﬁle to create a workﬂow, as in the following example. The following example assumes you have saved your workﬂow steps into example-file.json (in the same folder from where you run the command), and that you wish to create the workﬂow in the N. Virginia (us-east-1) region. aws transfer create-workflow --description "example workflow from a file" --steps file://example-file.json --region us-east-1
transferfamily-api-020	transferfamily-api.pdf	20	available. Errors 66 API Reference AWS Transfer Family HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example You can save workﬂow step information into a text ﬁle, and then use that ﬁle to create a workﬂow, as in the following example. The following example assumes you have saved your workﬂow steps into example-file.json (in the same folder from where you run the command), and that you wish to create the workﬂow in the N. Virginia (us-east-1) region. aws transfer create-workflow --description "example workflow from a file" --steps file://example-file.json --region us-east-1 // Example file containing workflow steps [ { "Type": "TAG", "TagStepDetails": { "Name": "TagStep", "Tags": [ { "Key": "name", "Value": "testTag" } ] } }, { "Type": "COPY", "CopyStepDetails": { "Name": "CopyStep", "DestinationFileLocation": { "S3FileLocation": { "Bucket": "amzn-s3-demo-bucket", Examples 67 AWS Transfer Family API Reference "Key": "DOC-EXAMPLE-KEY/" } }, "OverwriteExisting": "TRUE", "SourceFileLocation": "${original.file}" } }, { "Type": "DELETE", "DeleteStepDetails":{ "Name":"DeleteStep", "SourceFileLocation": "${original.file}" } } ] Example The CreateWorkflow call returns the workﬂow ID for the new workﬂow. Sample Response { "WorkflowId": "w-1234abcd5678efghi" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also 68 AWS Transfer Family • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 69 AWS Transfer Family DeleteAccess API Reference Allows you to delete the access speciﬁed in the ServerID and ExternalID parameters. Request Syntax { "ExternalId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExternalId A unique identiﬁer that is required to identify speciﬁc groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName"} -Properties \| Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ Required: Yes DeleteAccess 70 AWS Transfer Family ServerId API Reference A system-assigned unique identiﬁer for a server that has this user assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Response Elements 71 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 72 AWS Transfer Family DeleteAgreement API Reference Delete the agreement that's speciﬁed in the provided AgreementId. Request Syntax { "AgreementId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: Yes ServerId The server identiﬁer associated with the agreement that you are deleting. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes DeleteAgreement 73 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response
transferfamily-api-021	transferfamily-api.pdf	21	} Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: Yes ServerId The server identiﬁer associated with the agreement that you are deleting. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes DeleteAgreement 73 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Response Elements 74 AWS Transfer Family • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 75 AWS Transfer Family DeleteCertiﬁcate API Reference Deletes the certiﬁcate that's speciﬁed in the CertificateId parameter. Request Syntax { "CertificateId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CertiﬁcateId The identiﬁer of the certiﬁcate object that you are deleting. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 DeleteCertiﬁcate 76 AWS Transfer Family InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 77 AWS Transfer Family DeleteConnector API Reference Deletes the connector that's speciﬁed in the provided ConnectorId. Request Syntax { "ConnectorId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 DeleteConnector 78 AWS Transfer Family InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 79 AWS Transfer Family DeleteHostKey API Reference Deletes
transferfamily-api-022	transferfamily-api.pdf	22	The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 79 AWS Transfer Family DeleteHostKey API Reference Deletes the host key that's speciﬁed in the HostKeyId parameter. Request Syntax { "HostKeyId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. HostKeyId The identiﬁer of the host key that you are deleting. Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} Required: Yes ServerId The identiﬁer of the server that contains the host key that you are deleting. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes DeleteHostKey 80 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Elements 81 API Reference AWS Transfer Family • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 82 AWS Transfer Family DeleteProﬁle Deletes the proﬁle that's speciﬁed in the ProfileId parameter. API Reference Request Syntax { "ProfileId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ProﬁleId The identiﬁer of the proﬁle that you are deleting. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 DeleteProﬁle 83 AWS Transfer Family InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 84 AWS Transfer Family DeleteServer Deletes the ﬁle transfer protocol-enabled server that you specify. No response returns from this operation. API Reference Request Syntax { "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A unique system-assigned identiﬁer for a server instance. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. DeleteServer 85 AWS Transfer Family HTTP Status Code: 400 InternalServiceError API Reference This exception is thrown when an
transferfamily-api-023	transferfamily-api.pdf	23	to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A unique system-assigned identiﬁer for a server instance. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. DeleteServer 85 AWS Transfer Family HTTP Status Code: 400 InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example deletes a server. Sample Request { "ServerId": "s-01234567890abcdef" } Example If successful, nothing is returned. Examples 86 AWS Transfer Family Sample Response { } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 87 API Reference AWS Transfer Family DeleteSshPublicKey Deletes a user's Secure Shell (SSH) public key. Request Syntax { "ServerId": "string", "SshPublicKeyId": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a ﬁle transfer protocol-enabled server instance that has the user assigned to it. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes SshPublicKeyId A unique identiﬁer used to reference your user's speciﬁc SSH key. Type: String Length Constraints: Fixed length of 21. Pattern: key-[0-9a-f]{17} Required: Yes DeleteSshPublicKey 88 AWS Transfer Family UserName API Reference A unique string that identiﬁes a user whose public key is being deleted. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Response Elements 89 API Reference AWS Transfer Family ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example deletes a user's SSH public key. Sample Request { "ServerId": "s-01234567890abcdef", "SshPublicKeyId": "MyPublicKey", "UserName": "my_user" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Examples 90 AWS Transfer Family DeleteUser API Reference Deletes the user belonging to a ﬁle transfer protocol-enabled server you specify. No response returns from this operation. Note When you delete a user from a server, the user's information is lost. Request Syntax { "ServerId": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server instance that has the user assigned to it. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes UserName A unique string that identiﬁes a user that is being deleted from a server. Type: String DeleteUser 91 AWS Transfer Family API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about
transferfamily-api-024	transferfamily-api.pdf	24	Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server instance that has the user assigned to it. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes UserName A unique string that identiﬁes a user that is being deleted from a server. Type: String DeleteUser 91 AWS Transfer Family API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example deletes a Transfer Family user. Response Elements 92 AWS Transfer Family Sample Request { "ServerId": "s-01234567890abcdef", "UserNames": "my_user" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 93 API Reference AWS Transfer Family DeleteWebApp Deletes the speciﬁed web app. Request Syntax { "WebAppId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WebAppId Provide the unique identiﬁer for the web app that you are deleting. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 DeleteWebApp 94 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 95 AWS Transfer Family API Reference DeleteWebAppCustomization Deletes the WebAppCustomization object that corresponds to the web app ID speciﬁed. Request Syntax { "WebAppId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WebAppId Provide the unique identiﬁer for the web app that contains the customizations that you are deleting. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. DeleteWebAppCustomization 96 AWS Transfer Family HTTP Status Code: 400 ConﬂictException API Reference This exception is thrown when the UpdateServer is called for a ﬁle transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information
transferfamily-api-025	transferfamily-api.pdf	25	for a ﬁle transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also 97 AWS Transfer Family • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 98 API Reference AWS Transfer Family DeleteWorkﬂow Deletes the speciﬁed workﬂow. Request Syntax { "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 DeleteWorkﬂow 99 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 100 AWS Transfer Family DescribeAccess API Reference Describes the access that is assigned to the speciﬁc ﬁle transfer protocol-enabled server, as identiﬁed by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was speciﬁed. Request Syntax { "ExternalId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExternalId A unique identiﬁer that is required to identify speciﬁc groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName"} -Properties \| Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ DescribeAccess 101 AWS Transfer Family Required: Yes ServerId API Reference A system-assigned unique identiﬁer for a server that has this access assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "Access": { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string" }, "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 102 AWS Transfer Family API Reference The following data is returned in JSON format by the service. Access The external identiﬁer of the server that the access is attached to. Type: DescribedAccess object ServerId A system-assigned unique identiﬁer for a server that has this access assigned. Type: String
transferfamily-api-026	transferfamily-api.pdf	26	"string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string" }, "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax 102 AWS Transfer Family API Reference The following data is returned in JSON format by the service. Access The external identiﬁer of the server that the access is attached to. Type: DescribedAccess object ServerId A system-assigned unique identiﬁer for a server that has this access assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 103 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 104 AWS Transfer Family DescribeAgreement Describes the agreement that's identiﬁed by the AgreementId. API Reference Request Syntax { "AgreementId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: Yes ServerId The server identiﬁer that's associated with the agreement. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes DescribeAgreement 105 API Reference AWS Transfer Family Response Syntax { "Agreement": { "AccessRole": "string", "AgreementId": "string", "Arn": "string", "BaseDirectory": "string", "CustomDirectories": { "FailedFilesDirectory": "string", "MdnFilesDirectory": "string", "PayloadFilesDirectory": "string", "StatusFilesDirectory": "string", "TemporaryFilesDirectory": "string" }, "Description": "string", "EnforceMessageSigning": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "PreserveFilename": "string", "ServerId": "string", "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Agreement The details for the speciﬁed agreement, returned as a DescribedAgreement object. Type: DescribedAgreement object Response Syntax 106 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors 107 AWS Transfer Family • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 108 AWS Transfer Family DescribeCertiﬁcate Describes the certiﬁcate that's identiﬁed by the CertificateId. API Reference Request Syntax { "CertificateId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CertiﬁcateId An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: Yes Response Syntax { "Certificate": { "ActiveDate": number, "Arn": "string", "Certificate": "string", "CertificateChain": "string", "CertificateId": "string", "Description": "string", "InactiveDate": number, DescribeCertiﬁcate 109 AWS Transfer Family API Reference "NotAfterDate": number, "NotBeforeDate": number, "Serial": "string", "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Usage": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in
transferfamily-api-027	transferfamily-api.pdf	27	array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: Yes Response Syntax { "Certificate": { "ActiveDate": number, "Arn": "string", "Certificate": "string", "CertificateChain": "string", "CertificateId": "string", "Description": "string", "InactiveDate": number, DescribeCertiﬁcate 109 AWS Transfer Family API Reference "NotAfterDate": number, "NotBeforeDate": number, "Serial": "string", "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Usage": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Certiﬁcate The details for the speciﬁed certiﬁcate, returned as an object. Type: DescribedCertiﬁcate object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Response Elements 110 AWS Transfer Family ResourceNotFoundException API Reference This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 111 AWS Transfer Family DescribeConnector Describes the connector that's identiﬁed by the ConnectorId. API Reference Request Syntax { "ConnectorId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes Response Syntax { "Connector": { "AccessRole": "string", "Arn": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", DescribeConnector 112 AWS Transfer Family API Reference "MessageSubject": "string", "PartnerProfileId": "string", "PreserveContentType": "string", "SigningAlgorithm": "string" }, "ConnectorId": "string", "LoggingRole": "string", "SecurityPolicyName": "string", "ServiceManagedEgressIpAddresses": [ "string" ], "SftpConfig": { "MaxConcurrentConnections": number, "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "Url": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Connector The structure that contains the details of the connector. Type: DescribedConnector object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. Response Elements 113 AWS Transfer Family HTTP Status Code: 500 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 114 AWS Transfer Family DescribeExecution API Reference You can use DescribeExecution to check the details of the execution of the speciﬁed workﬂow. Note This API call only returns details for in-progress workﬂows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the speciﬁed workﬂow ID, you receive a ResourceNotFound exception. Request Syntax { "ExecutionId": "string", "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExecutionId A unique identiﬁer for the execution of a workﬂow. Type: String Length Constraints: Fixed length of 36. Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12} Required: Yes WorkﬂowId A unique identiﬁer for the workﬂow. Type: String DescribeExecution 115 AWS Transfer Family API Reference Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Syntax { "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": {
transferfamily-api-028	transferfamily-api.pdf	28	{ "ExecutionId": "string", "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExecutionId A unique identiﬁer for the execution of a workﬂow. Type: String Length Constraints: Fixed length of 36. Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12} Required: Yes WorkﬂowId A unique identiﬁer for the workﬂow. Type: String DescribeExecution 115 AWS Transfer Family API Reference Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Syntax { "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } Response Syntax 116 API Reference AWS Transfer Family ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Execution The structure that contains the details of the workﬂow' execution. Type: DescribedExecution object WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Response Elements 117 AWS Transfer Family API Reference Pattern: w-([a-z0-9]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 Errors 118 AWS Transfer Family • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 119 AWS Transfer Family DescribeHostKey API Reference Returns the details of the host key that's speciﬁed by the HostKeyId and ServerId. Request Syntax { "HostKeyId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. HostKeyId The identiﬁer of the host key that you want described. Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} Required: Yes ServerId The identiﬁer of the server that contains the host key that you want described. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes DescribeHostKey 120 API Reference AWS Transfer Family Response Syntax { "HostKey": { "Arn": "string", "DateImported": number, "Description": "string", "HostKeyFingerprint": "string", "HostKeyId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. HostKey Returns the details for the speciﬁed host key. Type: DescribedHostKey object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 Response Syntax 121 AWS Transfer Family InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 122 AWS Transfer Family DescribeProﬁle API Reference Returns the details of the proﬁle that's speciﬁed by the ProfileId. Request Syntax { "ProfileId": "string" } Request Parameters For information
transferfamily-api-029	transferfamily-api.pdf	29	information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 122 AWS Transfer Family DescribeProﬁle API Reference Returns the details of the proﬁle that's speciﬁed by the ProfileId. Request Syntax { "ProfileId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ProﬁleId The identiﬁer of the proﬁle that you want described. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: Yes Response Syntax { "Profile": { "Arn": "string", "As2Id": "string", "CertificateIds": [ "string" ], "ProfileId": "string", "ProfileType": "string", "Tags": [ { "Key": "string", "Value": "string" DescribeProﬁle 123 API Reference AWS Transfer Family } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Proﬁle The details of the speciﬁed proﬁle, returned as an object. Type: DescribedProﬁle object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Response Elements 124 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 125 AWS Transfer Family API Reference DescribeSecurityPolicy Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors. Request Syntax { "SecurityPolicyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SecurityPolicyName Specify the text name of the security policy for which you want the details. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+ Required: Yes Response Syntax { "SecurityPolicy": { "Fips": boolean, "Protocols": [ "string" ], "SecurityPolicyName": "string", "SshCiphers": [ "string" ], "SshHostKeyAlgorithms": [ "string" ], DescribeSecurityPolicy 126 AWS Transfer Family API Reference "SshKexs": [ "string" ], "SshMacs": [ "string" ], "TlsCiphers": [ "string" ], "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SecurityPolicy An array containing the properties of the security policy. Type: DescribedSecurityPolicy object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. Response Elements 127 AWS Transfer Family HTTP Status Code: 500 Examples Example API Reference The following example command takes the security policy name as an argument, and returns the algorithms for the speciﬁed security policy. Sample Request aws transfer describe-security-policy --security-policy-name "TransferSecurityPolicy- FIPS-2023-05" Sample Response { "SecurityPolicy": { "Fips": true, "SecurityPolicyName": "TransferSecurityPolicy-FIPS-2023-05", "SshCiphers": [ "aes256-gcm@openssh.com", "aes128-gcm@openssh.com", "aes256-ctr", "aes192-ctr" ], "SshKexs": [ "diffie-hellman-group16-sha512", "diffie-hellman-group18-sha512", "diffie-hellman-group-exchange-sha256" ], "SshMacs": [ "hmac-sha2-256-etm@openssh.com", "hmac-sha2-512-etm@openssh.com" ], "TlsCiphers": [ "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", Examples 128 AWS Transfer Family API Reference "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" ] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS
transferfamily-api-030	transferfamily-api.pdf	30	speciﬁed security policy. Sample Request aws transfer describe-security-policy --security-policy-name "TransferSecurityPolicy- FIPS-2023-05" Sample Response { "SecurityPolicy": { "Fips": true, "SecurityPolicyName": "TransferSecurityPolicy-FIPS-2023-05", "SshCiphers": [ "aes256-gcm@openssh.com", "aes128-gcm@openssh.com", "aes256-ctr", "aes192-ctr" ], "SshKexs": [ "diffie-hellman-group16-sha512", "diffie-hellman-group18-sha512", "diffie-hellman-group-exchange-sha256" ], "SshMacs": [ "hmac-sha2-256-etm@openssh.com", "hmac-sha2-512-etm@openssh.com" ], "TlsCiphers": [ "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", Examples 128 AWS Transfer Family API Reference "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" ] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 129 AWS Transfer Family DescribeServer API Reference Describes a ﬁle 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. Request Syntax { "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "Server": { "Arn": "string", "As2ServiceManagedEgressIpAddresses": [ "string" ], "Certificate": "string", "Domain": "string", "EndpointDetails": { "AddressAllocationIds": [ "string" ], DescribeServer 130 AWS Transfer Family API Reference "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" }, "EndpointType": "string", "HostKeyFingerprint": "string", "IdentityProviderDetails": { "DirectoryId": "string", "Function": "string", "InvocationRole": "string", "SftpAuthenticationMethods": "string", "Url": "string" }, "IdentityProviderType": "string", "LoggingRole": "string", "PostAuthenticationLoginBanner": "string", "PreAuthenticationLoginBanner": "string", "ProtocolDetails": { "As2Transports": [ "string" ], "PassiveIp": "string", "SetStatOption": "string", "TlsSessionResumptionMode": "string" }, "Protocols": [ "string" ], "S3StorageOptions": { "DirectoryListingOptimization": "string" }, "SecurityPolicyName": "string", "ServerId": "string", "State": "string", "StructuredLogDestinations": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "UserCount": number, "WorkflowDetails": { "OnPartialUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" Response Syntax 131 API Reference AWS Transfer Family } ], "OnUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ] } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Server An array containing the properties of a server with the ServerID you speciﬁed. Type: DescribedServer object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Response Elements 132 AWS Transfer Family HTTP Status Code: 400 ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example returns the properties assigned to a server. Sample Request { "ServerId": "s-01234567890abcdef" } Example This example illustrates one usage of DescribeServer. Sample Response { "Server": { "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef", "EndpointDetails": { "AddressAllocationIds": [ "eipalloc-01a2eabe3c04d5678", "eipalloc-102345be" ], "SubnetIds": [ "subnet-047eaa7f0187a7cde", "subnet-0a2d0f474daffde18" ], "VpcEndpointId": "vpce-03fe0080e7cb008b8", "VpcId": "vpc-09047a51f1c8e1634" Examples 133 API Reference AWS Transfer Family }, "EndpointType": "VPC", "HostKeyFingerprint": "your host key, "IdentityProviderType": "SERVICE_MANAGED", "ServerId": "s-01234567890abcdef", "State": "ONLINE", "Tags": [], "UserCount": 0 } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 134 AWS Transfer Family DescribeUser API Reference Describes the user assigned to the speciﬁc ﬁle transfer protocol-enabled server, as identiﬁed by its ServerId property. The response from this call returns the properties of the user associated with the ServerId value that was speciﬁed. Request Syntax { "ServerId": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server that has this user assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes UserName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform ﬁle transfer tasks. Type: String Length Constraints: Minimum length of 3. Maximum length of
transferfamily-api-031	transferfamily-api.pdf	31	Syntax { "ServerId": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server that has this user assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes UserName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform ﬁle transfer tasks. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. DescribeUser 135 AWS Transfer Family API Reference Pattern: [\w][\w@.-]{2,99} Required: Yes Response Syntax { "ServerId": "string", "User": { "Arn": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "SshPublicKeys": [ { "DateImported": number, "SshPublicKeyBody": "string", "SshPublicKeyId": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" } } Response Syntax 136 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServerId A system-assigned unique identiﬁer for a server that has this user assigned. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) User An array containing the properties of the Transfer Family user for the ServerID value that you speciﬁed. Type: DescribedUser object Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Response Elements 137 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example shows the details for an existing user. Sample Request aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-test Sample Response { "ServerId": "s-1111aaaa2222bbbb3", "User": { "Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob- test", "HomeDirectory": "/amzn-s3-demo-bucket", "HomeDirectoryType": "PATH", "Role": "arn:aws:iam::111122223333:role/bob-role", "SshPublicKeys": [ { "DateImported": "2022-03-31T12:27:52.614000-04:00", "SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us- east-1.amaazon.com", "SshPublicKeyId": "key-abcde12345fghik67" } ], "Tags": [], "UserName": "bob-test" } } Examples 138 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 139 AWS Transfer Family DescribeWebApp Describes the web app that's identiﬁed by WebAppId. API Reference Request Syntax { "WebAppId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WebAppId Provide the unique identiﬁer for the web app. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Syntax { "WebApp": { "AccessEndpoint": "string", "Arn": "string", "DescribedIdentityProviderDetails": { ... }, "Tags": [ { "Key": "string", "Value": "string" } ], DescribeWebApp 140 AWS Transfer Family API Reference "WebAppEndpoint": "string", "WebAppEndpointPolicy": "string", "WebAppId": "string", "WebAppUnits": { ... } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WebApp Returns a structure that contains the details of the web app. Type: DescribedWebApp object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Response Elements 141 AWS Transfer Family HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin
transferfamily-api-032	transferfamily-api.pdf	32	Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Response Elements 141 AWS Transfer Family HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 142 AWS Transfer Family API Reference DescribeWebAppCustomization Describes the web app customization object that's identiﬁed by WebAppId. Request Syntax { "WebAppId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WebAppId Provide the unique identiﬁer for the web app. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Syntax { "WebAppCustomization": { "Arn": "string", "FaviconFile": blob, "LogoFile": blob, "Title": "string", "WebAppId": "string" } } DescribeWebAppCustomization 143 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WebAppCustomization Returns a structure that contains the details of the web app customizations. Type: DescribedWebAppCustomization object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Response Elements 144 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 145 API Reference AWS Transfer Family DescribeWorkﬂow Describes the speciﬁed workﬂow. Request Syntax { "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Syntax { "Workflow": { "Arn": "string", "Description": "string", "OnExceptionSteps": [ { "CopyStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, DescribeWorkﬂow 146 AWS Transfer Family API Reference "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string" }, "CustomStepDetails": { "Name": "string", "SourceFileLocation": "string", "Target": "string", "TimeoutSeconds": number }, "DecryptStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string", "Type": "string" }, "DeleteStepDetails": { "Name": "string", "SourceFileLocation": "string" }, "TagStepDetails": { "Name": "string", "SourceFileLocation": "string", "Tags": [ { "Key": "string", "Value": "string" } ] Response Syntax 147 AWS Transfer Family API Reference }, "Type": "string" } ], "Steps": [ { "CopyStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string" }, "CustomStepDetails": { "Name": "string", "SourceFileLocation": "string", "Target": "string", "TimeoutSeconds": number }, "DecryptStepDetails": { "DestinationFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Key": "string" } }, "Name": "string", "OverwriteExisting": "string", "SourceFileLocation": "string", "Type": "string" }, "DeleteStepDetails": { Response Syntax 148 AWS Transfer Family API Reference "Name": "string", "SourceFileLocation": "string" }, "TagStepDetails": { "Name": "string", "SourceFileLocation": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Type": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "WorkflowId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Workﬂow The structure that contains the details of the workﬂow. Type: DescribedWorkﬂow object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements 149 AWS Transfer Family InternalServiceError API Reference This exception is thrown when
transferfamily-api-033	transferfamily-api.pdf	33	{ "Name": "string", "SourceFileLocation": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Type": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "WorkflowId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Workﬂow The structure that contains the details of the workﬂow. Type: DescribedWorkﬂow object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements 149 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 150 AWS Transfer Family ImportCertiﬁcate API Reference Imports the signing and encryption certiﬁcates that you need to create local (AS2) proﬁles and partner proﬁles. You can import both the certiﬁcate and its chain in the Certificate parameter. Note If you use the Certificate parameter to upload both the certiﬁcate and its chain, don't use the CertificateChain parameter. Request Syntax { "ActiveDate": number, "Certificate": "string", "CertificateChain": "string", "Description": "string", "InactiveDate": number, "PrivateKey": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Usage": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActiveDate An optional date that speciﬁes when the certiﬁcate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is speciﬁed by the CA. ImportCertiﬁcate 151 AWS Transfer Family Type: Timestamp Required: No Certiﬁcate API Reference • For the CLI, provide a ﬁle path for a certiﬁcate 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 certiﬁcate ﬁle. For example, --certificate "`cat encryption-cert.pem`". Note You can provide both the certiﬁcate and its chain in this parameter, without needing to use the CertificateChain parameter. If you use this parameter for both the certiﬁcate and its chain, do not use the CertificateChain parameter. Type: String Length Constraints: Minimum length of 1. Maximum length of 16384. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]* Required: Yes CertiﬁcateChain An optional list of certiﬁcates that make up the chain for the certiﬁcate that's being imported. Type: String Length Constraints: Minimum length of 1. Maximum length of 2097152. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]* Required: No Description A short description that helps identify the certiﬁcate. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Request Parameters 152 AWS Transfer Family Pattern: [\p{Graph}]+ Required: No InactiveDate API Reference An optional date that speciﬁes when the certiﬁcate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is speciﬁed by the CA. Type: Timestamp Required: No PrivateKey • For the CLI, provide a ﬁle 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 ﬁle. • For the SDK, specify the raw content of a private key ﬁle. For example, --private-key "`cat encryption-key.pem`" Type: String Length Constraints: Minimum length of 1. Maximum length of 16384. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]* Required: No Tags Key-value pairs that can be used to group and search for certiﬁcates. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Usage Speciﬁes how this certiﬁcate 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 Request Parameters 153 AWS Transfer Family Type: String Valid Values: SIGNING \| ENCRYPTION \| TLS API Reference Required: Yes Response Syntax { "CertificateId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CertiﬁcateId An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: String Length
transferfamily-api-034	transferfamily-api.pdf	34	used in the following ways: • SIGNING: For signing AS2 messages • ENCRYPTION: For encrypting AS2 messages • TLS: For securing AS2 communications sent over HTTPS Request Parameters 153 AWS Transfer Family Type: String Valid Values: SIGNING \| ENCRYPTION \| TLS API Reference Required: Yes Response Syntax { "CertificateId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CertiﬁcateId An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. Response Syntax 154 AWS Transfer Family HTTP Status Code: 400 ResourceNotFoundException API Reference This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example imports a certiﬁcate to use for encryption. In the ﬁrst command, we provide the contents of the certiﬁcate and certiﬁcate chain ﬁles. Use this format for SDK commands. aws transfer import-certificate --usage ENCRYPTION --certificate "`cat encryption- cert.pem`" \ --private-key "`cat encryption-key.pem`" --certificate-chain "`cat root-ca.pem`" Example The following example is identical to the preceding command, except that we provide the ﬁle locations for the private key, certiﬁcate, and certiﬁcate chain ﬁles. This version of the command doesn't work if you are using an SDK. aws transfer import-certificate --usage ENCRYPTION --certificate file://encryption- cert.pem \ --private-key file://encryption-key.pem --certificate-chain file://root-ca.pem See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Examples 155 API Reference AWS Transfer Family • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 156 AWS Transfer Family ImportHostKey API Reference Adds a host key to the server that's speciﬁed by the ServerId parameter. Request Syntax { "Description": "string", "HostKeyBody": "string", "ServerId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description The text description that identiﬁes this host key. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: [\p{Print}]* Required: No HostKeyBody The private key portion of an SSH key pair. AWS Transfer Family accepts RSA, ECDSA, and ED25519 keys. Type: String ImportHostKey 157 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 4096. Required: Yes ServerId The identiﬁer of the server that contains the host key that you are importing. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Tags Key-value pairs that can be used to group and search for host keys. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Response Syntax { "HostKeyId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. HostKeyId Returns the host key identiﬁer for the imported key. Response Syntax 158 API Reference AWS Transfer Family Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} ServerId Returns the server identiﬁer that contains the imported key. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 159 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of
transferfamily-api-035	transferfamily-api.pdf	35	a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 159 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 160 AWS Transfer Family API Reference ImportSshPublicKey Adds a Secure Shell (SSH) public key to a Transfer Family user identiﬁed by a UserName value assigned to the speciﬁc ﬁle transfer protocol-enabled server, identiﬁed by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId. Request Syntax { "ServerId": "string", "SshPublicKeyBody": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes SshPublicKeyBody The public key portion of an SSH key pair. AWS Transfer Family accepts RSA, ECDSA, and ED25519 keys. Type: String ImportSshPublicKey 161 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \s(ssh\|ecdsa)-[a-z0-9-]+[ \t]+(([A-Za-z0-9+/]{4})([A-Za-z0-9+/] {1,3})?(={0,3})?)(\s\|[ \t]+[\S \t]\s*) Required: Yes UserName The name of the Transfer Family user that is assigned to one or more servers. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Syntax { "ServerId": "string", "SshPublicKeyId": "string", "UserName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServerId A system-assigned unique identiﬁer for a server. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Response Syntax 162 AWS Transfer Family SshPublicKeyId API Reference The name given to a public key by the system that was imported. Type: String Length Constraints: Fixed length of 21. Pattern: key-[0-9a-f]{17} UserName A user name assigned to the ServerID value that you speciﬁed. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Errors 163 AWS Transfer Family HTTP Status Code: 400 ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example This command imports an ECDSA key stored in the id_ecdsa.pub ﬁle. aws transfer import-ssh-public-key --server-id s-021345abcdef6789 --ssh-public-key-body file://id_ecdsa.pub --user-name jane-doe Example If you run the previous command, the system returns the following information. { "ServerId": "s-021345abcdef6789", "SshPublicKeyId": "key-1234567890abcdef0", "UserName": "jane-doe" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples 164 AWS Transfer Family • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 165 AWS Transfer Family ListAccesses Lists the details for all the accesses you have on your server. API Reference Request Syntax { "MaxResults": number, "NextToken": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When you can get additional results from
transferfamily-api-036	transferfamily-api.pdf	36	V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 165 AWS Transfer Family ListAccesses Lists the details for all the accesses you have on your server. API Reference Request Syntax { "MaxResults": number, "NextToken": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ServerId A system-assigned unique identiﬁer for a server that has users assigned to it. ListAccesses 166 API Reference AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "Accesses": [ { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryType": "string", "Role": "string" } ], "NextToken": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Accesses Returns the accesses and their properties for the ServerId value that you specify. Type: Array of ListedAccess objects NextToken When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses. Type: String Response Syntax 167 AWS Transfer Family API Reference Length Constraints: Minimum length of 1. Maximum length of 6144. ServerId A system-assigned unique identiﬁer for a server that has users assigned to it. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 168 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 169 AWS Transfer Family ListAgreements API Reference Returns a list of the agreements for the server that's identiﬁed by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left oﬀ. Request Syntax { "MaxResults": number, "NextToken": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. ListAgreements 170 AWS Transfer Family Required: No ServerId The identiﬁer of the server for which you want a list of agreements. API Reference Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "Agreements": [ { "AgreementId": "string", "Arn": "string", "Description": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "ServerId": "string", "Status": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Agreements Returns an array, where each item contains the details of an agreement. Type: Array of ListedAgreement objects Response Syntax 171 AWS Transfer Family NextToken API Reference Returns a token that you can use to call ListAgreements
transferfamily-api-037	transferfamily-api.pdf	37	Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "Agreements": [ { "AgreementId": "string", "Arn": "string", "Description": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "ServerId": "string", "Status": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Agreements Returns an array, where each item contains the details of an agreement. Type: Array of ListedAgreement objects Response Syntax 171 AWS Transfer Family NextToken API Reference Returns a token that you can use to call ListAgreements again and receive additional results, if there are any. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 172 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 173 AWS Transfer Family ListCertiﬁcates API Reference Returns a list of the current certiﬁcates that have been imported into AWS 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 certiﬁcates from where you left oﬀ. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certiﬁcates. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ListCertiﬁcates 174 API Reference AWS Transfer Family Response Syntax { "Certificates": [ { "ActiveDate": number, "Arn": "string", "CertificateId": "string", "Description": "string", "InactiveDate": number, "Status": "string", "Type": "string", "Usage": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Certiﬁcates Returns an array of the certiﬁcates that are speciﬁed in the ListCertificates call. Type: Array of ListedCertiﬁcate objects NextToken Returns the next token, which you can use to list the next certiﬁcate. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax 175 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also 176 AWS Transfer Family • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 177 API Reference AWS Transfer Family ListConnectors Lists the connectors for the speciﬁed Region. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information
transferfamily-api-038	transferfamily-api.pdf	38	one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also 176 AWS Transfer Family • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 177 API Reference AWS Transfer Family ListConnectors Lists the connectors for the speciﬁed Region. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { ListConnectors 178 AWS Transfer Family API Reference "Connectors": [ { "Arn": "string", "ConnectorId": "string", "Url": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Connectors Returns an array, where each item contains the details of a connector. Type: Array of ListedConnector objects NextToken Returns a token that you can use to call ListConnectors again and receive additional results, if there are any. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. Response Elements 179 AWS Transfer Family HTTP Status Code: 400 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 180 AWS Transfer Family ListExecutions Lists all in-progress executions for the speciﬁed workﬂow. API Reference Note If the speciﬁed workﬂow ID cannot be found, ListExecutions returns a ResourceNotFound exception. Request Syntax { "MaxResults": number, "NextToken": "string", "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions. This is useful for pagination, for instance. If you have 100 executions for a workﬂow, you might only want to list ﬁrst 10. If so, call the API by specifying the max-results: ListExecutions 181 AWS Transfer Family API Reference aws transfer list-executions --max-results 10 This returns details for the ﬁrst 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Syntax { "Executions": [ { "ExecutionId": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { Response Syntax 182 AWS Transfer Family API Reference "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" } ], "NextToken": "string", "WorkflowId": "string" } Response Elements If the action is successful, the service sends back
transferfamily-api-039	transferfamily-api.pdf	39	Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Syntax { "Executions": [ { "ExecutionId": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { Response Syntax 182 AWS Transfer Family API Reference "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" } ], "NextToken": "string", "WorkflowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Executions Returns the details for each execution, in a ListedExecution array. Type: Array of ListedExecution objects NextToken ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. WorkﬂowId A unique identiﬁer for the workﬂow. Response Elements 183 AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors 184 API Reference AWS Transfer Family • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 185 AWS Transfer Family API Reference ListFileTransferResults Returns real-time updates and detailed information on the status of each individual ﬁle being transferred in a speciﬁc ﬁle transfer operation. You specify the ﬁle transfer by providing its ConnectorId and its TransferId. Note File transfer results are available up to 7 days after an operation has been requested. Request Syntax { "ConnectorId": "string", "MaxResults": number, "NextToken": "string", "TransferId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId A unique identiﬁer for a connector. This value should match the value supplied to the corresponding StartFileTransfer call. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes ListFileTransferResults 186 AWS Transfer Family MaxResults API Reference The maximum number of ﬁles to return in a single page. Note that currently you can specify a maximum of 10 ﬁle paths in a single StartFileTransfer operation. Thus, the maximum number of ﬁle transfer results that can be returned in a single page is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken If there are more ﬁle details than returned in this call, use this value for a subsequent call to ListFileTransferResults to retrieve them. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No TransferId A unique identiﬁer for a ﬁle transfer. This value should match the value supplied to the corresponding StartFileTransfer call. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [0-9a-zA-Z./-]+ Required: Yes Response Syntax { "FileTransferResults": [ { "FailureCode": "string", "FailureMessage": "string", Response Syntax 187 AWS Transfer Family API Reference "FilePath": "string", "StatusCode": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileTransferResults Returns the details for the ﬁles transferred in the transfer identiﬁed by the TransferId and ConnectorId speciﬁed. • FilePath: the ﬁlename and path to where the ﬁle 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. Type: Array of ConnectorFileTransferResult objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. NextToken Returns a
transferfamily-api-040	transferfamily-api.pdf	40	the ﬁles transferred in the transfer identiﬁed by the TransferId and ConnectorId speciﬁed. • FilePath: the ﬁlename and path to where the ﬁle 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. Type: Array of ConnectorFileTransferResult objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. NextToken Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Errors For information about the errors that are common to all actions, see Common Errors. Response Elements 188 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example returns a list of ﬁles for connector ID a-11112222333344444 and transfer ID aa1b2c3d4-5678-90ab-cdef-EXAMPLE11111. Sample Request aws transfer listFileTransferResults --connector-id a-11112222333344444 --transfer-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" Example An example response looks like the following. Sample Response { Examples 189 AWS Transfer Family API Reference "FileTransferResults": [ { "FilePath" : "my-stuff/hello.txt", "StatusCode": "COMPLETED" }, { "FilePath" : "my-stuff/texting.txt", "StatusCode": "FAILED", "FailureCode": "RETRIEVE_FILE_NOT_FOUND", "FailureMessage": "SFTP error (SSH_FX_NO_SUCH_FILE)" } ], "NextToken": "1111111" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 190 AWS Transfer Family ListHostKeys API Reference Returns a list of host keys for the server that's speciﬁed by the ServerId parameter. Request Syntax { "MaxResults": number, "NextToken": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ServerId The identiﬁer of the server that contains the host keys that you want to view. ListHostKeys 191 API Reference AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "HostKeys": [ { "Arn": "string", "DateImported": number, "Description": "string", "Fingerprint": "string", "HostKeyId": "string", "Type": "string" } ], "NextToken": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. HostKeys Returns an array, where each item contains the details of a host key. Type: Array of ListedHostKey objects NextToken Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any. Type: String Response Syntax 192 AWS Transfer Family API Reference Length Constraints: Minimum length of 1. Maximum length of 6144. ServerId Returns the server identiﬁer that contains the listed host keys. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 193 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET
transferfamily-api-041	transferfamily-api.pdf	41	NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Errors 193 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 194 AWS Transfer Family ListProﬁles API Reference Returns a list of the proﬁles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing proﬁles from where you left oﬀ. Request Syntax { "MaxResults": number, "NextToken": "string", "ProfileType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ListProﬁles 195 AWS Transfer Family ProﬁleType API Reference Indicates whether to list only LOCAL type proﬁles or only PARTNER type proﬁles. If not supplied in the request, the command lists all types of proﬁles. Type: String Valid Values: LOCAL \| PARTNER Required: No Response Syntax { "NextToken": "string", "Profiles": [ { "Arn": "string", "As2Id": "string", "ProfileId": "string", "ProfileType": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken Returns a token that you can use to call ListProfiles again and receive additional results, if there are any. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Proﬁles Returns an array, where each item contains the details of a proﬁle. Response Syntax 196 AWS Transfer Family API Reference Type: Array of ListedProﬁle objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors 197 API Reference AWS Transfer Family • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 198 AWS Transfer Family ListSecurityPolicies API Reference Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults Speciﬁes the number of security policies to return as a response to the ListSecurityPolicies query. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ListSecurityPolicies 199 AWS Transfer Family Response Syntax { "NextToken": "string",
transferfamily-api-042	transferfamily-api.pdf	42	Common Parameters. The request accepts the following data in JSON format. MaxResults Speciﬁes the number of security policies to return as a response to the ListSecurityPolicies query. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ListSecurityPolicies 199 AWS Transfer Family Response Syntax { "NextToken": "string", "SecurityPolicyNames": [ "string" ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. SecurityPolicyNames An array of security policies that were listed. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 Response Syntax 200 API Reference AWS Transfer Family InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example lists the names for all available security policies. Sample Request aws transfer list-security-policies Sample Response { "SecurityPolicyNames": [ "TransferSecurityPolicy-2023-05", "TransferSecurityPolicy-2022-03", "TransferSecurityPolicy-FIPS-2024-01", "TransferSecurityPolicy-2024-01", "TransferSecurityPolicy-PQ-SSH-FIPS-Experimental-2023-04", "TransferSecurityPolicy-PQ-SSH-Experimental-2023-04", "TransferSecurityPolicy-FIPS-2020-06", "TransferSecurityPolicy-2020-06", "TransferSecurityPolicy-2018-11", "TransferSecurityPolicy-FIPS-2023-05" ] Examples 201 AWS Transfer Family } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 202 AWS Transfer Family ListServers API Reference Lists the ﬁle transfer protocol-enabled servers that are associated with your AWS account. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults Speciﬁes the number of servers to return as a response to the ListServers query. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { "NextToken": "string", ListServers 203 API Reference AWS Transfer Family "Servers": [ { "Arn": "string", "Domain": "string", "EndpointType": "string", "IdentityProviderType": "string", "LoggingRole": "string", "ServerId": "string", "State": "string", "UserCount": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Servers An array of servers that were listed. Type: Array of ListedServer objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. Response Elements 204 AWS Transfer Family HTTP Status Code: 500 InvalidNextTokenException API Reference The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example lists the servers that exist in your AWS account. Note that the example NextToken values are not real: they are meant to indicate how to use the parameter. Sample Request { "MaxResults": 1, "NextToken": "token-from-previous-API-call" } Sample Response { "NextToken": "another-token-to-continue-listing", "Servers": [ { "Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
transferfamily-api-043	transferfamily-api.pdf	43	500 InvalidNextTokenException API Reference The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example lists the servers that exist in your AWS account. Note that the example NextToken values are not real: they are meant to indicate how to use the parameter. Sample Request { "MaxResults": 1, "NextToken": "token-from-previous-API-call" } Sample Response { "NextToken": "another-token-to-continue-listing", "Servers": [ { "Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef", Examples 205 AWS Transfer Family "Domain": "S3", "IdentityProviderType": "SERVICE_MANAGED", "EndpointType": "PUBLIC", "LoggingRole": "arn:aws:iam::111112222222:role/my-role", "ServerId": "s-01234567890abcdef", "State": "ONLINE", "UserCount": 3 API Reference } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 206 AWS Transfer Family API Reference ListTagsForResource Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. Request Syntax { "Arn": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Arn Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identiﬁer for a speciﬁc AWS resource, such as a server, user, or role. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes MaxResults Speciﬁes the number of tags to return as a response to the ListTagsForResource request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ListTagsForResource 207 AWS Transfer Family NextToken API Reference 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { "Arn": "string", "NextToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Arn The ARN you speciﬁed to list the tags of. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Response Syntax 208 AWS Transfer Family NextToken API Reference 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Tags Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you deﬁne. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. Errors 209 AWS Transfer Family HTTP Status Code: 500 Examples Example API Reference The following example lists the tags for the resource with the ARN you speciﬁed. Sample Request { "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef" } Example This example illustrates one usage of ListTagsForResource. Sample Response { "Tags": [ { "Key": "Name", "Value": "MyServer" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples 210 AWS Transfer Family • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 211 AWS Transfer Family ListUsers API Reference Lists the users for a ﬁle transfer protocol-enabled server that you specify by passing the ServerId parameter. Request Syntax
transferfamily-api-044	transferfamily-api.pdf	44	in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples 210 AWS Transfer Family • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 211 AWS Transfer Family ListUsers API Reference Lists the users for a ﬁle transfer protocol-enabled server that you specify by passing the ServerId parameter. Request Syntax { "MaxResults": number, "NextToken": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults Speciﬁes the number of users to return as a response to the ListUsers request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken If there are additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass the NextToken to a subsequent ListUsers command, to continue listing additional users. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No ListUsers 212 AWS Transfer Family ServerId API Reference A system-assigned unique identiﬁer for a server that has users assigned to it. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "NextToken": "string", "ServerId": "string", "Users": [ { "Arn": "string", "HomeDirectory": "string", "HomeDirectoryType": "string", "Role": "string", "SshPublicKeyCount": number, "UserName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users. Type: String Response Syntax 213 AWS Transfer Family API Reference Length Constraints: Minimum length of 1. Maximum length of 6144. ServerId A system-assigned unique identiﬁer for a server that the users are assigned to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Users Returns the Transfer Family users and their properties for the ServerId value that you specify. Type: Array of ListedUser objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. HTTP Status Code: 400 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 214 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The ListUsers API call returns a list of users associated with a server you specify. Sample Request { "MaxResults": 100, "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==", "ServerId": "s-01234567890abcdef" } Example This is a sample response for this API call. Sample Response { "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==", "ServerId": "s-01234567890abcdef", "Users": [ { "Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/ charlie", "HomeDirectory": "/tests/home/charlie", "SshPublicKeyCount": 1, "Role": "arn:aws:iam::176354371281:role/transfer-role1", "Tags": [ { "Key": "Name", "Value": "user1" Examples 215 AWS Transfer Family } ], "UserName": "my_user" } ] } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 216 AWS Transfer Family ListWebApps API Reference Lists all web apps associated with your AWS account for your current region. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { "NextToken": "string", ListWebApps 217 API Reference AWS Transfer Family "WebApps": [ { "AccessEndpoint": "string", "Arn": "string", "WebAppEndpoint": "string", "WebAppId": "string" } ] } Response Elements If the action
transferfamily-api-045	transferfamily-api.pdf	45	request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { "NextToken": "string", ListWebApps 217 API Reference AWS Transfer Family "WebApps": [ { "AccessEndpoint": "string", "Arn": "string", "WebAppEndpoint": "string", "WebAppId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken Provide this value for the NextToken parameter in a subsequent command to continue listing additional web apps. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. WebApps Returns, for each listed web app, a structure that contains details for the web app. Type: Array of ListedWebApp objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. Response Elements 218 AWS Transfer Family HTTP Status Code: 400 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 219 AWS Transfer Family ListWorkﬂows API Reference Lists all workﬂows associated with your AWS account for your current region. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No NextToken ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workﬂows. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Required: No Response Syntax { "NextToken": "string", ListWorkﬂows 220 AWS Transfer Family API Reference "Workflows": [ { "Arn": "string", "Description": "string", "WorkflowId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workﬂows. Type: String Length Constraints: Minimum length of 1. Maximum length of 6144. Workﬂows Returns the Arn, WorkflowId, and Description for each workﬂow. Type: Array of ListedWorkﬂow objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidNextTokenException The NextToken parameter that was passed is invalid. Response Elements 221 AWS Transfer Family HTTP Status Code: 400 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 222 AWS Transfer Family API Reference SendWorkﬂowStepState 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 workﬂow. You must include those with their callback as well as providing a status. Request Syntax { "ExecutionId": "string", "Status": "string", "Token": "string", "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExecutionId A unique identiﬁer for
transferfamily-api-046	transferfamily-api.pdf	46	SDK for Python • AWS SDK for Ruby V3 See Also 222 AWS Transfer Family API Reference SendWorkﬂowStepState 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 workﬂow. You must include those with their callback as well as providing a status. Request Syntax { "ExecutionId": "string", "Status": "string", "Token": "string", "WorkflowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExecutionId A unique identiﬁer for the execution of a workﬂow. Type: String Length Constraints: Fixed length of 36. Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12} Required: Yes Status Indicates whether the speciﬁed step succeeded or failed. Type: String Valid Values: SUCCESS \| FAILURE SendWorkﬂowStepState 223 AWS Transfer Family Required: Yes Token API Reference Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: \w+ Required: Yes WorkﬂowId A unique identiﬁer for the workﬂow. Type: String Length Constraints: Fixed length of 19. Pattern: w-([a-z0-9]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. Response Elements 224 AWS Transfer Family HTTP Status Code: 500 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 225 AWS Transfer Family API Reference See Also 226 AWS Transfer Family API Reference StartDirectoryListing 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 ﬁles and directories in the remote directory (up to the maximum value), but does not return ﬁles or folders in sub-directories. That is, it only returns a list of ﬁles and directories one-level deep. After you receive the listing ﬁle, you can provide the ﬁles that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call. The naming convention for the output ﬁle is connector-ID-listing-ID.json. The output ﬁle contains the following information: • filePath: the complete path of a remote ﬁle, relative to the directory of the listing request for your SFTP connector on the remote server. • modifiedTimestamp: the last time the ﬁle was modiﬁed, in UTC time format. This ﬁeld is optional. If the remote ﬁle attributes don't contain a timestamp, it is omitted from the ﬁle listing. • size: the size of the ﬁle, in bytes. This ﬁeld is optional. If the remote ﬁle attributes don't contain a ﬁle size, it is omitted from the ﬁle 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 ﬂag 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). Request Syntax { "ConnectorId": "string", "MaxItems": number, "OutputDirectoryPath": "string", "RemoteDirectoryPath": "string" } StartDirectoryListing 227 AWS Transfer Family Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes MaxItems An optional parameter where you can specify the
transferfamily-api-047	transferfamily-api.pdf	47	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). Request Syntax { "ConnectorId": "string", "MaxItems": number, "OutputDirectoryPath": "string", "RemoteDirectoryPath": "string" } StartDirectoryListing 227 AWS Transfer Family Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes MaxItems An optional parameter where you can specify the maximum number of ﬁle/directory names to retrieve. The default value is 1,000. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: No OutputDirectoryPath Speciﬁes the path (bucket and preﬁx) in Amazon S3 storage to store the results of the directory listing. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes RemoteDirectoryPath Speciﬁes the directory on the remote SFTP server for which you want to list its contents. Request Parameters 228 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes Response Syntax { "ListingId": "string", "OutputFileName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListingId Returns a unique identiﬁer for the directory listing call. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [0-9a-zA-Z./-]+ OutputFileName Returns the ﬁle name where the results are stored. This is a combination of the connector ID and the listing ID: <connector-id>-<listing-id>.json. Type: String Length Constraints: Minimum length of 26. Maximum length of 537. Pattern: c-([0-9a-f]{17})-[0-9a-zA-Z./-]+.json Response Syntax 229 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example lists the contents of the home folder on the remote SFTP server, which is identiﬁed by the speciﬁed connector. The results are placed into the Amazon S3 location /amzn-s3-demo-bucket/connector-files, and into a ﬁle named c- AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json. Errors 230 AWS Transfer Family Sample Request { API Reference "ConnectorId": "c-AAAA1111BBBB2222C", "MaxItems": "10", "OutputDirectoryPath": "/amzn-s3-demo-bucket/connector-files", "RemoteDirectoryPath": "/home" } Sample Response { "ListingId": "6666abcd-11aa-22bb-cc33-0000aaaa3333", "OutputFileName": "c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json" } // under bucket "amzn-s3-demo-bucket" connector-files/c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json { "files": [ { "filePath": "/home/what.txt", "modifiedTimestamp": "2024-01-30T20:34:54Z", "size" : 2323 }, { "filePath": "/home/how.pgp", "modifiedTimestamp": "2024-01-30T20:34:54Z", "size" : 51238 } ], "paths": [ { "path": "/home/magic" }, { "path": "/home/aws" }, ], "truncated": false } Examples 231 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 232 AWS Transfer Family StartFileTransfer API Reference Begins a ﬁle transfer between local AWS storage and a remote AS2 or SFTP server. • For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the ﬁles you want to transfer. • For an SFTP connector, the ﬁle 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 ﬁle from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the ﬁles you want to transfer, and a LocalDirectoryPath to specify the destination folder. • If you are transferring ﬁle to a partner's SFTP server from AWS storage, you specify one or more SendFilePaths to identify the ﬁles you want to transfer, and a RemoteDirectoryPath to specify the destination folder. Request Syntax { "ConnectorId": "string", "LocalDirectoryPath": "string", "RemoteDirectoryPath": "string", "RetrieveFilePaths": [ "string" ], "SendFilePaths": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type:
transferfamily-api-048	transferfamily-api.pdf	48	ﬁles you want to transfer, and a LocalDirectoryPath to specify the destination folder. • If you are transferring ﬁle to a partner's SFTP server from AWS storage, you specify one or more SendFilePaths to identify the ﬁles you want to transfer, and a RemoteDirectoryPath to specify the destination folder. Request Syntax { "ConnectorId": "string", "LocalDirectoryPath": "string", "RemoteDirectoryPath": "string", "RetrieveFilePaths": [ "string" ], "SendFilePaths": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. StartFileTransfer 233 AWS Transfer Family API Reference Pattern: c-([0-9a-f]{17}) Required: Yes LocalDirectoryPath For an inbound transfer, the LocaDirectoryPath speciﬁes the destination for one or more ﬁles that are transferred from the partner's SFTP server. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: No RemoteDirectoryPath For an outbound transfer, the RemoteDirectoryPath speciﬁes the destination for one or more ﬁles that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred ﬁles is the SFTP user's home directory. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: No RetrieveFilePaths One or more source paths for the partner's SFTP server. Each string represents a source ﬁle path for one inbound ﬁle transfer. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: No Request Parameters 234 AWS Transfer Family SendFilePaths API Reference One or more source paths for the Amazon S3 storage. Each string represents a source ﬁle path for one outbound ﬁle transfer. For example, amzn-s3-demo-bucket/myfile.txt . Note Replace amzn-s3-demo-bucket with one of your actual buckets. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: No Response Syntax { "TransferId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TransferId Returns the unique identiﬁer for the ﬁle transfer. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [0-9a-zA-Z./-]+ Response Syntax 235 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example starts an AS2 ﬁle transfer from a Transfer Family server to a remote trading partner's endpoint. Replace amzn-s3-demo-bucket with one of your actual buckets. Sample Request { "ConnectorId": "c-AAAA1111BBBB2222C", Errors 236 API Reference AWS Transfer Family "SendFilePaths": [ "/amzn-s3-demo-bucket/myfile-1.txt", "/amzn-s3-demo-bucket/myfile-2.txt", "/amzn-s3-demo-bucket/myfile-3.txt" ] } Sample Response { "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } Example The following example starts a ﬁle transfer from local AWS storage to a remote SFTP server. Sample Request { "ConnectorId": "c-01234567890abcdef", "SendFilePaths": [ "/amzn-s3-demo-bucket/myfile-1.txt", "/amzn-s3-demo-bucket/myfile-2.txt", "/amzn-s3-demo-bucket/myfile-3.txt" ], "RemoteDirectoryPath": "/MySFTPRootFolder/fromTranferFamilyServer" } Sample Response { "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } Example The following example starts a ﬁle transfer from a remote SFTP server to local AWS storage. Sample Request { Examples 237 AWS Transfer Family API Reference "ConnectorId": "c-111122223333AAAAA", "RetrieveFilePaths": [ "/MySFTPFolder/toTranferFamily/myfile-1.txt", "/MySFTPFolder/toTranferFamily/myfile-2.txt", "/MySFTPFolder/toTranferFamily/myfile-3.txt" ], "LocalDirectoryPath": "/amzn-s3-demo-bucket/mySourceFiles" } Sample Response { "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 238 AWS Transfer Family StartRemoteDelete Deletes a ﬁle or directory on the remote SFTP server. API Reference Request Syntax { "ConnectorId": "string", "DeletePath": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes DeletePath The absolute path of the ﬁle or directory to delete. You can only specify one path
transferfamily-api-049	transferfamily-api.pdf	49	V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 238 AWS Transfer Family StartRemoteDelete Deletes a ﬁle or directory on the remote SFTP server. API Reference Request Syntax { "ConnectorId": "string", "DeletePath": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes DeletePath The absolute path of the ﬁle or directory to delete. You can only specify one path per call to this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes StartRemoteDelete 239 AWS Transfer Family Response Syntax { "DeleteId": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeleteId Returns a unique identiﬁer for the delete operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [0-9a-zA-Z./-]+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Response Syntax 240 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example deletes a ﬁle on the remote SFTP server in the path /delete/folder/ deleteFile, and returns a unique identiﬁer for the operation. aws transfer start-remote-delete --connector-id c-AAAA1111BBBB2222C \ --delete-path /delete/folder/deleteFile See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Examples 241 AWS Transfer Family API Reference See Also 242 AWS Transfer Family StartRemoteMove Moves or renames a ﬁle or directory on the remote SFTP server. API Reference Request Syntax { "ConnectorId": "string", "SourcePath": "string", "TargetPath": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes SourcePath The absolute path of the ﬁle or directory to move or rename. You can only specify one path per call to this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes StartRemoteMove 243 AWS Transfer Family TargetPath API Reference The absolute path for the target of the move/rename operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes Response Syntax { "MoveId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MoveId Returns a unique identiﬁer for the move/rename operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [0-9a-zA-Z./-]+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. Response Syntax 244 AWS Transfer Family HTTP Status Code: 500 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example moves a ﬁle on the remote SFTP server from /source/folder/ sourceFile to /destination/targetFile, and returns a unique identiﬁer for the operation. aws transfer --connector-id c-AAAA1111BBBB2222C start-remote-move \ --source-path /source/folder/sourceFile --target-path /destination/targetFile See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples 245 API Reference AWS Transfer Family • AWS SDK for C++ • AWS SDK for Go
transferfamily-api-050	transferfamily-api.pdf	50	available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example moves a ﬁle on the remote SFTP server from /source/folder/ sourceFile to /destination/targetFile, and returns a unique identiﬁer for the operation. aws transfer --connector-id c-AAAA1111BBBB2222C start-remote-move \ --source-path /source/folder/sourceFile --target-path /destination/targetFile See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples 245 API Reference AWS Transfer Family • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 246 AWS Transfer Family StartServer API Reference Changes the state of a ﬁle transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process ﬁle transfer jobs. The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition. No response is returned from this call. Request Syntax { "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server that you start. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. StartServer 247 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example starts a server. Sample Request { "ServerId": "s-01234567890abcdef" } Example This is a sample response for this API call. Examples 248 AWS Transfer Family Sample Response { "ServerId": "s-01234567890abcdef" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 249 AWS Transfer Family StopServer API Reference Changes the state of a ﬁle transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process ﬁle transfer jobs. Information tied to your server, such as server and user properties, are not aﬀected by stopping your server. Note Stopping the server does not reduce or impact your ﬁle transfer protocol endpoint billing; you must delete the server to stop being billed. The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully oﬄine. The values of STOP_FAILED can indicate an error condition. No response is returned from this call. Request Syntax { "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned unique identiﬁer for a server that you stopped. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes StopServer 250 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP
transferfamily-api-051	transferfamily-api.pdf	51	empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example stops a server. Response Elements 251 API Reference AWS Transfer Family Sample Request { "ServerId": "s-01234567890abcdef" } Example This is a sample response for this API call. Sample Response { "ServerId": "s-01234567890abcdef" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 252 AWS Transfer Family TagResource API Reference Attaches a key-value pair to a resource, as identiﬁed by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. Request Syntax { "Arn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Arn An Amazon Resource Name (ARN) for a speciﬁc AWS resource, such as a server, user, or role. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes Tags Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workﬂows, and so on) for any purpose. TagResource 253 AWS Transfer Family Type: Array of Tag objects API Reference Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example adds a tag to a ﬁle transfer protocol-enabled server. Response Elements 254 AWS Transfer Family Sample Request { "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef", API Reference "Tags": [ { "Key": "Group", "Value": "Europe" } ] } Example This example illustrates one usage of TagResource. Sample Response HTTP 200 response with an empty HTTP body. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 255 AWS Transfer Family API Reference See Also 256 AWS Transfer Family TestConnection API Reference Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer ﬁles between local AWS storage and a trading partner's SFTP server. Request Syntax { "ConnectorId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes Response Syntax { "ConnectorId": "string", "SftpConnectionDetails": { "HostKey": "string" }, "Status": "string", "StatusMessage": "string" } TestConnection 257 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectorId Returns the identiﬁer of the connector object that you are testing. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) SftpConnectionDetails Structure that contains
transferfamily-api-052	transferfamily-api.pdf	52	accepts the following data in JSON format. ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes Response Syntax { "ConnectorId": "string", "SftpConnectionDetails": { "HostKey": "string" }, "Status": "string", "StatusMessage": "string" } TestConnection 257 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectorId Returns the identiﬁer of the connector object that you are testing. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) SftpConnectionDetails Structure that contains the SFTP connector host key. Type: SftpConnectorConnectionDetails object Status Returns OK for successful test, or ERROR if the test fails. Type: String StatusMessage 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 conﬁguration , 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 conﬁguration matches the ssh-keyscan output. Type: String Response Elements 258 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example tests the connection to a remote server. aws transfer test-connection --connector-id c-abcd1234567890fff Sample Response If successful the API call returns the following details. { Errors 259 AWS Transfer Family API Reference "Status": "OK", "StatusMessage": "Connection succeeded" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 260 AWS Transfer Family API Reference TestIdentityProvider If the IdentityProviderType of a ﬁle 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 ﬁeld 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 diﬀerent 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). Request Syntax { "ServerId": "string", TestIdentityProvider 261 AWS Transfer Family API Reference "ServerProtocol": "string", "SourceIp": "string", "UserName": "string", "UserPassword": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned identiﬁer for a speciﬁc server. That server's user authentication method is tested with a user name and password. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes ServerProtocol The type of ﬁle 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) Type: String Valid Values: SFTP \|
transferfamily-api-053	transferfamily-api.pdf	53	For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ServerId A system-assigned identiﬁer for a speciﬁc server. That server's user authentication method is tested with a user name and password. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes ServerProtocol The type of ﬁle 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) Type: String Valid Values: SFTP \| FTP \| FTPS \| AS2 Required: No SourceIp The source IP address of the account to be tested. Request Parameters 262 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} Required: No UserName The name of the account to be tested. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes UserPassword The password of the account to be tested. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Response Syntax { "Message": "string", "Response": "string", "StatusCode": number, "Url": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax 263 AWS Transfer Family Message API Reference 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. Type: String Response The response that is returned from your API Gateway or your Lambda function. Type: String StatusCode The HTTP status code that is the response from your API Gateway or your Lambda function. Type: Integer Url The endpoint of the service used to authenticate a user. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. Errors 264 AWS Transfer Family HTTP Status Code: 400 ResourceNotFoundException API Reference This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following request returns a message from an identity provider that a user name and password combination is a valid identity to use with AWS Transfer Family. Sample Request { "ServerID": "s-01234567890abcdef", "UserName": "my_user", "UserPassword": "MyPassword-1" } Example The following response shows a sample response for a successful test. Sample Response "Response":" {\"homeDirectory\":\"/mybucket001\",\"homeDirectoryDetails\":null, \"homeDirectoryType\":\"PATH\",\"posixProfile\":null, \"publicKeys\":\"[ssh-rsa-key]\",\"role\":\"arn:aws:iam::123456789012:role/ my_role\",\"policy\":null,\"username\":\"transferuser002\", Examples 265 AWS Transfer Family API Reference \"identityProviderType\":null,\"userConfigMessage\":null)"} "StatusCode": "200", "Message": "" Example The following response indicates that the speciﬁed user belongs to more than one group that has access. "Response":"", "StatusCode":200, "Message":"More than one associated access found for user's groups." Example If you have created and conﬁgured a custom identity provider by using an API Gateway, you can enter the following command to test your user: aws transfer test-identity-provider --server-id s-0123456789abcdefg --user- name myuser where s-0123456789abcdefg is your transfer server, and myuser is the username for your custom user. If the command succeeds, your response is similar to the following, where: • AWS account ID is 012345678901 • User role is user-role-api-gateway • Home directory is myuser-bucket • Public key is public-key • Invocation URL is invocation-URL { "Response": "{\"Role\": \"arn:aws:iam::012345678901:role/user-role-api-gateway\", \"HomeDirectory\": \"/myuser-bucket\",\"PublicKeys\": \"[public-key]\"}", "StatusCode": 200, Examples 266 AWS Transfer Family "Message": "", API Reference "Url": "https://invocation-URL/servers/s-0123456789abcdefg/users/myuser/config" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 267 AWS Transfer Family UntagResource API Reference Detaches a key-value pair from a resource, as identiﬁed by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. Request Syntax { "Arn": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Arn The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identiﬁer
transferfamily-api-054	transferfamily-api.pdf	54	• AWS SDK for Ruby V3 See Also 267 AWS Transfer Family UntagResource API Reference Detaches a key-value pair from a resource, as identiﬁed by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. Request Syntax { "Arn": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Arn The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identiﬁer for a speciﬁc AWS resource, such as a server, user, or role. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes TagKeys TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 128. UntagResource 268 AWS Transfer Family Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 Examples Example The following example removes a tag of a ﬁle transfer protocol-enabled server. Sample Request Response Elements 269 AWS Transfer Family { API Reference "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef", "TagKeys": "Europe" ] } Example This example illustrates one usage of UntagResource. Sample Response HTTP 200 response with an empty HTTP body. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 270 AWS Transfer Family UpdateAccess API Reference Allows you to update parameters for the access speciﬁed in the ServerID and ExternalID parameters. Request Syntax { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExternalId A unique identiﬁer that is required to identify speciﬁc groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. UpdateAccess 271 AWS Transfer Family API Reference Get-ADGroup -Filter {samAccountName -like "YourGroupName"} -Properties \| Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ Required: Yes HomeDirectory The landing directory (folder) for a user when they log in to the server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. Note The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.*) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must Request Parameters 272 AWS Transfer Family API Reference ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value
transferfamily-api-055	transferfamily-api.pdf	55	(\|/.) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must Request Parameters 272 AWS Transfer Family API Reference ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. 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" } ] Type: Array of HomeDirectoryMapEntry objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No HomeDirectoryType The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their ﬁle 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. Type: String Valid Values: PATH \| LOGICAL Request Parameters 273 AWS Transfer Family Required: No Policy API Reference A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Note This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, AWS 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 AWSSecurity Token Service API Reference. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No PosixProﬁle 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in your ﬁle system determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS ﬁle system. The policies attached to this role determine the level of access that you want to provide your users when Request Parameters 274 AWS Transfer Family API Reference transferring ﬁles into and out of your Amazon S3 bucket or Amazon EFS ﬁle system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No ServerId A system-assigned unique identiﬁer for a server instance. This is the speciﬁc server that you added your user to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "ExternalId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ExternalId The external identiﬁer of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWSTransfer Family. Response Syntax 275 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ ServerId The identiﬁer of the server that the user is attached to. Type: String Length Constraints: Fixed
transferfamily-api-056	transferfamily-api.pdf	56	Yes Response Syntax { "ExternalId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ExternalId The external identiﬁer of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWSTransfer Family. Response Syntax 275 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ ServerId The identiﬁer of the server that the user is attached to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 276 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 277 AWS Transfer Family UpdateAgreement API Reference Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update. Note Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail. If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used. Request Syntax { "AccessRole": "string", "AgreementId": "string", "BaseDirectory": "string", "CustomDirectories": { "FailedFilesDirectory": "string", "MdnFilesDirectory": "string", "PayloadFilesDirectory": "string", "StatusFilesDirectory": "string", "TemporaryFilesDirectory": "string" }, "Description": "string", "EnforceMessageSigning": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "PreserveFilename": "string", "ServerId": "string", "Status": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. UpdateAgreement 278 AWS Transfer Family API Reference The request accepts the following data in JSON format. AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.*role/\S+ Required: No AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Request Parameters 279 AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: Yes BaseDirectory API Reference To change the landing directory (folder) for ﬁles that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory . Type: String Length Constraints: Minimum length of 0. Maximum length of 1024.
transferfamily-api-057	transferfamily-api.pdf	57	sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Request Parameters 279 AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: Yes BaseDirectory API Reference To change the landing directory (folder) for ﬁles that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory . Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: No CustomDirectories A CustomDirectoriesType structure. This structure speciﬁes custom directories for storing various AS2 message ﬁles. You can specify directories for the following types of ﬁles. • Failed ﬁles • MDN ﬁles • Payload ﬁles • Status ﬁles • Temporary ﬁles Type: CustomDirectoriesType object Required: No Description To replace the existing description, provide a short description for the agreement. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Request Parameters 280 AWS Transfer Family Pattern: [\p{Graph}]+ Required: No EnforceMessageSigning API Reference Determines whether or not unsigned messages from your trading partners will be accepted. • ENABLED: Transfer Family rejects unsigned messages from your trading partner. • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner. Type: String Valid Values: ENABLED \| DISABLED Required: No LocalProﬁleId A unique identiﬁer for the AS2 local proﬁle. To change the local proﬁle identiﬁer, provide a new value here. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No PartnerProﬁleId A unique identiﬁer for the partner proﬁle. To change the partner proﬁle identiﬁer, provide a new value here. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No Request Parameters 281 AWS Transfer Family PreserveFilename API Reference Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload ﬁlename when saving it. • ENABLED: the ﬁlename provided by your trading parter is preserved when the ﬁle is saved. • DISABLED (default value): when Transfer Family saves the ﬁle, the ﬁlename is adjusted, as described in File names and locations. Type: String Valid Values: ENABLED \| DISABLED Required: No ServerId A system-assigned unique identiﬁer for a server instance. This is the speciﬁc server that the agreement uses. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Status You can update the status for the agreement, either activating an inactive agreement or the reverse. Type: String Valid Values: ACTIVE \| INACTIVE Required: No Response Syntax { "AgreementId": "string" Response Syntax 282 AWS Transfer Family } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. Response Elements 283 AWS Transfer Family HTTP Status Code: 400 ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 284 AWS Transfer Family UpdateCertiﬁcate Updates the active and inactive dates for a certiﬁcate. API Reference Request Syntax { "ActiveDate": number, "CertificateId": "string", "Description": "string", "InactiveDate": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActiveDate An optional date that speciﬁes when the certiﬁcate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is speciﬁed by the CA. Type: Timestamp Required: No CertiﬁcateId The identiﬁer of the certiﬁcate object
transferfamily-api-058	transferfamily-api.pdf	58	for Ruby V3 See Also 284 AWS Transfer Family UpdateCertiﬁcate Updates the active and inactive dates for a certiﬁcate. API Reference Request Syntax { "ActiveDate": number, "CertificateId": "string", "Description": "string", "InactiveDate": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActiveDate An optional date that speciﬁes when the certiﬁcate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is speciﬁed by the CA. Type: Timestamp Required: No CertiﬁcateId The identiﬁer of the certiﬁcate object that you are updating. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: Yes Description A short description to help identify the certiﬁcate. UpdateCertiﬁcate 285 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: [\p{Graph}]+ Required: No InactiveDate An optional date that speciﬁes when the certiﬁcate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is speciﬁed by the CA. Type: Timestamp Required: No Response Syntax { "CertificateId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CertiﬁcateId Returns the identiﬁer of the certiﬁcate object that you are updating. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax 286 AWS Transfer Family InternalServiceError API Reference This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example updates the active date for a certiﬁcate, setting the active date to January 16, 2022 at 16:12:07 UTC -5 hours. Sample Request aws transfer update-certificate --certificate-id c-abcdefg123456hijk --active-date 2022-01-16T16:12:07-05:00 Example The following is a sample response for this API call. Examples 287 AWS Transfer Family Sample Response "CertificateId": "c-abcdefg123456hijk" See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 288 AWS Transfer Family UpdateConnector API Reference 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. Request Syntax { "AccessRole": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "PreserveContentType": "string", "SigningAlgorithm": "string" }, "ConnectorId": "string", "LoggingRole": "string", "SecurityPolicyName": "string", "SftpConfig": { "MaxConcurrentConnections": number, "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Url": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. UpdateConnector 289 AWS Transfer Family AccessRole API Reference Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides
transferfamily-api-059	transferfamily-api.pdf	59	provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No As2Conﬁg A structure that contains the parameters for an AS2 connector object. Type: As2ConnectorConﬁg object Request Parameters 290 API Reference AWS Transfer Family Required: No ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: Yes LoggingRole The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No SecurityPolicyName Speciﬁes the name of the security policy for the connector. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ Required: No SftpConﬁg A structure that contains the parameters for an SFTP connector object. Type: SftpConnectorConﬁg object Request Parameters 291 AWS Transfer Family Required: No Url The URL of the partner's AS2 or SFTP endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. API Reference Required: No Response Syntax { "ConnectorId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectorId Returns the identiﬁer of the connector object that you are updating. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. Response Syntax 292 AWS Transfer Family HTTP Status Code: 500 InvalidRequestException API Reference This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceExistsException The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also 293 AWS Transfer Family • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also 294 AWS Transfer Family UpdateHostKey API Reference Updates the description for the host key that's speciﬁed by the ServerId and HostKeyId parameters. Request Syntax { "Description": "string", "HostKeyId": "string", "ServerId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description An updated description for the host key. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: [\p{Print}]* Required: Yes HostKeyId The identiﬁer of the host key that you are updating. Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} Required: Yes UpdateHostKey 295 AWS Transfer Family ServerId API Reference The identiﬁer of the server that contains the host key that you are updating. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "HostKeyId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. HostKeyId Returns the host key identiﬁer for the updated host key. Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} ServerId Returns the server identiﬁer for the server that contains the updated host key. Type:
transferfamily-api-060	transferfamily-api.pdf	60	Family ServerId API Reference The identiﬁer of the server that contains the host key that you are updating. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes Response Syntax { "HostKeyId": "string", "ServerId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. HostKeyId Returns the host key identiﬁer for the updated host key. Type: String Length Constraints: Fixed length of 25. Pattern: hostkey-[0-9a-f]{17} ServerId Returns the server identiﬁer for the server that contains the updated host key. Type: String Length Constraints: Fixed length of 19. Response Syntax 296 AWS Transfer Family API Reference Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors 297 API Reference AWS Transfer Family • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 298 AWS Transfer Family UpdateProﬁle API Reference Updates some of the parameters for an existing proﬁle. Provide the ProfileId for the proﬁle that you want to update, along with the new values for the parameters to update. Request Syntax { "CertificateIds": [ "string" ], "ProfileId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CertiﬁcateIds An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: Array of strings Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: No ProﬁleId The identiﬁer of the proﬁle object that you are updating. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: Yes UpdateProﬁle 299 API Reference AWS Transfer Family Response Syntax { "ProfileId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ProﬁleId Returns the identiﬁer for the proﬁle that's being updated. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Response Syntax 300 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 301 AWS Transfer Family UpdateServer API Reference Updates the ﬁle transfer protocol-enabled server's properties after that server has been created. The UpdateServer call returns the ServerId of the server you updated. Request Syntax { "Certificate": "string", "EndpointDetails": { "AddressAllocationIds": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" }, "EndpointType": "string", "HostKey": "string", "IdentityProviderDetails": { "DirectoryId": "string", "Function": "string", "InvocationRole": "string", "SftpAuthenticationMethods": "string", "Url": "string" }, "LoggingRole": "string", "PostAuthenticationLoginBanner": "string", "PreAuthenticationLoginBanner": "string", "ProtocolDetails": { "As2Transports": [ "string" ], "PassiveIp": "string", "SetStatOption": "string", "TlsSessionResumptionMode": "string" }, "Protocols": [ "string" ], "S3StorageOptions": { "DirectoryListingOptimization": "string" }, "SecurityPolicyName": "string", "ServerId": "string", "StructuredLogDestinations": [ "string" ], "WorkflowDetails": { UpdateServer 302 AWS Transfer Family API Reference "OnPartialUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ], "OnUpload": [
transferfamily-api-061	transferfamily-api.pdf	61	server you updated. Request Syntax { "Certificate": "string", "EndpointDetails": { "AddressAllocationIds": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" }, "EndpointType": "string", "HostKey": "string", "IdentityProviderDetails": { "DirectoryId": "string", "Function": "string", "InvocationRole": "string", "SftpAuthenticationMethods": "string", "Url": "string" }, "LoggingRole": "string", "PostAuthenticationLoginBanner": "string", "PreAuthenticationLoginBanner": "string", "ProtocolDetails": { "As2Transports": [ "string" ], "PassiveIp": "string", "SetStatOption": "string", "TlsSessionResumptionMode": "string" }, "Protocols": [ "string" ], "S3StorageOptions": { "DirectoryListingOptimization": "string" }, "SecurityPolicyName": "string", "ServerId": "string", "StructuredLogDestinations": [ "string" ], "WorkflowDetails": { UpdateServer 302 AWS Transfer Family API Reference "OnPartialUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ], "OnUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ] } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Certiﬁcate The Amazon Resource Name (ARN) of the AWSCertiﬁcate Manager (ACM) certiﬁcate. Required when Protocols is set to FTPS. To request a new public certiﬁcate, see Request a public certiﬁcate in the AWSCertiﬁcate Manager User Guide. To import an existing certiﬁcate into ACM, see Importing certiﬁcates into ACM in the AWSCertiﬁcate Manager User Guide. To request a private certiﬁcate to use FTPS through private IP addresses, see Request a private certiﬁcate in the AWSCertiﬁcate Manager User Guide. Certiﬁcates 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) Request Parameters 303 AWS Transfer Family Note API Reference The certiﬁcate must be a valid SSL/TLS X.509 version 3 certiﬁcate with FQDN or IP address speciﬁed and information about the issuer. Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Required: No EndpointDetails The virtual private cloud (VPC) endpoint settings that are conﬁgured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint. Type: EndpointDetails object Required: No EndpointType The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it. Note After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021, you will not be aﬀected. After this date, use EndpointType=VPC. For more information, see Discontinuing the use of 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 Request Parameters 304 AWS Transfer Family API Reference included) with your server's endpoint and use VPC security groups to restrict traﬃc by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT. Type: String Valid Values: PUBLIC \| VPC \| VPC_ENDPOINT Required: No HostKey The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use diﬀerent 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. Important 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. Request Parameters 305 AWS Transfer Family API Reference For more information, see Update host keys for your SFTP-enabled server in the AWS Transfer Family User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No
transferfamily-api-062	transferfamily-api.pdf	62	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. Important 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. Request Parameters 305 AWS Transfer Family API Reference For more information, see Update host keys for your SFTP-enabled server in the AWS Transfer Family User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No IdentityProviderDetails An array containing all of the information required to call a customer's authentication API method. Type: IdentityProviderDetails object Required: No LoggingRole The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: (\|arn:.role/\S+) Required: No PostAuthenticationLoginBanner Speciﬁes 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Request Parameters 306 AWS Transfer Family API Reference Pattern: [\x09-\x0D\x20-\x7E] Required: No PreAuthenticationLoginBanner Speciﬁes a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Pattern: [\x09-\x0D\x20-\x7E]* Required: No ProtocolDetails The protocol settings that are conﬁgured 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 ﬁrewall, router, or load balancer. • To ignore the error that is generated when the client attempts to use the SETSTAT command on a ﬁle that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the AWS Transfer Family server ignore the SETSTAT command and upload ﬁles without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call. • To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter. • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported. Type: ProtocolDetails object Request Parameters 307 AWS Transfer Family Required: No Protocols API Reference Speciﬁes the ﬁle transfer protocol or protocols over which your ﬁle 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 ﬁle transfer • AS2 (Applicability Statement 2): used for transporting structured business-to-business data Note • If you select FTPS, you must choose a certiﬁcate stored in AWS Certiﬁcate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. • If Protocol includes FTP, then AddressAllocationIds cannot be associated. • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: SFTP \| FTP \| FTPS \| AS2 Required: No S3StorageOptions Speciﬁes whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. Request Parameters 308 AWS Transfer Family API Reference 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 ﬁle target. Type: S3StorageOptions object Required: No SecurityPolicyName Speciﬁes the name of the security policy for the server. Type: String Length Constraints: Minimum length
transferfamily-api-063	transferfamily-api.pdf	63	number of 4 items. Valid Values: SFTP \| FTP \| FTPS \| AS2 Required: No S3StorageOptions Speciﬁes whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. Request Parameters 308 AWS Transfer Family API Reference 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 ﬁle target. Type: S3StorageOptions object Required: No SecurityPolicyName Speciﬁes the name of the security policy for the server. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: Transfer[A-Za-z0-9]SecurityPolicy-[A-Za-z0-9-]+ Required: No ServerId A system-assigned unique identiﬁer for a server instance that the Transfer Family user is assigned to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes StructuredLogDestinations Speciﬁes 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:* Request Parameters 309 AWS Transfer Family API Reference If you have previously speciﬁed a log group for a server, you can clear it, and in eﬀect turn oﬀ structured logging, by providing an empty value for this parameter in an update-server call. For example: update-server --server-id s-1234567890abcdef0 --structured-log- destinations Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1 item. Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: No WorkﬂowDetails Speciﬁes the workﬂow ID for the workﬂow to assign and the execution role that's used for executing the workﬂow. In addition to a workﬂow to execute when a ﬁle is uploaded completely, WorkflowDetails can also contain a workﬂow ID (and execution role) for a workﬂow to execute on partial upload. A partial upload occurs when the server session disconnects while the ﬁle is still being uploaded. To remove an associated workﬂow 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":[]}' Type: WorkﬂowDetails object Required: No Response Syntax { "ServerId": "string" } Response Syntax 310 AWS Transfer Family Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServerId A system-assigned unique identiﬁer for a server that the Transfer Family user is assigned to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 ConﬂictException This exception is thrown when the UpdateServer is called for a ﬁle transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. Response Elements 311 AWS Transfer Family HTTP Status Code: 400 ResourceExistsException API Reference The requested resource does not exist, or exists in a region other than the one speciﬁed for the command. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ServiceUnavailableException The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example updates the role of a server. Sample Request { "EndpointDetails": { "VpcEndpointId": "vpce-01234f056f3g13", "LoggingRole": "CloudWatchS3Events", "ServerId": "s-01234567890abcdef" } } Examples 312 AWS Transfer Family Example API Reference The following example removes any associated workﬂows from the server. Sample Request aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}' Example This is a sample response for this API call. Sample Response { "ServerId": "s-01234567890abcdef" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 313 AWS Transfer Family UpdateUser API Reference Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. The response returns the ServerId and the UserName for the
transferfamily-api-064	transferfamily-api.pdf	64	Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 313 AWS Transfer Family UpdateUser API Reference Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. The response returns the ServerId and the UserName for the updated user. In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to conﬁgure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory. For example, if the user's home directory is /test/admin-user, the following command updates the user so that their conﬁguration in the console shows the Restricted ﬂag as selected. aws transfer update-user --server-id <server-id> --user-name admin-user -- home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]" Request Syntax { "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "ServerId": "string", "UserName": "string" } UpdateUser 314 AWS Transfer Family Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. HomeDirectory The landing directory (folder) for a user when they log in to the server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. Note The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.*) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. 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. Request Parameters 315 AWS Transfer Family API Reference The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] Type: Array of HomeDirectoryMapEntry objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No HomeDirectoryType The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their ﬁle 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. Type: String Valid Values: PATH \| LOGICAL Required: No Policy A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Note This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. Request Parameters 316 AWS Transfer Family API Reference For session policies, AWS 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 AWS Security Token Service API Reference. Type: String Length
transferfamily-api-065	transferfamily-api.pdf	65	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. Request Parameters 316 AWS Transfer Family API Reference For session policies, AWS 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 AWS Security Token Service API Reference. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No PosixProﬁle Speciﬁes 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 ﬁles and directories in your ﬁle system determines the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS ﬁle system. The policies attached to this role determine the level of access that you want to provide your users when transferring ﬁles into and out of your Amazon S3 bucket or Amazon EFS ﬁle system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.*role/\S+ Required: No Request Parameters 317 AWS Transfer Family ServerId API Reference A system-assigned unique identiﬁer for a Transfer Family server instance that the user is assigned to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: Yes UserName A unique string that identiﬁes a user and is associated with a server as speciﬁed 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Required: Yes Response Syntax { "ServerId": "string", "UserName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax 318 AWS Transfer Family ServerId API Reference A system-assigned unique identiﬁer for a Transfer Family server instance that the account is assigned to. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) UserName The unique identiﬁer for a user that is assigned to a server instance that was speciﬁed in the request. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: [\w][\w@.-]{2,99} Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 Errors 319 AWS Transfer Family ServiceUnavailableException API Reference The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 Examples Example The following example updates a Transfer Family user. Sample Request { "HomeDirectory": "/bucket2/documentation", "HomeDirectoryMappings": [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ], "HomeDirectoryType:" "PATH", "Role": "AssumeRole", "ServerId": "s-01234567890abcdef", "UserName": "my_user" } Example This is a sample response for this API call. Sample Response { "ServerId": "s-01234567890abcdef", Examples 320 AWS Transfer Family "UserName": "my_user" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 321 AWS Transfer Family UpdateWebApp API Reference Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units. Request Syntax { "AccessEndpoint": "string", "IdentityProviderDetails": { ... }, "WebAppId": "string", "WebAppUnits": { ... } } Request Parameters For information about the parameters that are
transferfamily-api-066	transferfamily-api.pdf	66	• AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 321 AWS Transfer Family UpdateWebApp API Reference Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units. Request Syntax { "AccessEndpoint": "string", "IdentityProviderDetails": { ... }, "WebAppId": "string", "WebAppUnits": { ... } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessEndpoint The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No IdentityProviderDetails Provide updated identity provider values in a WebAppIdentityProviderDetails object. Type: UpdateWebAppIdentityProviderDetails object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No WebAppId Provide the identiﬁer of the web app that you are updating. UpdateWebApp 322 AWS Transfer Family Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes WebAppUnits API Reference A union that contains the value for number of concurrent connections or the user sessions on your web app. Type: WebAppUnits object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No Response Syntax { "WebAppId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WebAppId Returns the unique identiﬁer for the web app being updated. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Response Syntax 323 AWS Transfer Family Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 ConﬂictException This exception is thrown when the UpdateServer is called for a ﬁle transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors 324 API Reference AWS Transfer Family • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 325 AWS Transfer Family API Reference UpdateWebAppCustomization Assigns new customization properties to a web app. You can modify the icon ﬁle, logo ﬁle, and title. Request Syntax { "FaviconFile": blob, "LogoFile": blob, "Title": "string", "WebAppId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FaviconFile Specify an icon ﬁle data string (in base64 encoding). Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 20960. Required: No LogoFile Specify logo ﬁle data string (in base64 encoding). Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 51200. Required: No Title Provide an updated title. UpdateWebAppCustomization 326 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 100. Required: No WebAppId Provide the identiﬁer of the web app that you are updating. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Syntax { "WebAppId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WebAppId Returns the unique identiﬁer for the web app being updated. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax 327 AWS Transfer Family AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code:
transferfamily-api-067	transferfamily-api.pdf	67	Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Required: Yes Response Syntax { "WebAppId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WebAppId Returns the unique identiﬁer for the web app being updated. Type: String Length Constraints: Fixed length of 24. Pattern: webapp-[0-9a-f]{17} Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax 327 AWS Transfer Family AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 ConﬂictException API Reference This exception is thrown when the UpdateServer is called for a ﬁle transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. HTTP Status Code: 400 InternalServiceError This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ResourceNotFoundException This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also 328 API Reference AWS Transfer Family • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also 329 AWS Transfer Family Data Types API Reference The AWS Transfer Family API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • As2ConnectorConﬁg • ConnectorFileTransferResult • CopyStepDetails • CustomDirectoriesType • CustomStepDetails • DecryptStepDetails • DeleteStepDetails • DescribedAccess • DescribedAgreement • DescribedCertiﬁcate • DescribedConnector • DescribedExecution • DescribedHostKey • DescribedIdentityCenterConﬁg • DescribedProﬁle • DescribedSecurityPolicy • DescribedServer • DescribedUser • DescribedWebApp • DescribedWebAppCustomization 330 AWS Transfer Family API Reference • DescribedWebAppIdentityProviderDetails • DescribedWorkﬂow • EfsFileLocation • EndpointDetails • ExecutionError • ExecutionResults • ExecutionStepResult • FileLocation • HomeDirectoryMapEntry • IdentityCenterConﬁg • IdentityProviderDetails • InputFileLocation • ListedAccess • ListedAgreement • ListedCertiﬁcate • ListedConnector • ListedExecution • ListedHostKey • ListedProﬁle • ListedServer • ListedUser • ListedWebApp • ListedWorkﬂow • LoggingConﬁguration • PosixProﬁle • ProtocolDetails • S3FileLocation • S3InputFileLocation • S3StorageOptions • S3Tag 331 AWS Transfer Family • ServiceMetadata • SftpConnectorConﬁg • SftpConnectorConnectionDetails • SshPublicKey • Tag • TagStepDetails • UpdateWebAppIdentityCenterConﬁg • UpdateWebAppIdentityProviderDetails • UserDetails • WebAppIdentityProviderDetails • WebAppUnits • WorkﬂowDetail • WorkﬂowDetails • WorkﬂowStep API Reference 332 AWS Transfer Family API Reference As2ConnectorConﬁg Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the AWS Transfer Family customer with the trading partner. Contents BasicAuthSecretId Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in AWS Secrets Manager. The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector. If the connector should use Basic authentication, the secret needs to be in the following format: { "Username": "user-name", "Password": "user-password" } Replace user-name and user-password with the credentials for the actual user that is being authenticated. Note the following: • You are storing these credentials in Secrets Manager, not passing them directly into this API. • If you are using the API, SDKs, or CloudFormation to conﬁgure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the AWS management console, you can have the system create the secret for you. If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication: update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""' Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No As2ConnectorConﬁg 333 API Reference AWS Transfer Family Compression Speciﬁes whether the AS2 ﬁle is compressed. Type: String Valid Values: ZLIB \| DISABLED Required: No EncryptionAlgorithm The algorithm that is used to encrypt the ﬁle. 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
transferfamily-api-068	transferfamily-api.pdf	68	using the CLI, you can run the following command to remove Basic authentication: update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""' Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No As2ConnectorConﬁg 333 API Reference AWS Transfer Family Compression Speciﬁes whether the AS2 ﬁle is compressed. Type: String Valid Values: ZLIB \| DISABLED Required: No EncryptionAlgorithm The algorithm that is used to encrypt the ﬁle. 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 traﬃc is sent in clear text. Type: String Valid Values: AES128_CBC \| AES192_CBC \| AES256_CBC \| DES_EDE3_CBC \| NONE Required: No LocalProﬁleId A unique identiﬁer for the AS2 local proﬁle. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No MdnResponse Used for outbound requests (from an AWS Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values: Contents 334 AWS Transfer Family API Reference • SYNC: The system expects a synchronous MDN response, conﬁrming that the ﬁle was transferred successfully (or not). • NONE: Speciﬁes that no MDN response is required. Type: String Valid Values: SYNC \| NONE Required: No MdnSigningAlgorithm The signing algorithm for the MDN response. Note If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used. Type: String Valid Values: SHA256 \| SHA384 \| SHA512 \| SHA1 \| NONE \| DEFAULT Required: No MessageSubject Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\p{Print}\p{Blank}]+ Required: No PartnerProﬁleId A unique identiﬁer for the partner proﬁle for the connector. Type: String Contents 335 AWS Transfer Family API Reference Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No PreserveContentType 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 ﬁle extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly. Type: String Valid Values: ENABLED \| DISABLED Required: No SigningAlgorithm The algorithm that is used to sign the AS2 messages sent with the connector. Type: String Valid Values: SHA256 \| SHA384 \| SHA512 \| SHA1 \| NONE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 336 AWS Transfer Family API Reference ConnectorFileTransferResult A structure that contains the details for ﬁles transferred using an SFTP connector, during a single transfer. Contents FilePath The ﬁlename and path to where the ﬁle was sent to or retrieved from. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (.)+ Required: Yes StatusCode The current status for the transfer. Type: String Valid Values: QUEUED \| IN_PROGRESS \| COMPLETED \| FAILED Required: Yes FailureCode For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND Type: String Required: No FailureMessage For transfers that fail, this parameter describes the reason for the failure. Type: String Required: No ConnectorFileTransferResult 337 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 338 AWS Transfer Family CopyStepDetails Each step type has its own StepDetails structure. Contents DestinationFileLocation API Reference Speciﬁes the location for the ﬁle being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this ﬁeld to parametrize the destination preﬁx by username or uploaded date. • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the name of the Transfer Family user that uploaded the ﬁle. • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the date of the upload. Note The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the ﬁle is uploaded in UTC. Type: InputFileLocation object Required: No Name The name of the step, used as an identiﬁer. Type: String Length Constraints: Minimum length of 0. Maximum length of 30. Pattern: [\w-]* Required: No OverwriteExisting A ﬂag that indicates whether to overwrite an existing ﬁle of the same name. The default is FALSE.
transferfamily-api-069	transferfamily-api.pdf	69	uploaded the ﬁle. • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the date of the upload. Note The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the ﬁle is uploaded in UTC. Type: InputFileLocation object Required: No Name The name of the step, used as an identiﬁer. Type: String Length Constraints: Minimum length of 0. Maximum length of 30. Pattern: [\w-]* Required: No OverwriteExisting A ﬂag that indicates whether to overwrite an existing ﬁle of the same name. The default is FALSE. CopyStepDetails 339 AWS Transfer Family API Reference If the workﬂow is processing a ﬁle that has the same name as an existing ﬁle, the behavior is as follows: • If OverwriteExisting is TRUE, the existing ﬁle is replaced with the ﬁle being processed. • If OverwriteExisting is FALSE, nothing happens, and the workﬂow processing stops. Type: String Valid Values: TRUE \| FALSE Required: No SourceFileLocation Speciﬁes which ﬁle to use as input to the workﬂow step: either the output from the previous step, or the originally uploaded ﬁle for the workﬂow. • To use the previous ﬁle as the input, enter ${previous.file}. In this case, this workﬂow step uses the output ﬁle from the previous workﬂow step as input. This is the default value. • To use the originally uploaded ﬁle location as input for this step, enter ${original.file}. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: \$\{(\w+.)+\w+\} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 340 AWS Transfer Family API Reference CustomDirectoriesType Contains Amazon S3 locations for storing speciﬁc types of AS2 message ﬁles. Contents FailedFilesDirectory Speciﬁes a location to store failed AS2 message ﬁles. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: Yes MdnFilesDirectory Speciﬁes a location to store MDN ﬁles. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: Yes PayloadFilesDirectory Speciﬁes a location to store the payload for AS2 message ﬁles. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: Yes StatusFilesDirectory Speciﬁes a location to store AS2 status messages. CustomDirectoriesType 341 AWS Transfer Family Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: Yes TemporaryFilesDirectory Speciﬁes a location to store temporary AS2 message ﬁles. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 342 API Reference AWS Transfer Family CustomStepDetails Each step type has its own StepDetails structure. Contents Name The name of the step, used as an identiﬁer. Type: String Length Constraints: Minimum length of 0. Maximum length of 30. Pattern: [\w-] Required: No SourceFileLocation Speciﬁes which ﬁle to use as input to the workﬂow step: either the output from the previous step, or the originally uploaded ﬁle for the workﬂow. • To use the previous ﬁle as the input, enter ${previous.file}. In this case, this workﬂow step uses the output ﬁle from the previous workﬂow step as input. This is the default value. • To use the originally uploaded ﬁle location as input for this step, enter ${original.file}. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: \$\{(\w+.)+\w+\} Required: No Target The ARN for the Lambda function that is being called. Type: String Length Constraints: Minimum length of 0. Maximum length of 170. Pattern: arn:[a-z-]+:lambda:.* CustomStepDetails 343 API Reference AWS Transfer Family Required: No TimeoutSeconds Timeout, in seconds, for the step. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1800. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 344 AWS Transfer Family DecryptStepDetails Each step type has its own StepDetails structure. Contents DestinationFileLocation API Reference Speciﬁes the location for the ﬁle being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this ﬁeld to parametrize the destination preﬁx by username or uploaded date. • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the name of the Transfer Family user that uploaded the ﬁle. • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded ﬁles to
transferfamily-api-070	transferfamily-api.pdf	70	AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 344 AWS Transfer Family DecryptStepDetails Each step type has its own StepDetails structure. Contents DestinationFileLocation API Reference Speciﬁes the location for the ﬁle being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this ﬁeld to parametrize the destination preﬁx by username or uploaded date. • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the name of the Transfer Family user that uploaded the ﬁle. • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded ﬁles to an Amazon S3 bucket that is preﬁxed with the date of the upload. Note The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the ﬁle is uploaded in UTC. Type: InputFileLocation object Required: Yes Type The type of encryption used. Currently, this value must be PGP. Type: String Valid Values: PGP Required: Yes Name The name of the step, used as an identiﬁer. Type: String DecryptStepDetails 345 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 30. Pattern: [\w-]* Required: No OverwriteExisting A ﬂag that indicates whether to overwrite an existing ﬁle of the same name. The default is FALSE. If the workﬂow is processing a ﬁle that has the same name as an existing ﬁle, the behavior is as follows: • If OverwriteExisting is TRUE, the existing ﬁle is replaced with the ﬁle being processed. • If OverwriteExisting is FALSE, nothing happens, and the workﬂow processing stops. Type: String Valid Values: TRUE \| FALSE Required: No SourceFileLocation Speciﬁes which ﬁle to use as input to the workﬂow step: either the output from the previous step, or the originally uploaded ﬁle for the workﬂow. • To use the previous ﬁle as the input, enter ${previous.file}. In this case, this workﬂow step uses the output ﬁle from the previous workﬂow step as input. This is the default value. • To use the originally uploaded ﬁle location as input for this step, enter ${original.file}. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: \$\{(\w+.)+\w+\} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also 346 AWS Transfer Family • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also 347 API Reference AWS Transfer Family DeleteStepDetails The name of the step, used to identify the delete step. Contents Name The name of the step, used as an identiﬁer. Type: String Length Constraints: Minimum length of 0. Maximum length of 30. Pattern: [\w-]* Required: No SourceFileLocation Speciﬁes which ﬁle to use as input to the workﬂow step: either the output from the previous step, or the originally uploaded ﬁle for the workﬂow. • To use the previous ﬁle as the input, enter ${previous.file}. In this case, this workﬂow step uses the output ﬁle from the previous workﬂow step as input. This is the default value. • To use the originally uploaded ﬁle location as input for this step, enter ${original.file}. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: \$\{(\w+.)+\w+\} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 DeleteStepDetails 348 AWS Transfer Family • AWS SDK for Ruby V3 API Reference See Also 349 AWS Transfer Family DescribedAccess Describes the properties of the access that was speciﬁed. API Reference Contents ExternalId A unique identiﬁer that is required to identify speciﬁc groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName"} -Properties \| Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ Required: No HomeDirectory 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 The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String DescribedAccess 350 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.*) Required: No HomeDirectoryMappings Logical directory mappings that
transferfamily-api-071	transferfamily-api.pdf	71	uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: S-1-[\d-]+ Required: No HomeDirectory 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 The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. Type: String DescribedAccess 350 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: No HomeDirectoryMappings Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value. Type: Array of HomeDirectoryMapEntry objects Array Members: Minimum number of 1 item. Maximum number of 50000 items. Required: No HomeDirectoryType The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their ﬁle 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. Type: String Contents 351 AWS Transfer Family API Reference Valid Values: PATH \| LOGICAL Required: No Policy A session policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No PosixProﬁle 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in your ﬁle system determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Role The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS ﬁle system. The policies attached to this role determine the level of access that you want to provide your users when transferring ﬁles into and out of your Amazon S3 bucket or Amazon EFS ﬁle system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No Contents 352 AWS Transfer Family See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 353 AWS Transfer Family API Reference DescribedAgreement Describes the properties of an agreement. Contents Arn The unique Amazon Resource Name (ARN) for the agreement. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the
transferfamily-api-072	transferfamily-api.pdf	72	Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors DescribedAgreement 354 AWS Transfer Family API Reference Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No AgreementId A unique identiﬁer for the agreement. This identiﬁer is returned when you create an agreement. Type: String Length Constraints: Fixed length of 19. Pattern: a-([0-9a-f]{17}) Required: No BaseDirectory The landing directory (folder) for ﬁles that are transferred by using the AS2 protocol. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: (\|/.) Required: No CustomDirectories A CustomDirectoriesType structure. This structure speciﬁes custom directories for storing various AS2 message ﬁles. You can specify directories for the following types of ﬁles. • Failed ﬁles • MDN ﬁles • Payload ﬁles • Status ﬁles Contents 355 API Reference AWS Transfer Family • Temporary ﬁles Type: CustomDirectoriesType object Required: No Description The name or short description that's used to identify the agreement. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: [\p{Graph}]+ Required: No EnforceMessageSigning Determines whether or not unsigned messages from your trading partners will be accepted. • ENABLED: Transfer Family rejects unsigned messages from your trading partner. • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner. Type: String Valid Values: ENABLED \| DISABLED Required: No LocalProﬁleId A unique identiﬁer for the AS2 local proﬁle. Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No PartnerProﬁleId A unique identiﬁer for the partner proﬁle used in the agreement. Contents 356 AWS Transfer Family Type: String Length Constraints: Fixed length of 19. Pattern: p-([0-9a-f]{17}) Required: No PreserveFilename API Reference Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload ﬁlename when saving it. • ENABLED: the ﬁlename provided by your trading parter is preserved when the ﬁle is saved. • DISABLED (default value): when Transfer Family saves the ﬁle, the ﬁlename is adjusted, as described in File names and locations. Type: String Valid Values: ENABLED \| DISABLED Required: No ServerId A system-assigned unique identiﬁer for a server instance. This identiﬁer indicates the speciﬁc server that the agreement uses. Type: String Length Constraints: Fixed length of 19. Pattern: s-([0-9a-f]{17}) Required: No Status The current status of the agreement, either ACTIVE or INACTIVE. Type: String Valid Values: ACTIVE \| INACTIVE Required: No Contents 357 AWS Transfer Family Tags API Reference Key-value pairs that can be used to group and search for agreements. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 358 AWS Transfer Family API Reference DescribedCertiﬁcate Describes the properties of a certiﬁcate. Contents Arn The unique Amazon Resource Name (ARN) for the certiﬁcate. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes ActiveDate An optional date that speciﬁes when the certiﬁcate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is speciﬁed by the CA. Type: Timestamp Required: No Certiﬁcate The ﬁle name for the certiﬁcate. Type: String Length Constraints: Minimum length of 1. Maximum
transferfamily-api-073	transferfamily-api.pdf	73	V2 • AWS SDK for Ruby V3 See Also 358 AWS Transfer Family API Reference DescribedCertiﬁcate Describes the properties of a certiﬁcate. Contents Arn The unique Amazon Resource Name (ARN) for the certiﬁcate. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes ActiveDate An optional date that speciﬁes when the certiﬁcate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is speciﬁed by the CA. Type: Timestamp Required: No Certiﬁcate The ﬁle name for the certiﬁcate. Type: String Length Constraints: Minimum length of 1. Maximum length of 16384. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]* Required: No CertiﬁcateChain The list of certiﬁcates that make up the chain for the certiﬁcate. Type: String DescribedCertiﬁcate 359 AWS Transfer Family API Reference Length Constraints: Minimum length of 1. Maximum length of 2097152. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]* Required: No CertiﬁcateId An array of identiﬁers for the imported certiﬁcates. You use this identiﬁer for working with proﬁles and partner proﬁles. Type: String Length Constraints: Fixed length of 22. Pattern: cert-([0-9a-f]{17}) Required: No Description The name or description that's used to identity the certiﬁcate. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: [\p{Graph}]+ Required: No InactiveDate An optional date that speciﬁes when the certiﬁcate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is speciﬁed by the CA. Type: Timestamp Required: No NotAfterDate The ﬁnal date that the certiﬁcate is valid. Type: Timestamp Contents 360 API Reference AWS Transfer Family Required: No NotBeforeDate The earliest date that the certiﬁcate is valid. Type: Timestamp Required: No Serial The serial number for the certiﬁcate. Type: String Length Constraints: Minimum length of 0. Maximum length of 48. Pattern: [\p{XDigit}{2}:?]* Required: No Status A certiﬁcate'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 certiﬁcate 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 speciﬁed on the X509 certiﬁcate to determine when a certiﬁcate is active and when it is inactive. Type: String Valid Values: ACTIVE \| PENDING_ROTATION \| INACTIVE Required: No Tags Key-value pairs that can be used to group and search for certiﬁcates. Type: Array of Tag objects Contents 361 AWS Transfer Family API Reference Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Type If a private key has been speciﬁed for the certiﬁcate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE. Type: String Valid Values: CERTIFICATE \| CERTIFICATE_WITH_PRIVATE_KEY Required: No Usage Speciﬁes how this certiﬁcate is used. It can be used in the following ways: • SIGNING: For signing AS2 messages • ENCRYPTION: For encrypting AS2 messages • TLS: For securing AS2 communications sent over HTTPS Type: String Valid Values: SIGNING \| ENCRYPTION \| TLS Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 362 AWS Transfer Family API Reference DescribedConnector Describes the parameters for the connector, as identiﬁed by the ConnectorId. Contents Arn The unique Amazon Resource Name (ARN) for the connector. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes AccessRole Connectors are used to send ﬁles using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use. For AS2 connectors With AS2, you can send ﬁles by calling StartFileTransfer and specifying the ﬁle paths in the request parameter, SendFilePaths. We use the ﬁle’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 ﬁle, store the MDN when we receive them from the partner, and write a ﬁnal JSON ﬁle containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors DescribedConnector 363 AWS Transfer Family API Reference Make sure that the access role provides read and write
transferfamily-api-074	transferfamily-api.pdf	74	the ﬁle location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the ﬁles that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors DescribedConnector 363 AWS Transfer Family API Reference Make sure that the access role provides read and write access to the parent directory of the ﬁle location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No As2Conﬁg A structure that contains the parameters for an AS2 connector object. Type: As2ConnectorConﬁg object Required: No ConnectorId The unique identiﬁer for the connector. Type: String Length Constraints: Fixed length of 19. Pattern: c-([0-9a-f]{17}) Required: No LoggingRole The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.role/\S+ Required: No Contents 364 AWS Transfer Family SecurityPolicyName API Reference The text name of the security policy for the speciﬁed connector. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ Required: No ServiceManagedEgressIpAddresses The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. Type: Array of strings Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} Required: No SftpConﬁg A structure that contains the parameters for an SFTP connector object. Type: SftpConnectorConﬁg object Required: No Tags Key-value pairs that can be used to group and search for connectors. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No Url The URL of the partner's AS2 or SFTP endpoint. Type: String Contents 365 AWS Transfer Family API Reference Length Constraints: Minimum length of 0. Maximum length of 255. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also 366 API Reference AWS Transfer Family DescribedExecution The details for an execution object. Contents ExecutionId A unique identiﬁer for the execution of a workﬂow. Type: String Length Constraints: Fixed length of 36. Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12} Required: No ExecutionRole The IAM role associated with the execution. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:.*role/\S+ Required: No InitialFileLocation A structure that describes the Amazon S3 or EFS ﬁle location. This is the ﬁle location when the execution begins: if the ﬁle is being copied, this is the initial (as opposed to destination) ﬁle location. Type: FileLocation object Required: No LoggingConﬁguration The IAM logging role associated with the execution. Type: LoggingConﬁguration object DescribedExecution 367 AWS Transfer Family Required: No PosixProﬁle API Reference 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 ﬁle systems. The POSIX permissions that are set on ﬁles and directories in your ﬁle system determine the level of access your users get when transferring ﬁles into and out of your Amazon EFS ﬁle systems. Type: PosixProﬁle object Required: No Results A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure. Type: ExecutionResults object Required: No ServiceMetadata A container object for the session details that are associated with a workﬂow. Type: ServiceMetadata object Required: No Status The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. Type: String Valid Values: IN_PROGRESS \| COMPLETED \| EXCEPTION \| HANDLING_EXCEPTION Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also 368 AWS Transfer Family • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also 369 API Reference AWS Transfer Family DescribedHostKey The details for a server host key. Contents Arn The unique Amazon Resource Name (ARN) for the host key. Type: String Length Constraints: Minimum length of 20. Maximum length of 1600. Pattern: arn:\S+ Required: Yes DateImported The date on which the host key was added to the server. Type: Timestamp

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.