« blib/lib/Paws/Chime/SearchAvailablePhoneNumbersResponse.pm
↑ Summary
blib/lib/Paws/Chime/SendChannelMessageResponse.pm »
| 1 | |||
| 2 | package Paws::Chime::SendChannelMessage; | ||
| 3 | use Moose; | ||
| 4 | has ChannelArn => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'channelArn', required => 1); | ||
| 5 | has ChimeBearer => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-chime-bearer'); | ||
| 6 | has ClientRequestToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Content => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Metadata => (is => 'ro', isa => 'Str'); | ||
| 9 | has Persistence => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendChannelMessage'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels/{channelArn}/messages'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::SendChannelMessageResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Chime::SendChannelMessage - Arguments for method SendChannelMessage on L<Paws::Chime> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method SendChannelMessage on the | ||
| 29 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 30 | as arguments to method SendChannelMessage. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendChannelMessage. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $chime = Paws->service('Chime'); | ||
| 37 | my $SendChannelMessageResponse = $chime->SendChannelMessage( | ||
| 38 | ChannelArn => 'MyChimeArn', | ||
| 39 | ClientRequestToken => 'MyClientRequestToken', | ||
| 40 | Content => 'MyNonEmptyContent', | ||
| 41 | Persistence => 'PERSISTENT', | ||
| 42 | Type => 'STANDARD', | ||
| 43 | ChimeBearer => 'MyChimeArn', # OPTIONAL | ||
| 44 | Metadata => 'MyMetadata', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $ChannelArn = $SendChannelMessageResponse->ChannelArn; | ||
| 49 | my $MessageId = $SendChannelMessageResponse->MessageId; | ||
| 50 | |||
| 51 | # Returns a L<Paws::Chime::SendChannelMessageResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/SendChannelMessage> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ChannelArn => Str | ||
| 60 | |||
| 61 | The ARN of the channel. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 ChimeBearer => Str | ||
| 66 | |||
| 67 | The C<AppInstanceUserArn> of the user that makes the API call. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 72 | |||
| 73 | The C<Idempotency> token for each client request. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Content => Str | ||
| 78 | |||
| 79 | The content of the message. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Metadata => Str | ||
| 84 | |||
| 85 | The optional metadata for each message. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> Persistence => Str | ||
| 90 | |||
| 91 | Boolean that controls whether the message is persisted on the back end. | ||
| 92 | Required. | ||
| 93 | |||
| 94 | Valid values are: C<"PERSISTENT">, C<"NON_PERSISTENT"> | ||
| 95 | |||
| 96 | =head2 B<REQUIRED> Type => Str | ||
| 97 | |||
| 98 | The type of message, C<STANDARD> or C<CONTROL>. | ||
| 99 | |||
| 100 | Valid values are: C<"STANDARD">, C<"CONTROL"> | ||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method SendChannelMessage in L<Paws::Chime> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |