Gets information about all of the versions of a bot.
The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetBotVersions operation always returns at least one version, the $LATEST version.
This operation requires permissions for the lex:GetBotVersions action.
Parameters:
-
name
(BotName)
–
The name of the bot for which versions should be returned.
-
next_token
(Optional[NextToken], default:
None
)
–
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of bot versions to return in the response. The default is 10.
Raises:
-
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.
-
InternalFailureException
–
An internal Amazon Lex error occurred. Try your request again.
-
LimitExceededException
–
The request exceeded a limit. Try your request again.
-
NotFoundException
–
The resource specified in the request was not found. Check the resource and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_lex_model_building_service/_services/async_lex_model_building_service.py
| async def get_bot_versions(
self,
name: "capo_lex_model_building_service.types.bot_name.BotName",
*,
config_overrides: Optional[AsyncLexModelBuildingServiceClientConfig] = None,
next_token: Optional[
"capo_lex_model_building_service.types.next_token.NextToken"
] = None,
max_results: Optional[
"capo_lex_model_building_service.types.max_results.MaxResults"
] = None,
) -> "capo_lex_model_building_service.types.get_bot_versions_response.GetBotVersionsResponse":
"""<p>Gets information about all of the versions of a bot.</p> <p>The <code>GetBotVersions</code> operation returns a <code>BotMetadata</code> object for each version of a bot. For example, if a bot has three numbered versions, the <code>GetBotVersions</code> operation returns four <code>BotMetadata</code> objects in the response, one for each numbered version and one for the <code>$LATEST</code> version. </p> <p>The <code>GetBotVersions</code> operation always returns at least one version, the <code>$LATEST</code> version.</p> <p>This operation requires permissions for the <code>lex:GetBotVersions</code> action.</p>
Args:
name: <p>The name of the bot for which versions should be returned.</p>
next_token: <p>A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>
max_results: <p>The maximum number of bot versions to return in the response. The default is 10.</p>
Raises:
capo_lex_model_building_service.errors.bad_request_exception.BadRequestException: <p>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.</p>
capo_lex_model_building_service.errors.internal_failure_exception.InternalFailureException: <p>An internal Amazon Lex error occurred. Try your request again.</p>
capo_lex_model_building_service.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded a limit. Try your request again.</p>
capo_lex_model_building_service.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. Check the resource and try again.</p>
capo_lex_model_building_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_lex_model_building_service.types.get_bot_versions_request.GetBotVersionsRequest]",
) -> AsyncOperationResponse[
"capo_lex_model_building_service.types.get_bot_versions_response.GetBotVersionsResponse"
]:
import capo_lex_model_building_service._operations.aws_deep_sense_model_building_service.get_bot_versions
(
output,
http_response,
) = await capo_lex_model_building_service._operations.aws_deep_sense_model_building_service.get_bot_versions.async_get_bot_versions(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetBotVersions")
)
input_: capo_lex_model_building_service.types.get_bot_versions_request.GetBotVersionsRequest = {
"name": name
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|