Provides metadata information about a custom vocabulary.
Parameters:
-
bot_id
(Id)
–
The unique identifier of the bot that contains the custom vocabulary.
-
bot_version
(BotVersion)
–
The bot version of the bot to return metadata for.
-
locale_id
(LocaleId)
–
The locale to return the custom vocabulary information for. The locale must be en_GB.
Raises:
Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py
| def describe_custom_vocabulary_metadata(
self,
bot_id: "capo_lex_models_v2.types.id.Id",
bot_version: "capo_lex_models_v2.types.bot_version.BotVersion",
locale_id: "capo_lex_models_v2.types.locale_id.LocaleId",
*,
config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> "capo_lex_models_v2.types.describe_custom_vocabulary_metadata_response.DescribeCustomVocabularyMetadataResponse":
"""<p>Provides metadata information about a custom vocabulary.</p>
Args:
bot_id: <p>The unique identifier of the bot that contains the custom vocabulary.</p>
bot_version: <p>The bot version of the bot to return metadata for.</p>
locale_id: <p>The locale to return the custom vocabulary information for. The locale must be <code>en_GB</code>.</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.resource_not_found_exception.ResourceNotFoundException: <p>You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try 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.describe_custom_vocabulary_metadata_request.DescribeCustomVocabularyMetadataRequest]",
) -> OperationResponse[
"capo_lex_models_v2.types.describe_custom_vocabulary_metadata_response.DescribeCustomVocabularyMetadataResponse"
]:
import capo_lex_models_v2._operations.lex_model_building_service_v2.describe_custom_vocabulary_metadata
output, http_response = (
capo_lex_models_v2._operations.lex_model_building_service_v2.describe_custom_vocabulary_metadata.describe_custom_vocabulary_metadata(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeCustomVocabularyMetadata")
)
input_: capo_lex_models_v2.types.describe_custom_vocabulary_metadata_request.DescribeCustomVocabularyMetadataRequest = {
"bot_id": bot_id,
"bot_version": bot_version,
"locale_id": locale_id,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|