GetImport - Amazon Lex V1

If you are using Amazon Lex V2, refer to the Amazon Lex V2 guide instead.

 

If you are using Amazon Lex V1, we recommend upgrading your bots to Amazon Lex V2. We are no longer adding new features to V1 and strongly recommend using V2 for all new bots.

GetImport

Gets information about an import job started with the StartImport operation.

Request Syntax

GET /imports/importId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

importId

The identifier of the import job information to return.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdDate": number, "failureReason": [ "string" ], "importId": "string", "importStatus": "string", "mergeStrategy": "string", "name": "string", "resourceType": "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.

createdDate

A timestamp for the date and time that the import job was created.

Type: Timestamp

failureReason

A string that describes why an import job failed to complete.

Type: Array of strings

importId

The identifier for the specific import job.

Type: String

importStatus

The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | FAILED

mergeStrategy

The action taken when there was a conflict between an existing resource and a resource in the import file.

Type: String

Valid Values: OVERWRITE_LATEST | FAIL_ON_CONFLICT

name

The name given to the import job.

Type: String

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

Pattern: [a-zA-Z_]+

resourceType

The type of resource imported.

Type: String

Valid Values: BOT | INTENT | SLOT_TYPE

Errors

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

HTTP Status Code: 400

InternalFailureException

An internal Amazon Lex error occurred. Try your request again.

HTTP Status Code: 500

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

NotFoundException

The resource specified in the request was not found. Check the resource and try again.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: