| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexModels::BotChannelAssociation; | ||
| 3 | use Moose; | ||
| 4 | has BotAlias => (is => 'ro', isa => 'Str', request_name => 'botAlias', traits => ['NameInRequest']); | ||
| 5 | has BotConfiguration => (is => 'ro', isa => 'Paws::LexModels::ChannelConfigurationMap', request_name => 'botConfiguration', traits => ['NameInRequest']); | ||
| 6 | has BotName => (is => 'ro', isa => 'Str', request_name => 'botName', traits => ['NameInRequest']); | ||
| 7 | has CreatedDate => (is => 'ro', isa => 'Str', request_name => 'createdDate', traits => ['NameInRequest']); | ||
| 8 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 9 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 11 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::LexModels::BotChannelAssociation | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::LexModels::BotChannelAssociation object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { BotAlias => $value, ..., Type => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::LexModels::BotChannelAssociation object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->BotAlias | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Represents an association between an Amazon Lex bot and an external | ||
| 45 | messaging platform. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 BotAlias => Str | ||
| 51 | |||
| 52 | An alias pointing to the specific version of the Amazon Lex bot to | ||
| 53 | which this association is being made. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 BotConfiguration => L<Paws::LexModels::ChannelConfigurationMap> | ||
| 57 | |||
| 58 | Provides information necessary to communicate with the messaging | ||
| 59 | platform. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 BotName => Str | ||
| 63 | |||
| 64 | The name of the Amazon Lex bot to which this association is being made. | ||
| 65 | |||
| 66 | Currently, Amazon Lex supports associations with Facebook and Slack, | ||
| 67 | and Twilio. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 CreatedDate => Str | ||
| 71 | |||
| 72 | The date that the association between the Amazon Lex bot and the | ||
| 73 | channel was created. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Description => Str | ||
| 77 | |||
| 78 | A text description of the association you are creating. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 FailureReason => Str | ||
| 82 | |||
| 83 | If C<status> is C<FAILED>, Amazon Lex provides the reason that it | ||
| 84 | failed to create the association. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Name => Str | ||
| 88 | |||
| 89 | The name of the association between the bot and the channel. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Status => Str | ||
| 93 | |||
| 94 | The status of the bot channel. | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<CREATED> - The channel has been created and is ready for use. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<IN_PROGRESS> - Channel creation is in progress. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<FAILED> - There was an error creating the channel. For information | ||
| 109 | about the reason for the failure, see the C<failureReason> field. | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 Type => Str | ||
| 116 | |||
| 117 | Specifies the type of association by indicating the type of channel | ||
| 118 | being established between the Amazon Lex bot and the external messaging | ||
| 119 | platform. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::LexModels> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |