« blib/lib/Paws/LexModelsV2/UpdateResourcePolicyResponse.pm
↑ Summary
blib/lib/Paws/LexModelsV2/UpdateSlotResponse.pm »
| 1 | |||
| 2 | package Paws::LexModelsV2::UpdateSlot; | ||
| 3 | use Moose; | ||
| 4 | has BotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botId', required => 1); | ||
| 5 | has BotVersion => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botVersion', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 7 | has IntentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'intentId', required => 1); | ||
| 8 | has LocaleId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'localeId', required => 1); | ||
| 9 | has MultipleValuesSetting => (is => 'ro', isa => 'Paws::LexModelsV2::MultipleValuesSetting', traits => ['NameInRequest'], request_name => 'multipleValuesSetting'); | ||
| 10 | has ObfuscationSetting => (is => 'ro', isa => 'Paws::LexModelsV2::ObfuscationSetting', traits => ['NameInRequest'], request_name => 'obfuscationSetting'); | ||
| 11 | has SlotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'slotId', required => 1); | ||
| 12 | has SlotName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'slotName', required => 1); | ||
| 13 | has SlotTypeId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'slotTypeId', required => 1); | ||
| 14 | has ValueElicitationSetting => (is => 'ro', isa => 'Paws::LexModelsV2::SlotValueElicitationSetting', traits => ['NameInRequest'], request_name => 'valueElicitationSetting', required => 1); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateSlot'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId}/'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModelsV2::UpdateSlotResponse'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::LexModelsV2::UpdateSlot - Arguments for method UpdateSlot on L<Paws::LexModelsV2> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method UpdateSlot on the | ||
| 33 | L<Amazon Lex Model Building V2|Paws::LexModelsV2> service. Use the attributes of this class | ||
| 34 | as arguments to method UpdateSlot. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSlot. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $models-v2-lex = Paws->service('LexModelsV2'); | ||
| 41 | my $UpdateSlotResponse = $models - v2 -lex->UpdateSlot( | ||
| 42 | BotId => 'MyId', | ||
| 43 | BotVersion => 'MyDraftBotVersion', | ||
| 44 | IntentId => 'MyId', | ||
| 45 | LocaleId => 'MyLocaleId', | ||
| 46 | SlotId => 'MyId', | ||
| 47 | SlotName => 'MyName', | ||
| 48 | SlotTypeId => 'MyBuiltInOrCustomSlotTypeId', | ||
| 49 | ValueElicitationSetting => { | ||
| 50 | SlotConstraint => 'Required', # values: Required, Optional | ||
| 51 | DefaultValueSpecification => { | ||
| 52 | DefaultValueList => [ | ||
| 53 | { | ||
| 54 | DefaultValue => 'MySlotDefaultValueString', # min: 1, max: 202 | ||
| 55 | |||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # max: 10 | ||
| 59 | |||
| 60 | }, # OPTIONAL | ||
| 61 | PromptSpecification => { | ||
| 62 | MaxRetries => 1, # max: 5 | ||
| 63 | MessageGroups => [ | ||
| 64 | { | ||
| 65 | Message => { | ||
| 66 | CustomPayload => { | ||
| 67 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 68 | |||
| 69 | }, # OPTIONAL | ||
| 70 | ImageResponseCard => { | ||
| 71 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 72 | Buttons => [ | ||
| 73 | { | ||
| 74 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 75 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 76 | |||
| 77 | }, | ||
| 78 | ... | ||
| 79 | ], # max: 5; OPTIONAL | ||
| 80 | ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 81 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 82 | }, # OPTIONAL | ||
| 83 | PlainTextMessage => { | ||
| 84 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 85 | |||
| 86 | }, # OPTIONAL | ||
| 87 | SsmlMessage => { | ||
| 88 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 89 | |||
| 90 | }, # OPTIONAL | ||
| 91 | }, | ||
| 92 | Variations => [ | ||
| 93 | { | ||
| 94 | CustomPayload => { | ||
| 95 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 96 | |||
| 97 | }, # OPTIONAL | ||
| 98 | ImageResponseCard => { | ||
| 99 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 100 | Buttons => [ | ||
| 101 | { | ||
| 102 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 103 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 104 | |||
| 105 | }, | ||
| 106 | ... | ||
| 107 | ], # max: 5; OPTIONAL | ||
| 108 | ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 109 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 110 | }, # OPTIONAL | ||
| 111 | PlainTextMessage => { | ||
| 112 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 113 | |||
| 114 | }, # OPTIONAL | ||
| 115 | SsmlMessage => { | ||
| 116 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 117 | |||
| 118 | }, # OPTIONAL | ||
| 119 | }, | ||
| 120 | ... | ||
| 121 | ], # max: 2; OPTIONAL | ||
| 122 | }, | ||
| 123 | ... | ||
| 124 | ], # min: 1, max: 5 | ||
| 125 | AllowInterrupt => 1, # OPTIONAL | ||
| 126 | }, # OPTIONAL | ||
| 127 | SampleUtterances => [ | ||
| 128 | { | ||
| 129 | Utterance => 'MyUtterance', | ||
| 130 | |||
| 131 | }, | ||
| 132 | ... | ||
| 133 | ], # OPTIONAL | ||
| 134 | WaitAndContinueSpecification => { | ||
| 135 | ContinueResponse => { | ||
| 136 | MessageGroups => [ | ||
| 137 | { | ||
| 138 | Message => { | ||
| 139 | CustomPayload => { | ||
| 140 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 141 | |||
| 142 | }, # OPTIONAL | ||
| 143 | ImageResponseCard => { | ||
| 144 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 145 | Buttons => [ | ||
| 146 | { | ||
| 147 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 148 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 149 | |||
| 150 | }, | ||
| 151 | ... | ||
| 152 | ], # max: 5; OPTIONAL | ||
| 153 | ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 154 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 155 | }, # OPTIONAL | ||
| 156 | PlainTextMessage => { | ||
| 157 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 158 | |||
| 159 | }, # OPTIONAL | ||
| 160 | SsmlMessage => { | ||
| 161 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 162 | |||
| 163 | }, # OPTIONAL | ||
| 164 | }, | ||
| 165 | Variations => [ | ||
| 166 | { | ||
| 167 | CustomPayload => { | ||
| 168 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 169 | |||
| 170 | }, # OPTIONAL | ||
| 171 | ImageResponseCard => { | ||
| 172 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 173 | Buttons => [ | ||
| 174 | { | ||
| 175 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 176 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 177 | |||
| 178 | }, | ||
| 179 | ... | ||
| 180 | ], # max: 5; OPTIONAL | ||
| 181 | ImageUrl => | ||
| 182 | 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 183 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 184 | }, # OPTIONAL | ||
| 185 | PlainTextMessage => { | ||
| 186 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 187 | |||
| 188 | }, # OPTIONAL | ||
| 189 | SsmlMessage => { | ||
| 190 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 191 | |||
| 192 | }, # OPTIONAL | ||
| 193 | }, | ||
| 194 | ... | ||
| 195 | ], # max: 2; OPTIONAL | ||
| 196 | }, | ||
| 197 | ... | ||
| 198 | ], # min: 1, max: 5 | ||
| 199 | AllowInterrupt => 1, # OPTIONAL | ||
| 200 | }, | ||
| 201 | WaitingResponse => { | ||
| 202 | MessageGroups => [ | ||
| 203 | { | ||
| 204 | Message => { | ||
| 205 | CustomPayload => { | ||
| 206 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 207 | |||
| 208 | }, # OPTIONAL | ||
| 209 | ImageResponseCard => { | ||
| 210 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 211 | Buttons => [ | ||
| 212 | { | ||
| 213 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 214 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 215 | |||
| 216 | }, | ||
| 217 | ... | ||
| 218 | ], # max: 5; OPTIONAL | ||
| 219 | ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 220 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 221 | }, # OPTIONAL | ||
| 222 | PlainTextMessage => { | ||
| 223 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 224 | |||
| 225 | }, # OPTIONAL | ||
| 226 | SsmlMessage => { | ||
| 227 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 228 | |||
| 229 | }, # OPTIONAL | ||
| 230 | }, | ||
| 231 | Variations => [ | ||
| 232 | { | ||
| 233 | CustomPayload => { | ||
| 234 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 235 | |||
| 236 | }, # OPTIONAL | ||
| 237 | ImageResponseCard => { | ||
| 238 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 239 | Buttons => [ | ||
| 240 | { | ||
| 241 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 242 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 243 | |||
| 244 | }, | ||
| 245 | ... | ||
| 246 | ], # max: 5; OPTIONAL | ||
| 247 | ImageUrl => | ||
| 248 | 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 249 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 250 | }, # OPTIONAL | ||
| 251 | PlainTextMessage => { | ||
| 252 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 253 | |||
| 254 | }, # OPTIONAL | ||
| 255 | SsmlMessage => { | ||
| 256 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 257 | |||
| 258 | }, # OPTIONAL | ||
| 259 | }, | ||
| 260 | ... | ||
| 261 | ], # max: 2; OPTIONAL | ||
| 262 | }, | ||
| 263 | ... | ||
| 264 | ], # min: 1, max: 5 | ||
| 265 | AllowInterrupt => 1, # OPTIONAL | ||
| 266 | }, | ||
| 267 | StillWaitingResponse => { | ||
| 268 | FrequencyInSeconds => 1, # min: 1, max: 300 | ||
| 269 | MessageGroups => [ | ||
| 270 | { | ||
| 271 | Message => { | ||
| 272 | CustomPayload => { | ||
| 273 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 274 | |||
| 275 | }, # OPTIONAL | ||
| 276 | ImageResponseCard => { | ||
| 277 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 278 | Buttons => [ | ||
| 279 | { | ||
| 280 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 281 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 282 | |||
| 283 | }, | ||
| 284 | ... | ||
| 285 | ], # max: 5; OPTIONAL | ||
| 286 | ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 287 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 288 | }, # OPTIONAL | ||
| 289 | PlainTextMessage => { | ||
| 290 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 291 | |||
| 292 | }, # OPTIONAL | ||
| 293 | SsmlMessage => { | ||
| 294 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 295 | |||
| 296 | }, # OPTIONAL | ||
| 297 | }, | ||
| 298 | Variations => [ | ||
| 299 | { | ||
| 300 | CustomPayload => { | ||
| 301 | Value => 'MyCustomPayloadValue', # min: 1, max: 1000 | ||
| 302 | |||
| 303 | }, # OPTIONAL | ||
| 304 | ImageResponseCard => { | ||
| 305 | Title => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 306 | Buttons => [ | ||
| 307 | { | ||
| 308 | Text => 'MyButtonText', # min: 1, max: 50 | ||
| 309 | Value => 'MyButtonValue', # min: 1, max: 50 | ||
| 310 | |||
| 311 | }, | ||
| 312 | ... | ||
| 313 | ], # max: 5; OPTIONAL | ||
| 314 | ImageUrl => | ||
| 315 | 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL | ||
| 316 | Subtitle => 'MyAttachmentTitle', # min: 1, max: 250 | ||
| 317 | }, # OPTIONAL | ||
| 318 | PlainTextMessage => { | ||
| 319 | Value => 'MyPlainTextMessageValue', # min: 1, max: 1000 | ||
| 320 | |||
| 321 | }, # OPTIONAL | ||
| 322 | SsmlMessage => { | ||
| 323 | Value => 'MySSMLMessageValue', # min: 1, max: 1000 | ||
| 324 | |||
| 325 | }, # OPTIONAL | ||
| 326 | }, | ||
| 327 | ... | ||
| 328 | ], # max: 2; OPTIONAL | ||
| 329 | }, | ||
| 330 | ... | ||
| 331 | ], # min: 1, max: 5 | ||
| 332 | TimeoutInSeconds => 1, # min: 1, max: 900 | ||
| 333 | AllowInterrupt => 1, # OPTIONAL | ||
| 334 | }, # OPTIONAL | ||
| 335 | }, # OPTIONAL | ||
| 336 | }, | ||
| 337 | Description => 'MyDescription', # OPTIONAL | ||
| 338 | MultipleValuesSetting => { | ||
| 339 | AllowMultipleValues => 1, # OPTIONAL | ||
| 340 | }, # OPTIONAL | ||
| 341 | ObfuscationSetting => { | ||
| 342 | ObfuscationSettingType => 'None', # values: None, DefaultObfuscation | ||
| 343 | |||
| 344 | }, # OPTIONAL | ||
| 345 | ); | ||
| 346 | |||
| 347 | # Results: | ||
| 348 | my $BotId = $UpdateSlotResponse->BotId; | ||
| 349 | my $BotVersion = $UpdateSlotResponse->BotVersion; | ||
| 350 | my $CreationDateTime = $UpdateSlotResponse->CreationDateTime; | ||
| 351 | my $Description = $UpdateSlotResponse->Description; | ||
| 352 | my $IntentId = $UpdateSlotResponse->IntentId; | ||
| 353 | my $LastUpdatedDateTime = $UpdateSlotResponse->LastUpdatedDateTime; | ||
| 354 | my $LocaleId = $UpdateSlotResponse->LocaleId; | ||
| 355 | my $MultipleValuesSetting = $UpdateSlotResponse->MultipleValuesSetting; | ||
| 356 | my $ObfuscationSetting = $UpdateSlotResponse->ObfuscationSetting; | ||
| 357 | my $SlotId = $UpdateSlotResponse->SlotId; | ||
| 358 | my $SlotName = $UpdateSlotResponse->SlotName; | ||
| 359 | my $SlotTypeId = $UpdateSlotResponse->SlotTypeId; | ||
| 360 | my $ValueElicitationSetting = $UpdateSlotResponse->ValueElicitationSetting; | ||
| 361 | |||
| 362 | # Returns a L<Paws::LexModelsV2::UpdateSlotResponse> object. | ||
| 363 | |||
| 364 | 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. | ||
| 365 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/UpdateSlot> | ||
| 366 | |||
| 367 | =head1 ATTRIBUTES | ||
| 368 | |||
| 369 | |||
| 370 | =head2 B<REQUIRED> BotId => Str | ||
| 371 | |||
| 372 | The unique identifier of the bot that contains the slot. | ||
| 373 | |||
| 374 | |||
| 375 | |||
| 376 | =head2 B<REQUIRED> BotVersion => Str | ||
| 377 | |||
| 378 | The version of the bot that contains the slot. Must always be C<DRAFT>. | ||
| 379 | |||
| 380 | |||
| 381 | |||
| 382 | =head2 Description => Str | ||
| 383 | |||
| 384 | The new description for the slot. | ||
| 385 | |||
| 386 | |||
| 387 | |||
| 388 | =head2 B<REQUIRED> IntentId => Str | ||
| 389 | |||
| 390 | The identifier of the intent that contains the slot. | ||
| 391 | |||
| 392 | |||
| 393 | |||
| 394 | =head2 B<REQUIRED> LocaleId => Str | ||
| 395 | |||
| 396 | The identifier of the language and locale that contains the slot. The | ||
| 397 | string must match one of the supported locales. For more information, | ||
| 398 | see Supported languages | ||
| 399 | (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). | ||
| 400 | |||
| 401 | |||
| 402 | |||
| 403 | =head2 MultipleValuesSetting => L<Paws::LexModelsV2::MultipleValuesSetting> | ||
| 404 | |||
| 405 | Determines whether the slot accepts multiple values in one response. | ||
| 406 | Multiple value slots are only available in the en-US locale. If you set | ||
| 407 | this value to C<true> in any other locale, Amazon Lex throws a | ||
| 408 | C<ValidationException>. | ||
| 409 | |||
| 410 | If the C<multipleValuesSetting> is not set, the default value is | ||
| 411 | C<false>. | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | =head2 ObfuscationSetting => L<Paws::LexModelsV2::ObfuscationSetting> | ||
| 416 | |||
| 417 | New settings that determine how slot values are formatted in Amazon | ||
| 418 | CloudWatch logs. | ||
| 419 | |||
| 420 | |||
| 421 | |||
| 422 | =head2 B<REQUIRED> SlotId => Str | ||
| 423 | |||
| 424 | The unique identifier for the slot to update. | ||
| 425 | |||
| 426 | |||
| 427 | |||
| 428 | =head2 B<REQUIRED> SlotName => Str | ||
| 429 | |||
| 430 | The new name for the slot. | ||
| 431 | |||
| 432 | |||
| 433 | |||
| 434 | =head2 B<REQUIRED> SlotTypeId => Str | ||
| 435 | |||
| 436 | The unique identifier of the new slot type to associate with this slot. | ||
| 437 | |||
| 438 | |||
| 439 | |||
| 440 | =head2 B<REQUIRED> ValueElicitationSetting => L<Paws::LexModelsV2::SlotValueElicitationSetting> | ||
| 441 | |||
| 442 | A new set of prompts that Amazon Lex sends to the user to elicit a | ||
| 443 | response the provides a value for the slot. | ||
| 444 | |||
| 445 | |||
| 446 | |||
| 447 | |||
| 448 | =head1 SEE ALSO | ||
| 449 | |||
| 450 | This class forms part of L<Paws>, documenting arguments for method UpdateSlot in L<Paws::LexModelsV2> | ||
| 451 | |||
| 452 | =head1 BUGS and CONTRIBUTIONS | ||
| 453 | |||
| 454 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 455 | |||
| 456 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 457 | |||
| 458 | =cut | ||
| 459 |