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

DescribeImport

Gets information about a specific import.

Request Syntax


GET /imports/importId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

importId

The unique identifier of the import to describe.

Length Constraints: Fixed length of 10.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationDateTime": number,
   "failureReasons": [ "string" ],
   "importedResourceId": "string",
   "importedResourceName": "string",
   "importId": "string",
   "importStatus": "string",
   "lastUpdatedDateTime": number,
   "mergeStrategy": "string",
   "resourceSpecification": { 
      "botImportSpecification": { 
         "botName": "string",
         "botTags": { 
            "string" : "string" 
         },
         "dataPrivacy": { 
            "childDirected": boolean
         },
         "idleSessionTTLInSeconds": number,
         "roleArn": "string",
         "testBotAliasTags": { 
            "string" : "string" 
         }
      },
      "botLocaleImportSpecification": { 
         "botId": "string",
         "botVersion": "string",
         "localeId": "string",
         "nluIntentConfidenceThreshold": number,
         "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" 
         }
      }
   }
}

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.

creationDateTime

The date and time that the import was created.

Type: Timestamp

failureReasons

If the importStatus field is Failed, this provides one or more reasons for the failure.

Type: Array of strings

importedResourceId

The unique identifier that Amazon Lex assigned to the resource created by the import.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 10.

Pattern: ^([0-9a-zA-Z_])+$

importedResourceName

The name of the imported resource.

Type: String

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

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

importId

The unique identifier of the described import.

Type: String

Length Constraints: Fixed length of 10.

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

importStatus

The status of the import process. When the status is Completed the resource is imported and ready for use.

Type: String

Valid Values: InProgress | Completed | Failed | Deleting

lastUpdatedDateTime

The date and time that the import was last updated.

Type: Timestamp

mergeStrategy

The strategy used when there was 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

resourceSpecification

The specifications of the imported bot, bot locale, or custom vocabulary.

Type: ImportResourceSpecification object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400