NAME
Paws::LexModelsV2::CreateSlot - Arguments for method CreateSlot on Paws::LexModelsV2
DESCRIPTION
This class represents the parameters used for calling the method CreateSlot on the Amazon Lex Model Building V2 service. Use the attributes of this class as arguments to method CreateSlot.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSlot.
SYNOPSIS
my $models-v2-lex = Paws->service('LexModelsV2');
my $CreateSlotResponse = $models - v2 -lex->CreateSlot(
BotId => 'MyId',
BotVersion => 'MyDraftBotVersion',
IntentId => 'MyId',
LocaleId => 'MyLocaleId',
SlotName => 'MyName',
SlotTypeId => 'MyBuiltInOrCustomSlotTypeId',
ValueElicitationSetting => {
SlotConstraint => 'Required', # values: Required, Optional
DefaultValueSpecification => {
DefaultValueList => [
{
DefaultValue => 'MySlotDefaultValueString', # min: 1, max: 202
},
...
], # max: 10
}, # OPTIONAL
PromptSpecification => {
MaxRetries => 1, # max: 5
MessageGroups => [
{
Message => {
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
Variations => [
{
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
...
], # max: 2; OPTIONAL
},
...
], # min: 1, max: 5
AllowInterrupt => 1, # OPTIONAL
}, # OPTIONAL
SampleUtterances => [
{
Utterance => 'MyUtterance',
},
...
], # OPTIONAL
WaitAndContinueSpecification => {
ContinueResponse => {
MessageGroups => [
{
Message => {
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
Variations => [
{
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl =>
'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
...
], # max: 2; OPTIONAL
},
...
], # min: 1, max: 5
AllowInterrupt => 1, # OPTIONAL
},
WaitingResponse => {
MessageGroups => [
{
Message => {
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
Variations => [
{
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl =>
'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
...
], # max: 2; OPTIONAL
},
...
], # min: 1, max: 5
AllowInterrupt => 1, # OPTIONAL
},
StillWaitingResponse => {
FrequencyInSeconds => 1, # min: 1, max: 300
MessageGroups => [
{
Message => {
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
Variations => [
{
CustomPayload => {
Value => 'MyCustomPayloadValue', # min: 1, max: 1000
}, # OPTIONAL
ImageResponseCard => {
Title => 'MyAttachmentTitle', # min: 1, max: 250
Buttons => [
{
Text => 'MyButtonText', # min: 1, max: 50
Value => 'MyButtonValue', # min: 1, max: 50
},
...
], # max: 5; OPTIONAL
ImageUrl =>
'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
}, # OPTIONAL
PlainTextMessage => {
Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
}, # OPTIONAL
SsmlMessage => {
Value => 'MySSMLMessageValue', # min: 1, max: 1000
}, # OPTIONAL
},
...
], # max: 2; OPTIONAL
},
...
], # min: 1, max: 5
TimeoutInSeconds => 1, # min: 1, max: 900
AllowInterrupt => 1, # OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
},
Description => 'MyDescription', # OPTIONAL
MultipleValuesSetting => {
AllowMultipleValues => 1, # OPTIONAL
}, # OPTIONAL
ObfuscationSetting => {
ObfuscationSettingType => 'None', # values: None, DefaultObfuscation
}, # OPTIONAL
);
# Results:
my $BotId = $CreateSlotResponse->BotId;
my $BotVersion = $CreateSlotResponse->BotVersion;
my $CreationDateTime = $CreateSlotResponse->CreationDateTime;
my $Description = $CreateSlotResponse->Description;
my $IntentId = $CreateSlotResponse->IntentId;
my $LocaleId = $CreateSlotResponse->LocaleId;
my $MultipleValuesSetting = $CreateSlotResponse->MultipleValuesSetting;
my $ObfuscationSetting = $CreateSlotResponse->ObfuscationSetting;
my $SlotId = $CreateSlotResponse->SlotId;
my $SlotName = $CreateSlotResponse->SlotName;
my $SlotTypeId = $CreateSlotResponse->SlotTypeId;
my $ValueElicitationSetting = $CreateSlotResponse->ValueElicitationSetting;
# Returns a L<Paws::LexModelsV2::CreateSlotResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/CreateSlot
ATTRIBUTES
REQUIRED BotId => Str
The identifier of the bot associated with the slot.
REQUIRED BotVersion => Str
The version of the bot associated with the slot.
Description => Str
A description of the slot. Use this to help identify the slot in lists.
REQUIRED IntentId => Str
The identifier of the intent that contains the slot.
REQUIRED LocaleId => Str
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
MultipleValuesSetting => Paws::LexModelsV2::MultipleValuesSetting
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the multipleValuesSetting is not set, the default value is false.
ObfuscationSetting => Paws::LexModelsV2::ObfuscationSetting
Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
REQUIRED SlotName => Str
The name of the slot. Slot names must be unique within the bot that contains the slot.
REQUIRED SlotTypeId => Str
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
REQUIRED ValueElicitationSetting => Paws::LexModelsV2::SlotValueElicitationSetting
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateSlot in Paws::LexModelsV2
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues