« blib/lib/Paws/IoTAnalytics/AttributeNameMapping.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/BatchPutMessageErrorEntry.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::BatchPutMessage; | ||
| 3 | use Moose; | ||
| 4 | has ChannelName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'channelName', required => 1); | ||
| 5 | has Messages => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::Message]', traits => ['NameInRequest'], request_name => 'messages', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchPutMessage'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/messages/batch'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTAnalytics::BatchPutMessageResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoTAnalytics::BatchPutMessage - Arguments for method BatchPutMessage on L<Paws::IoTAnalytics> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method BatchPutMessage on the | ||
| 24 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 25 | as arguments to method BatchPutMessage. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchPutMessage. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 32 | my $BatchPutMessageResponse = $iotanalytics->BatchPutMessage( | ||
| 33 | ChannelName => 'MyChannelName', | ||
| 34 | Messages => [ | ||
| 35 | { | ||
| 36 | MessageId => 'MyMessageId', # min: 1, max: 128 | ||
| 37 | Payload => 'BlobMessagePayload', | ||
| 38 | |||
| 39 | }, | ||
| 40 | ... | ||
| 41 | ], | ||
| 42 | |||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $BatchPutMessageErrorEntries = | ||
| 47 | $BatchPutMessageResponse->BatchPutMessageErrorEntries; | ||
| 48 | |||
| 49 | # Returns a L<Paws::IoTAnalytics::BatchPutMessageResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/BatchPutMessage> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ChannelName => Str | ||
| 58 | |||
| 59 | The name of the channel where the messages are sent. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Messages => ArrayRef[L<Paws::IoTAnalytics::Message>] | ||
| 64 | |||
| 65 | The list of messages to be sent. Each message has the format: { | ||
| 66 | "messageId": "string", "payload": "string"}. | ||
| 67 | |||
| 68 | The field names of message payloads (data) that you send to AWS IoT | ||
| 69 | Analytics: | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | Must contain only alphanumeric characters and undescores (_). No other | ||
| 76 | special characters are allowed. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | Must begin with an alphabetic character or single underscore (_). | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Cannot contain hyphens (-). | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | In regular expression terms: | ||
| 89 | "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Cannot be more than 255 characters. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Are case insensitive. (Fields named foo and FOO in the same payload are | ||
| 98 | considered duplicates.) | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but | ||
| 103 | {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in | ||
| 104 | message payloads. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method BatchPutMessage in L<Paws::IoTAnalytics> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |