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

StartImport

Starts a job to import a resource to Amazon Lex.

Request Syntax


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

{
   "mergeStrategy": "string",
   "payload": blob,
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

mergeStrategy

Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Type: String

Valid Values: OVERWRITE_LATEST | FAIL_ON_CONFLICT

Required: Yes

payload

A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.

Type: Base64-encoded binary data object

Required: Yes

resourceType

Specifies the type of resource to export. Each resource also exports any resources that it depends on.

A bot exports dependent intents.
An intent exports dependent slot types.

Type: String

Valid Values: BOT | INTENT | SLOT_TYPE

Required: Yes

tags

A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "createdDate": number,
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "name": "string",
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}