Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartImport

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Request Syntax


PUT /imports/ HTTP/1.1
Content-type: application/json

{
   "filePassword": "string",
   "importId": "string",
   "mergeStrategy": "string",
   "resourceSpecification": { 
      "botImportSpecification": { 
         "botName": "string",
         "botTags": { 
            "string" : "string" 
         },
         "dataPrivacy": { 
            "childDirected": boolean
         },
         "errorLogSettings": { 
            "enabled": boolean
         },
         "idleSessionTTLInSeconds": number,
         "roleArn": "string",
         "testBotAliasTags": { 
            "string" : "string" 
         }
      },
      "botLocaleImportSpecification": { 
         "audioFillerSettings": { 
            "audioType": "string",
            "enabled": boolean,
            "minimumPlayDurationInMilliseconds": number,
            "responseDeliveryDelayInMilliseconds": number,
            "startDelayInMilliseconds": number
         },
         "botId": "string",
         "botVersion": "string",
         "localeId": "string",
         "nluIntentConfidenceThreshold": number,
         "speechDetectionSensitivity": "string",
         "speechRecognitionSettings": { 
            "speechModelConfig": { 
               "deepgramConfig": { 
                  "apiTokenSecretArn": "string",
                  "modelId": "string"
               }
            },
            "speechModelPreference": "string"
         },
         "unifiedSpeechSettings": { 
            "speechFoundationModel": { 
               "modelArn": "string",
               "voiceId": "string"
            }
         },
         "voiceSettings": { 
            "engine": "string",
            "voiceId": "string"
         }
      },
      "customVocabularyImportSpecification": { 
         "botId": "string",
         "botVersion": "string",
         "localeId": "string"
      },
      "testSetImportResourceSpecification": { 
         "description": "string",
         "importInputLocation": { 
            "s3BucketName": "string",
            "s3Path": "string"
         },
         "modality": "string",
         "roleArn": "string",
         "storageLocation": { 
            "kmsKeyArn": "string",
            "s3BucketName": "string",
            "s3Path": "string"
         },
         "testSetName": "string",
         "testSetTags": { 
            "string" : "string" 
         }
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filePassword

The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

importId

The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

mergeStrategy

The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

Type: String

Valid Values: Overwrite | FailOnConflict | Append

Required: Yes

resourceSpecification

Parameters for creating the bot, bot locale or custom vocabulary.

Type: ImportResourceSpecification object

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "creationDateTime": number,
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "resourceSpecification": { 
      "botImportSpecification": { 
         "botName": "string",
         "botTags": { 
            "string" : "string" 
         },
         "dataPrivacy": { 
            "childDirected": boolean
         },
         "errorLogSettings": { 
            "enabled": boolean
         },
         "idleSessionTTLInSeconds": number,
         "roleArn": "string",
         "testBotAliasTags": { 
            "string" : "string" 
         }
      },
      "botLocaleImportSpecification": { 
         "audioFillerSettings": { 
            "audioType": "string",
            "enabled": boolean,
            "minimumPlayDurationInMilliseconds": number,
            "responseDeliveryDelayInMilliseconds": number,
            "startDelayInMilliseconds": number
         },
         "botId": "string",
         "botVersion": "string",
         "localeId": "string",
         "nluIntentConfidenceThreshold": number,
         "speechDetectionSensitivity": "string",
         "speechRecognitionSettings": { 
            "speechModelConfig": { 
               "deepgramConfig": { 
                  "apiTokenSecretArn": "string",
                  "modelId": "string"
               }
            },
            "speechModelPreference": "string"
         },
         "unifiedSpeechSettings": { 
            "speechFoundationModel": { 
               "modelArn": "string",
               "voiceId": "string"
            }
         },
         "voiceSettings": { 
            "engine": "string",
            "voiceId": "string"
         }
      },
      "customVocabularyImportSpecification": { 
         "botId": "string",
         "botVersion": "string",
         "localeId": "string"
      },
      "testSetImportResourceSpecification": { 
         "description": "string",
         "importInputLocation": { 
            "s3BucketName": "string",
            "s3Path": "string"
         },
         "