« blib/lib/Paws/LexModelsV2/ConversationLogSettings.pm
↑ Summary
blib/lib/Paws/LexModelsV2/CreateBotAlias.pm »
| 1 | |||
| 2 | package Paws::LexModelsV2::CreateBot; | ||
| 3 | use Moose; | ||
| 4 | has BotName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'botName', required => 1); | ||
| 5 | has BotTags => (is => 'ro', isa => 'Paws::LexModelsV2::TagMap', traits => ['NameInRequest'], request_name => 'botTags'); | ||
| 6 | has DataPrivacy => (is => 'ro', isa => 'Paws::LexModelsV2::DataPrivacy', traits => ['NameInRequest'], request_name => 'dataPrivacy', required => 1); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 8 | has IdleSessionTTLInSeconds => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'idleSessionTTLInSeconds', required => 1); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn', required => 1); | ||
| 10 | has TestBotAliasTags => (is => 'ro', isa => 'Paws::LexModelsV2::TagMap', traits => ['NameInRequest'], request_name => 'testBotAliasTags'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBot'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModelsV2::CreateBotResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::LexModelsV2::CreateBot - Arguments for method CreateBot on L<Paws::LexModelsV2> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateBot on the | ||
| 29 | L<Amazon Lex Model Building V2|Paws::LexModelsV2> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateBot. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBot. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $models-v2-lex = Paws->service('LexModelsV2'); | ||
| 37 | my $CreateBotResponse = $models - v2 -lex->CreateBot( | ||
| 38 | BotName => 'MyName', | ||
| 39 | DataPrivacy => { | ||
| 40 | ChildDirected => 1, | ||
| 41 | |||
| 42 | }, | ||
| 43 | IdleSessionTTLInSeconds => 1, | ||
| 44 | RoleArn => 'MyRoleArn', | ||
| 45 | BotTags => { | ||
| 46 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 47 | }, # OPTIONAL | ||
| 48 | Description => 'MyDescription', # OPTIONAL | ||
| 49 | TestBotAliasTags => { | ||
| 50 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 51 | }, # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $BotId = $CreateBotResponse->BotId; | ||
| 56 | my $BotName = $CreateBotResponse->BotName; | ||
| 57 | my $BotStatus = $CreateBotResponse->BotStatus; | ||
| 58 | my $BotTags = $CreateBotResponse->BotTags; | ||
| 59 | my $CreationDateTime = $CreateBotResponse->CreationDateTime; | ||
| 60 | my $DataPrivacy = $CreateBotResponse->DataPrivacy; | ||
| 61 | my $Description = $CreateBotResponse->Description; | ||
| 62 | my $IdleSessionTTLInSeconds = $CreateBotResponse->IdleSessionTTLInSeconds; | ||
| 63 | my $RoleArn = $CreateBotResponse->RoleArn; | ||
| 64 | my $TestBotAliasTags = $CreateBotResponse->TestBotAliasTags; | ||
| 65 | |||
| 66 | # Returns a L<Paws::LexModelsV2::CreateBotResponse> object. | ||
| 67 | |||
| 68 | 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. | ||
| 69 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/CreateBot> | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> BotName => Str | ||
| 75 | |||
| 76 | The name of the bot. The bot name must be unique in the account that | ||
| 77 | creates the bot. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 BotTags => L<Paws::LexModelsV2::TagMap> | ||
| 82 | |||
| 83 | A list of tags to add to the bot. You can only add tags when you create | ||
| 84 | a bot. You can't use the C<UpdateBot> operation to update tags. To | ||
| 85 | update tags, use the C<TagResource> operation. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> DataPrivacy => L<Paws::LexModelsV2::DataPrivacy> | ||
| 90 | |||
| 91 | Provides information on additional privacy protections Amazon Lex | ||
| 92 | should use with the bot's data. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 Description => Str | ||
| 97 | |||
| 98 | A description of the bot. It appears in lists to help you identify a | ||
| 99 | particular bot. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> IdleSessionTTLInSeconds => Int | ||
| 104 | |||
| 105 | The time, in seconds, that Amazon Lex should keep information about a | ||
| 106 | user's conversation with the bot. | ||
| 107 | |||
| 108 | A user interaction remains active for the amount of time specified. If | ||
| 109 | no conversation occurs during this time, the session expires and Amazon | ||
| 110 | Lex deletes any data provided before the timeout. | ||
| 111 | |||
| 112 | You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RoleArn => Str | ||
| 117 | |||
| 118 | The Amazon Resource Name (ARN) of an IAM role that has permission to | ||
| 119 | access the bot. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 TestBotAliasTags => L<Paws::LexModelsV2::TagMap> | ||
| 124 | |||
| 125 | A list of tags to add to the test alias for a bot. You can only add | ||
| 126 | tags when you create a bot. You can't use the C<UpdateAlias> operation | ||
| 127 | to update tags. To update tags on the test alias, use the | ||
| 128 | C<TagResource> operation. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method CreateBot in L<Paws::LexModelsV2> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |