« blib/lib/Paws/IoTJobsData/UpdateJobExecutionResponse.pm
↑ Summary
blib/lib/Paws/IoTSecureTunneling/CloseTunnel.pm »
| 1 | package Paws::IoTSecureTunneling; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'api.tunneling.iot' } | ||
| 4 | sub signing_name { 'IoTSecuredTunneling' } | ||
| 5 | sub version { '2018-10-05' } | ||
| 6 | sub target_prefix { 'IoTSecuredTunneling' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub CloseTunnel { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::CloseTunnel', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub DescribeTunnel { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::DescribeTunnel', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub ListTagsForResource { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::ListTagsForResource', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub ListTunnels { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::ListTunnels', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub OpenTunnel { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::OpenTunnel', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub TagResource { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::TagResource', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub UntagResource { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::IoTSecureTunneling::UntagResource', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | sub operations { qw/CloseTunnel DescribeTunnel ListTagsForResource ListTunnels OpenTunnel TagResource UntagResource / } | ||
| 57 | |||
| 58 | 1; | ||
| 59 | |||
| 60 | ### main pod documentation begin ### | ||
| 61 | |||
| 62 | =head1 NAME | ||
| 63 | |||
| 64 | Paws::IoTSecureTunneling - Perl Interface to AWS AWS IoT Secure Tunneling | ||
| 65 | |||
| 66 | =head1 SYNOPSIS | ||
| 67 | |||
| 68 | use Paws; | ||
| 69 | |||
| 70 | my $obj = Paws->service('IoTSecureTunneling'); | ||
| 71 | my $res = $obj->Method( | ||
| 72 | Arg1 => $val1, | ||
| 73 | Arg2 => [ 'V1', 'V2' ], | ||
| 74 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 75 | # of the arguments type | ||
| 76 | Arg3 => { Att1 => 'Val1' }, | ||
| 77 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 78 | # the constructor of the arguments type | ||
| 79 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 80 | ); | ||
| 81 | |||
| 82 | =head1 DESCRIPTION | ||
| 83 | |||
| 84 | AWS IoT Secure Tunneling | ||
| 85 | |||
| 86 | AWS IoT Secure Tunnling enables you to create remote connections to | ||
| 87 | devices deployed in the field. | ||
| 88 | |||
| 89 | For more information about how AWS IoT Secure Tunneling works, see AWS | ||
| 90 | IoT Secure Tunneling | ||
| 91 | (https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html). | ||
| 92 | |||
| 93 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.tunneling.iot-2018-10-05> | ||
| 94 | |||
| 95 | |||
| 96 | =head1 METHODS | ||
| 97 | |||
| 98 | =head2 CloseTunnel | ||
| 99 | |||
| 100 | =over | ||
| 101 | |||
| 102 | =item TunnelId => Str | ||
| 103 | |||
| 104 | =item [Delete => Bool] | ||
| 105 | |||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::CloseTunnel> | ||
| 110 | |||
| 111 | Returns: a L<Paws::IoTSecureTunneling::CloseTunnelResponse> instance | ||
| 112 | |||
| 113 | Closes a tunnel identified by the unique tunnel id. When a | ||
| 114 | C<CloseTunnel> request is received, we close the WebSocket connections | ||
| 115 | between the client and proxy server so no data can be transmitted. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 DescribeTunnel | ||
| 119 | |||
| 120 | =over | ||
| 121 | |||
| 122 | =item TunnelId => Str | ||
| 123 | |||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::DescribeTunnel> | ||
| 128 | |||
| 129 | Returns: a L<Paws::IoTSecureTunneling::DescribeTunnelResponse> instance | ||
| 130 | |||
| 131 | Gets information about a tunnel identified by the unique tunnel id. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 ListTagsForResource | ||
| 135 | |||
| 136 | =over | ||
| 137 | |||
| 138 | =item ResourceArn => Str | ||
| 139 | |||
| 140 | |||
| 141 | =back | ||
| 142 | |||
| 143 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::ListTagsForResource> | ||
| 144 | |||
| 145 | Returns: a L<Paws::IoTSecureTunneling::ListTagsForResourceResponse> instance | ||
| 146 | |||
| 147 | Lists the tags for the specified resource. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 ListTunnels | ||
| 151 | |||
| 152 | =over | ||
| 153 | |||
| 154 | =item [MaxResults => Int] | ||
| 155 | |||
| 156 | =item [NextToken => Str] | ||
| 157 | |||
| 158 | =item [ThingName => Str] | ||
| 159 | |||
| 160 | |||
| 161 | =back | ||
| 162 | |||
| 163 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::ListTunnels> | ||
| 164 | |||
| 165 | Returns: a L<Paws::IoTSecureTunneling::ListTunnelsResponse> instance | ||
| 166 | |||
| 167 | List all tunnels for an AWS account. Tunnels are listed by creation | ||
| 168 | time in descending order, newer tunnels will be listed before older | ||
| 169 | tunnels. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 OpenTunnel | ||
| 173 | |||
| 174 | =over | ||
| 175 | |||
| 176 | =item [Description => Str] | ||
| 177 | |||
| 178 | =item [DestinationConfig => L<Paws::IoTSecureTunneling::DestinationConfig>] | ||
| 179 | |||
| 180 | =item [Tags => ArrayRef[L<Paws::IoTSecureTunneling::Tag>]] | ||
| 181 | |||
| 182 | =item [TimeoutConfig => L<Paws::IoTSecureTunneling::TimeoutConfig>] | ||
| 183 | |||
| 184 | |||
| 185 | =back | ||
| 186 | |||
| 187 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::OpenTunnel> | ||
| 188 | |||
| 189 | Returns: a L<Paws::IoTSecureTunneling::OpenTunnelResponse> instance | ||
| 190 | |||
| 191 | Creates a new tunnel, and returns two client access tokens for clients | ||
| 192 | to use to connect to the AWS IoT Secure Tunneling proxy server. | ||
| 193 | |||
| 194 | |||
| 195 | =head2 TagResource | ||
| 196 | |||
| 197 | =over | ||
| 198 | |||
| 199 | =item ResourceArn => Str | ||
| 200 | |||
| 201 | =item Tags => ArrayRef[L<Paws::IoTSecureTunneling::Tag>] | ||
| 202 | |||
| 203 | |||
| 204 | =back | ||
| 205 | |||
| 206 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::TagResource> | ||
| 207 | |||
| 208 | Returns: a L<Paws::IoTSecureTunneling::TagResourceResponse> instance | ||
| 209 | |||
| 210 | A resource tag. | ||
| 211 | |||
| 212 | |||
| 213 | =head2 UntagResource | ||
| 214 | |||
| 215 | =over | ||
| 216 | |||
| 217 | =item ResourceArn => Str | ||
| 218 | |||
| 219 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 220 | |||
| 221 | |||
| 222 | =back | ||
| 223 | |||
| 224 | Each argument is described in detail in: L<Paws::IoTSecureTunneling::UntagResource> | ||
| 225 | |||
| 226 | Returns: a L<Paws::IoTSecureTunneling::UntagResourceResponse> instance | ||
| 227 | |||
| 228 | Removes a tag from a resource. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head1 PAGINATORS | ||
| 234 | |||
| 235 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head1 SEE ALSO | ||
| 241 | |||
| 242 | This service class forms part of L<Paws> | ||
| 243 | |||
| 244 | =head1 BUGS and CONTRIBUTIONS | ||
| 245 | |||
| 246 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 247 | |||
| 248 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 249 | |||
| 250 | =cut | ||
| 251 |