Updates the password used to protect an export zip archive.
The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.
Request Syntax
PUT /exports/exportId/ HTTP/1.1
Content-type: application/json
{
"filePassword": "string"
}URI Request Parameters
The request uses the following URI parameters.
- exportId
-
The unique identifier Amazon Lex assigned to the export.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- filePassword
-
The new password to use to encrypt the export zip archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"exportId": "string",
"exportStatus": "string",
"fileFormat": "string",
"lastUpdatedDateTime": number,
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- creationDateTime
-
The date and time that the export was created.
Type: Timestamp
- exportId
-
The unique identifier Amazon Lex assigned to the export.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - exportStatus
-
The status of the export. When the status is
Completedthe export archive is available for download.Type: String
Valid Values:
InProgress | Completed | Failed | Deleting - fileFormat
-
The file format used for the files that define the resource. The
TSVformat is required to export a custom vocabulary only; otherwise useLexJsonformat.Type: String
Valid Values:
LexJson | TSV | CSV - lastUpdatedDateTime
-
The date and time that the export was last updated.
Type: Timestamp
- resourceSpecification
-
A description of the type of resource that was exported, either a bot or a bot locale.
Type: ExportResourceSpecification object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
- 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
- ServiceQuotaExceededException
-
You have reached a quota for your bot.
HTTP Status Code: 402
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
