get_builtin_intents ¶

def get_builtin_intents(
    self,
    *,
    config_overrides: Optional[LexModelBuildingServiceClientConfig] = None,
    locale: Optional["capo_lex_model_building_service.types.locale.Locale"] = None,
    signature_contains: Optional[
        "capo_lex_model_building_service.types.string.String"
    ] = 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_builtin_intents_response.GetBuiltinIntentsResponse":
    """<p>Gets a list of built-in intents that meet the specified criteria.</p> <p>This operation requires permission for the <code>lex:GetBuiltinIntents</code> action.</p>

    Args:
        locale: <p>A list of locales that the intent supports.</p>
        signature_contains: <p>Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see <a href="https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>
        next_token: <p>A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.</p>
        max_results: <p>The maximum number of intents 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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_model_building_service.types.get_builtin_intents_request.GetBuiltinIntentsRequest]",
    ) -> OperationResponse[
        "capo_lex_model_building_service.types.get_builtin_intents_response.GetBuiltinIntentsResponse"
    ]:
        import capo_lex_model_building_service._operations.aws_deep_sense_model_building_service.get_builtin_intents

        output, http_response = (
            capo_lex_model_building_service._operations.aws_deep_sense_model_building_service.get_builtin_intents.get_builtin_intents(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBuiltinIntents")
    )
    input_: capo_lex_model_building_service.types.get_builtin_intents_request.GetBuiltinIntentsRequest = {}
    if locale is not None:
        input_["locale"] = locale
    if signature_contains is not None:
        input_["signature_contains"] = signature_contains
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output