aws_sdk_lexmodelsv2/client/
describe_slot.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeSlot`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`slot_id(impl Into<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::slot_id) / [`set_slot_id(Option<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::set_slot_id):<br>required: **true**<br><p>The unique identifier for the slot.</p><br>
7    ///   - [`bot_id(impl Into<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier of the bot associated with the slot.</p><br>
8    ///   - [`bot_version(impl Into<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::bot_version) / [`set_bot_version(Option<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::set_bot_version):<br>required: **true**<br><p>The version of the bot associated with the slot.</p><br>
9    ///   - [`locale_id(impl Into<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::locale_id) / [`set_locale_id(Option<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::set_locale_id):<br>required: **true**<br><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><br>
10    ///   - [`intent_id(impl Into<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::intent_id) / [`set_intent_id(Option<String>)`](crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::set_intent_id):<br>required: **true**<br><p>The identifier of the intent that contains the slot.</p><br>
11    /// - On success, responds with [`DescribeSlotOutput`](crate::operation::describe_slot::DescribeSlotOutput) with field(s):
12    ///   - [`slot_id(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::slot_id): <p>The unique identifier generated for the slot.</p>
13    ///   - [`slot_name(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::slot_name): <p>The name specified for the slot.</p>
14    ///   - [`description(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::description): <p>The description specified for the slot.</p>
15    ///   - [`slot_type_id(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::slot_type_id): <p>The identifier of the slot type that determines the values entered into the slot.</p>
16    ///   - [`value_elicitation_setting(Option<SlotValueElicitationSetting>)`](crate::operation::describe_slot::DescribeSlotOutput::value_elicitation_setting): <p>Prompts that Amazon Lex uses to elicit a value for the slot.</p>
17    ///   - [`obfuscation_setting(Option<ObfuscationSetting>)`](crate::operation::describe_slot::DescribeSlotOutput::obfuscation_setting): <p>Whether slot values are shown in Amazon CloudWatch logs. If the value is <code>None</code>, the actual value of the slot is shown in logs.</p>
18    ///   - [`bot_id(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::bot_id): <p>The identifier of the bot associated with the slot.</p>
19    ///   - [`bot_version(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::bot_version): <p>The version of the bot associated with the slot.</p>
20    ///   - [`locale_id(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::locale_id): <p>The language and locale specified for the slot.</p>
21    ///   - [`intent_id(Option<String>)`](crate::operation::describe_slot::DescribeSlotOutput::intent_id): <p>The identifier of the intent associated with the slot.</p>
22    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_slot::DescribeSlotOutput::creation_date_time): <p>A timestamp of the date and time that the slot was created.</p>
23    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_slot::DescribeSlotOutput::last_updated_date_time): <p>A timestamp of the date and time that the slot was last updated.</p>
24    ///   - [`multiple_values_setting(Option<MultipleValuesSetting>)`](crate::operation::describe_slot::DescribeSlotOutput::multiple_values_setting): <p>Indicates whether the slot accepts multiple values in a single utterance.</p> <p>If the <code>multipleValuesSetting</code> is not set, the default value is <code>false</code>.</p>
25    ///   - [`sub_slot_setting(Option<SubSlotSetting>)`](crate::operation::describe_slot::DescribeSlotOutput::sub_slot_setting): <p>Specifications for the constituent sub slots and the expression for the composite slot.</p>
26    /// - On failure, responds with [`SdkError<DescribeSlotError>`](crate::operation::describe_slot::DescribeSlotError)
27    pub fn describe_slot(&self) -> crate::operation::describe_slot::builders::DescribeSlotFluentBuilder {
28        crate::operation::describe_slot::builders::DescribeSlotFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_lexmodelsv2/client/describe_slot.rs

aws_sdk_lexmodelsv2/client/
describe_slot.rs
