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