Gets a list of aliases for the specified bot.
Parameters:
-
bot_id
(Id)
–
The identifier of the bot to list aliases for.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
-
next_token
(Optional[NextToken], default:
None
)
–
If the response from the ListBotAliases operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Raises:
Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py
| def list_bot_aliases(
self,
bot_id: "capo_lex_models_v2.types.id.Id",
*,
config_overrides: Optional[LexModelsV2ClientConfig] = None,
max_results: Optional["capo_lex_models_v2.types.max_results.MaxResults"] = None,
next_token: Optional["capo_lex_models_v2.types.next_token.NextToken"] = None,
) -> "capo_lex_models_v2.types.list_bot_aliases_response.ListBotAliasesResponse":
"""<p>Gets a list of aliases for the specified bot.</p>
Args:
bot_id: <p>The identifier of the bot to list aliases for.</p>
max_results: <p>The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.</p>
next_token: <p>If the response from the <code>ListBotAliases</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.</p>
Raises:
capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_lex_models_v2.types.list_bot_aliases_request.ListBotAliasesRequest]",
) -> OperationResponse[
"capo_lex_models_v2.types.list_bot_aliases_response.ListBotAliasesResponse"
]:
import capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_aliases
output, http_response = (
capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_aliases.list_bot_aliases(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListBotAliases")
)
input_: capo_lex_models_v2.types.list_bot_aliases_request.ListBotAliasesRequest = {
"bot_id": bot_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|