describe_slot ¶

describe_slot(
    slot_id: Id,
    bot_id: Id,
    bot_version: BotVersion,
    locale_id: LocaleId,
    intent_id: Id,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> DescribeSlotResponse

Gets metadata information about a slot.

Parameters:

slot_id (Id) –

The unique identifier for the slot.
bot_id (Id) –

The identifier of the bot associated with the slot.
bot_version (BotVersion) –

The version of the bot associated with the slot.
locale_id (LocaleId) –

The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
intent_id (Id) –

The identifier of the intent that contains the slot.

Raises:

InternalServerException –

The service encountered an unexpected condition. Try your request again.
ResourceNotFoundException –

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
ServiceQuotaExceededException –

You have reached a quota for your bot.
ThrottlingException –

Your request rate is too high. Reduce the frequency of requests.
ValidationException –

One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py

def describe_slot(
    self,
    slot_id: "capo_lex_models_v2.types.id.Id",
    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",
    intent_id: "capo_lex_models_v2.types.id.Id",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> "capo_lex_models_v2.types.describe_slot_response.DescribeSlotResponse":
    """<p>Gets metadata information about a slot.</p>

    Args:
        slot_id: <p>The unique identifier for the slot.</p>
        bot_id: <p>The identifier of the bot associated with the slot.</p>
        bot_version: <p>The version of the bot associated with the slot.</p>
        locale_id: <p>The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
        intent_id: <p>The identifier of the intent that contains the slot.</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_slot_request.DescribeSlotRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.describe_slot_response.DescribeSlotResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.describe_slot

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.describe_slot.describe_slot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSlot")
    )
    input_: capo_lex_models_v2.types.describe_slot_request.DescribeSlotRequest = {
        "slot_id": slot_id,
        "bot_id": bot_id,
        "bot_version": bot_version,
        "locale_id": locale_id,
        "intent_id": intent_id,
    }

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