« blib/lib/Paws/IoTAnalytics/VersioningConfiguration.pm
↑ Summary
blib/lib/Paws/IoTData/DeleteThingShadow.pm »
| 1 | package Paws::IoTData; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'data.iot' } | ||
| 4 | sub signing_name { 'iotdata' } | ||
| 5 | sub version { '2015-05-28' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub DeleteThingShadow { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::IoTData::DeleteThingShadow', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub GetThingShadow { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::IoTData::GetThingShadow', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub ListNamedShadowsForThing { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::IoTData::ListNamedShadowsForThing', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub Publish { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::IoTData::Publish', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub UpdateThingShadow { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::IoTData::UpdateThingShadow', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | |||
| 43 | |||
| 44 | |||
| 45 | sub operations { qw/DeleteThingShadow GetThingShadow ListNamedShadowsForThing Publish UpdateThingShadow / } | ||
| 46 | |||
| 47 | 1; | ||
| 48 | |||
| 49 | ### main pod documentation begin ### | ||
| 50 | |||
| 51 | =head1 NAME | ||
| 52 | |||
| 53 | Paws::IoTData - Perl Interface to AWS AWS IoT Data Plane | ||
| 54 | |||
| 55 | =head1 SYNOPSIS | ||
| 56 | |||
| 57 | use Paws; | ||
| 58 | |||
| 59 | my $obj = Paws->service('IoTData'); | ||
| 60 | my $res = $obj->Method( | ||
| 61 | Arg1 => $val1, | ||
| 62 | Arg2 => [ 'V1', 'V2' ], | ||
| 63 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 64 | # of the arguments type | ||
| 65 | Arg3 => { Att1 => 'Val1' }, | ||
| 66 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 67 | # the constructor of the arguments type | ||
| 68 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 69 | ); | ||
| 70 | |||
| 71 | =head1 DESCRIPTION | ||
| 72 | |||
| 73 | AWS IoT | ||
| 74 | |||
| 75 | AWS IoT-Data enables secure, bi-directional communication between | ||
| 76 | Internet-connected things (such as sensors, actuators, embedded | ||
| 77 | devices, or smart appliances) and the AWS cloud. It implements a broker | ||
| 78 | for applications and things to publish messages over HTTP (Publish) and | ||
| 79 | retrieve, update, and delete shadows. A shadow is a persistent | ||
| 80 | representation of your things and their state in the AWS cloud. | ||
| 81 | |||
| 82 | Find the endpoint address for actions in the AWS IoT data plane by | ||
| 83 | running this CLI command: | ||
| 84 | |||
| 85 | C<aws iot describe-endpoint --endpoint-type iot:Data-ATS> | ||
| 86 | |||
| 87 | The service name used by AWS Signature Version 4 | ||
| 88 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) | ||
| 89 | to sign requests is: I<iotdevicegateway>. | ||
| 90 | |||
| 91 | For the AWS API documentation, see L<https://docs.aws.amazon.com/iot/> | ||
| 92 | |||
| 93 | |||
| 94 | =head1 METHODS | ||
| 95 | |||
| 96 | =head2 DeleteThingShadow | ||
| 97 | |||
| 98 | =over | ||
| 99 | |||
| 100 | =item ThingName => Str | ||
| 101 | |||
| 102 | =item [ShadowName => Str] | ||
| 103 | |||
| 104 | |||
| 105 | =back | ||
| 106 | |||
| 107 | Each argument is described in detail in: L<Paws::IoTData::DeleteThingShadow> | ||
| 108 | |||
| 109 | Returns: a L<Paws::IoTData::DeleteThingShadowResponse> instance | ||
| 110 | |||
| 111 | Deletes the shadow for the specified thing. | ||
| 112 | |||
| 113 | For more information, see DeleteThingShadow | ||
| 114 | (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html) | ||
| 115 | in the AWS IoT Developer Guide. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 GetThingShadow | ||
| 119 | |||
| 120 | =over | ||
| 121 | |||
| 122 | =item ThingName => Str | ||
| 123 | |||
| 124 | =item [ShadowName => Str] | ||
| 125 | |||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | Each argument is described in detail in: L<Paws::IoTData::GetThingShadow> | ||
| 130 | |||
| 131 | Returns: a L<Paws::IoTData::GetThingShadowResponse> instance | ||
| 132 | |||
| 133 | Gets the shadow for the specified thing. | ||
| 134 | |||
| 135 | For more information, see GetThingShadow | ||
| 136 | (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html) | ||
| 137 | in the AWS IoT Developer Guide. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 ListNamedShadowsForThing | ||
| 141 | |||
| 142 | =over | ||
| 143 | |||
| 144 | =item ThingName => Str | ||
| 145 | |||
| 146 | =item [NextToken => Str] | ||
| 147 | |||
| 148 | =item [PageSize => Int] | ||
| 149 | |||
| 150 | |||
| 151 | =back | ||
| 152 | |||
| 153 | Each argument is described in detail in: L<Paws::IoTData::ListNamedShadowsForThing> | ||
| 154 | |||
| 155 | Returns: a L<Paws::IoTData::ListNamedShadowsForThingResponse> instance | ||
| 156 | |||
| 157 | Lists the shadows for the specified thing. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 Publish | ||
| 161 | |||
| 162 | =over | ||
| 163 | |||
| 164 | =item Topic => Str | ||
| 165 | |||
| 166 | =item [Payload => Str] | ||
| 167 | |||
| 168 | =item [Qos => Int] | ||
| 169 | |||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | Each argument is described in detail in: L<Paws::IoTData::Publish> | ||
| 174 | |||
| 175 | Returns: nothing | ||
| 176 | |||
| 177 | Publishes state information. | ||
| 178 | |||
| 179 | For more information, see HTTP Protocol | ||
| 180 | (http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http) | ||
| 181 | in the AWS IoT Developer Guide. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 UpdateThingShadow | ||
| 185 | |||
| 186 | =over | ||
| 187 | |||
| 188 | =item Payload => Str | ||
| 189 | |||
| 190 | =item ThingName => Str | ||
| 191 | |||
| 192 | =item [ShadowName => Str] | ||
| 193 | |||
| 194 | |||
| 195 | =back | ||
| 196 | |||
| 197 | Each argument is described in detail in: L<Paws::IoTData::UpdateThingShadow> | ||
| 198 | |||
| 199 | Returns: a L<Paws::IoTData::UpdateThingShadowResponse> instance | ||
| 200 | |||
| 201 | Updates the shadow for the specified thing. | ||
| 202 | |||
| 203 | For more information, see UpdateThingShadow | ||
| 204 | (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html) | ||
| 205 | in the AWS IoT Developer Guide. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head1 PAGINATORS | ||
| 211 | |||
| 212 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head1 SEE ALSO | ||
| 218 | |||
| 219 | This service class forms part of L<Paws> | ||
| 220 | |||
| 221 | =head1 BUGS and CONTRIBUTIONS | ||
| 222 | |||
| 223 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 224 | |||
| 225 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 226 | |||
| 227 | =cut | ||
| 228 |