| 1 | package Paws::IoTSiteWise; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'iotsitewise' } | ||
| 4 | sub signing_name { 'iotsitewise' } | ||
| 5 | sub version { '2019-12-02' } | ||
| 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 AssociateAssets { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::AssociateAssets', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub BatchAssociateProjectAssets { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::BatchAssociateProjectAssets', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub BatchDisassociateProjectAssets { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::BatchDisassociateProjectAssets', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub BatchPutAssetPropertyValue { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::BatchPutAssetPropertyValue', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub CreateAccessPolicy { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateAccessPolicy', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | sub CreateAsset { | ||
| 43 | my $self = shift; | ||
| 44 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateAsset', @_); | ||
| 45 | return $self->caller->do_call($self, $call_object); | ||
| 46 | } | ||
| 47 | sub CreateAssetModel { | ||
| 48 | my $self = shift; | ||
| 49 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateAssetModel', @_); | ||
| 50 | return $self->caller->do_call($self, $call_object); | ||
| 51 | } | ||
| 52 | sub CreateDashboard { | ||
| 53 | my $self = shift; | ||
| 54 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateDashboard', @_); | ||
| 55 | return $self->caller->do_call($self, $call_object); | ||
| 56 | } | ||
| 57 | sub CreateGateway { | ||
| 58 | my $self = shift; | ||
| 59 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateGateway', @_); | ||
| 60 | return $self->caller->do_call($self, $call_object); | ||
| 61 | } | ||
| 62 | sub CreatePortal { | ||
| 63 | my $self = shift; | ||
| 64 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreatePortal', @_); | ||
| 65 | return $self->caller->do_call($self, $call_object); | ||
| 66 | } | ||
| 67 | sub CreateProject { | ||
| 68 | my $self = shift; | ||
| 69 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::CreateProject', @_); | ||
| 70 | return $self->caller->do_call($self, $call_object); | ||
| 71 | } | ||
| 72 | sub DeleteAccessPolicy { | ||
| 73 | my $self = shift; | ||
| 74 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteAccessPolicy', @_); | ||
| 75 | return $self->caller->do_call($self, $call_object); | ||
| 76 | } | ||
| 77 | sub DeleteAsset { | ||
| 78 | my $self = shift; | ||
| 79 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteAsset', @_); | ||
| 80 | return $self->caller->do_call($self, $call_object); | ||
| 81 | } | ||
| 82 | sub DeleteAssetModel { | ||
| 83 | my $self = shift; | ||
| 84 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteAssetModel', @_); | ||
| 85 | return $self->caller->do_call($self, $call_object); | ||
| 86 | } | ||
| 87 | sub DeleteDashboard { | ||
| 88 | my $self = shift; | ||
| 89 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteDashboard', @_); | ||
| 90 | return $self->caller->do_call($self, $call_object); | ||
| 91 | } | ||
| 92 | sub DeleteGateway { | ||
| 93 | my $self = shift; | ||
| 94 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteGateway', @_); | ||
| 95 | return $self->caller->do_call($self, $call_object); | ||
| 96 | } | ||
| 97 | sub DeletePortal { | ||
| 98 | my $self = shift; | ||
| 99 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeletePortal', @_); | ||
| 100 | return $self->caller->do_call($self, $call_object); | ||
| 101 | } | ||
| 102 | sub DeleteProject { | ||
| 103 | my $self = shift; | ||
| 104 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DeleteProject', @_); | ||
| 105 | return $self->caller->do_call($self, $call_object); | ||
| 106 | } | ||
| 107 | sub DescribeAccessPolicy { | ||
| 108 | my $self = shift; | ||
| 109 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeAccessPolicy', @_); | ||
| 110 | return $self->caller->do_call($self, $call_object); | ||
| 111 | } | ||
| 112 | sub DescribeAsset { | ||
| 113 | my $self = shift; | ||
| 114 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeAsset', @_); | ||
| 115 | return $self->caller->do_call($self, $call_object); | ||
| 116 | } | ||
| 117 | sub DescribeAssetModel { | ||
| 118 | my $self = shift; | ||
| 119 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeAssetModel', @_); | ||
| 120 | return $self->caller->do_call($self, $call_object); | ||
| 121 | } | ||
| 122 | sub DescribeAssetProperty { | ||
| 123 | my $self = shift; | ||
| 124 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeAssetProperty', @_); | ||
| 125 | return $self->caller->do_call($self, $call_object); | ||
| 126 | } | ||
| 127 | sub DescribeDashboard { | ||
| 128 | my $self = shift; | ||
| 129 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeDashboard', @_); | ||
| 130 | return $self->caller->do_call($self, $call_object); | ||
| 131 | } | ||
| 132 | sub DescribeDefaultEncryptionConfiguration { | ||
| 133 | my $self = shift; | ||
| 134 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeDefaultEncryptionConfiguration', @_); | ||
| 135 | return $self->caller->do_call($self, $call_object); | ||
| 136 | } | ||
| 137 | sub DescribeGateway { | ||
| 138 | my $self = shift; | ||
| 139 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeGateway', @_); | ||
| 140 | return $self->caller->do_call($self, $call_object); | ||
| 141 | } | ||
| 142 | sub DescribeGatewayCapabilityConfiguration { | ||
| 143 | my $self = shift; | ||
| 144 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeGatewayCapabilityConfiguration', @_); | ||
| 145 | return $self->caller->do_call($self, $call_object); | ||
| 146 | } | ||
| 147 | sub DescribeLoggingOptions { | ||
| 148 | my $self = shift; | ||
| 149 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeLoggingOptions', @_); | ||
| 150 | return $self->caller->do_call($self, $call_object); | ||
| 151 | } | ||
| 152 | sub DescribePortal { | ||
| 153 | my $self = shift; | ||
| 154 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribePortal', @_); | ||
| 155 | return $self->caller->do_call($self, $call_object); | ||
| 156 | } | ||
| 157 | sub DescribeProject { | ||
| 158 | my $self = shift; | ||
| 159 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DescribeProject', @_); | ||
| 160 | return $self->caller->do_call($self, $call_object); | ||
| 161 | } | ||
| 162 | sub DisassociateAssets { | ||
| 163 | my $self = shift; | ||
| 164 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::DisassociateAssets', @_); | ||
| 165 | return $self->caller->do_call($self, $call_object); | ||
| 166 | } | ||
| 167 | sub GetAssetPropertyAggregates { | ||
| 168 | my $self = shift; | ||
| 169 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::GetAssetPropertyAggregates', @_); | ||
| 170 | return $self->caller->do_call($self, $call_object); | ||
| 171 | } | ||
| 172 | sub GetAssetPropertyValue { | ||
| 173 | my $self = shift; | ||
| 174 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::GetAssetPropertyValue', @_); | ||
| 175 | return $self->caller->do_call($self, $call_object); | ||
| 176 | } | ||
| 177 | sub GetAssetPropertyValueHistory { | ||
| 178 | my $self = shift; | ||
| 179 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::GetAssetPropertyValueHistory', @_); | ||
| 180 | return $self->caller->do_call($self, $call_object); | ||
| 181 | } | ||
| 182 | sub GetInterpolatedAssetPropertyValues { | ||
| 183 | my $self = shift; | ||
| 184 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::GetInterpolatedAssetPropertyValues', @_); | ||
| 185 | return $self->caller->do_call($self, $call_object); | ||
| 186 | } | ||
| 187 | sub ListAccessPolicies { | ||
| 188 | my $self = shift; | ||
| 189 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListAccessPolicies', @_); | ||
| 190 | return $self->caller->do_call($self, $call_object); | ||
| 191 | } | ||
| 192 | sub ListAssetModels { | ||
| 193 | my $self = shift; | ||
| 194 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListAssetModels', @_); | ||
| 195 | return $self->caller->do_call($self, $call_object); | ||
| 196 | } | ||
| 197 | sub ListAssetRelationships { | ||
| 198 | my $self = shift; | ||
| 199 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListAssetRelationships', @_); | ||
| 200 | return $self->caller->do_call($self, $call_object); | ||
| 201 | } | ||
| 202 | sub ListAssets { | ||
| 203 | my $self = shift; | ||
| 204 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListAssets', @_); | ||
| 205 | return $self->caller->do_call($self, $call_object); | ||
| 206 | } | ||
| 207 | sub ListAssociatedAssets { | ||
| 208 | my $self = shift; | ||
| 209 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListAssociatedAssets', @_); | ||
| 210 | return $self->caller->do_call($self, $call_object); | ||
| 211 | } | ||
| 212 | sub ListDashboards { | ||
| 213 | my $self = shift; | ||
| 214 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListDashboards', @_); | ||
| 215 | return $self->caller->do_call($self, $call_object); | ||
| 216 | } | ||
| 217 | sub ListGateways { | ||
| 218 | my $self = shift; | ||
| 219 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListGateways', @_); | ||
| 220 | return $self->caller->do_call($self, $call_object); | ||
| 221 | } | ||
| 222 | sub ListPortals { | ||
| 223 | my $self = shift; | ||
| 224 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListPortals', @_); | ||
| 225 | return $self->caller->do_call($self, $call_object); | ||
| 226 | } | ||
| 227 | sub ListProjectAssets { | ||
| 228 | my $self = shift; | ||
| 229 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListProjectAssets', @_); | ||
| 230 | return $self->caller->do_call($self, $call_object); | ||
| 231 | } | ||
| 232 | sub ListProjects { | ||
| 233 | my $self = shift; | ||
| 234 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListProjects', @_); | ||
| 235 | return $self->caller->do_call($self, $call_object); | ||
| 236 | } | ||
| 237 | sub ListTagsForResource { | ||
| 238 | my $self = shift; | ||
| 239 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::ListTagsForResource', @_); | ||
| 240 | return $self->caller->do_call($self, $call_object); | ||
| 241 | } | ||
| 242 | sub PutDefaultEncryptionConfiguration { | ||
| 243 | my $self = shift; | ||
| 244 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::PutDefaultEncryptionConfiguration', @_); | ||
| 245 | return $self->caller->do_call($self, $call_object); | ||
| 246 | } | ||
| 247 | sub PutLoggingOptions { | ||
| 248 | my $self = shift; | ||
| 249 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::PutLoggingOptions', @_); | ||
| 250 | return $self->caller->do_call($self, $call_object); | ||
| 251 | } | ||
| 252 | sub TagResource { | ||
| 253 | my $self = shift; | ||
| 254 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::TagResource', @_); | ||
| 255 | return $self->caller->do_call($self, $call_object); | ||
| 256 | } | ||
| 257 | sub UntagResource { | ||
| 258 | my $self = shift; | ||
| 259 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UntagResource', @_); | ||
| 260 | return $self->caller->do_call($self, $call_object); | ||
| 261 | } | ||
| 262 | sub UpdateAccessPolicy { | ||
| 263 | my $self = shift; | ||
| 264 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateAccessPolicy', @_); | ||
| 265 | return $self->caller->do_call($self, $call_object); | ||
| 266 | } | ||
| 267 | sub UpdateAsset { | ||
| 268 | my $self = shift; | ||
| 269 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateAsset', @_); | ||
| 270 | return $self->caller->do_call($self, $call_object); | ||
| 271 | } | ||
| 272 | sub UpdateAssetModel { | ||
| 273 | my $self = shift; | ||
| 274 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateAssetModel', @_); | ||
| 275 | return $self->caller->do_call($self, $call_object); | ||
| 276 | } | ||
| 277 | sub UpdateAssetProperty { | ||
| 278 | my $self = shift; | ||
| 279 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateAssetProperty', @_); | ||
| 280 | return $self->caller->do_call($self, $call_object); | ||
| 281 | } | ||
| 282 | sub UpdateDashboard { | ||
| 283 | my $self = shift; | ||
| 284 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateDashboard', @_); | ||
| 285 | return $self->caller->do_call($self, $call_object); | ||
| 286 | } | ||
| 287 | sub UpdateGateway { | ||
| 288 | my $self = shift; | ||
| 289 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateGateway', @_); | ||
| 290 | return $self->caller->do_call($self, $call_object); | ||
| 291 | } | ||
| 292 | sub UpdateGatewayCapabilityConfiguration { | ||
| 293 | my $self = shift; | ||
| 294 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateGatewayCapabilityConfiguration', @_); | ||
| 295 | return $self->caller->do_call($self, $call_object); | ||
| 296 | } | ||
| 297 | sub UpdatePortal { | ||
| 298 | my $self = shift; | ||
| 299 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdatePortal', @_); | ||
| 300 | return $self->caller->do_call($self, $call_object); | ||
| 301 | } | ||
| 302 | sub UpdateProject { | ||
| 303 | my $self = shift; | ||
| 304 | my $call_object = $self->new_with_coercions('Paws::IoTSiteWise::UpdateProject', @_); | ||
| 305 | return $self->caller->do_call($self, $call_object); | ||
| 306 | } | ||
| 307 | |||
| 308 | sub GetAllAssetPropertyAggregates { | ||
| 309 | my $self = shift; | ||
| 310 | |||
| 311 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 312 | my $result = $self->GetAssetPropertyAggregates(@_); | ||
| 313 | my $next_result = $result; | ||
| 314 | |||
| 315 | if (not defined $callback) { | ||
| 316 | while ($next_result->nextToken) { | ||
| 317 | $next_result = $self->GetAssetPropertyAggregates(@_, nextToken => $next_result->nextToken); | ||
| 318 | push @{ $result->aggregatedValues }, @{ $next_result->aggregatedValues }; | ||
| 319 | } | ||
| 320 | return $result; | ||
| 321 | } else { | ||
| 322 | while ($result->nextToken) { | ||
| 323 | $callback->($_ => 'aggregatedValues') foreach (@{ $result->aggregatedValues }); | ||
| 324 | $result = $self->GetAssetPropertyAggregates(@_, nextToken => $result->nextToken); | ||
| 325 | } | ||
| 326 | $callback->($_ => 'aggregatedValues') foreach (@{ $result->aggregatedValues }); | ||
| 327 | } | ||
| 328 | |||
| 329 | return undef | ||
| 330 | } | ||
| 331 | sub GetAllAssetPropertyValueHistory { | ||
| 332 | my $self = shift; | ||
| 333 | |||
| 334 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 335 | my $result = $self->GetAssetPropertyValueHistory(@_); | ||
| 336 | my $next_result = $result; | ||
| 337 | |||
| 338 | if (not defined $callback) { | ||
| 339 | while ($next_result->nextToken) { | ||
| 340 | $next_result = $self->GetAssetPropertyValueHistory(@_, nextToken => $next_result->nextToken); | ||
| 341 | push @{ $result->assetPropertyValueHistory }, @{ $next_result->assetPropertyValueHistory }; | ||
| 342 | } | ||
| 343 | return $result; | ||
| 344 | } else { | ||
| 345 | while ($result->nextToken) { | ||
| 346 | $callback->($_ => 'assetPropertyValueHistory') foreach (@{ $result->assetPropertyValueHistory }); | ||
| 347 | $result = $self->GetAssetPropertyValueHistory(@_, nextToken => $result->nextToken); | ||
| 348 | } | ||
| 349 | $callback->($_ => 'assetPropertyValueHistory') foreach (@{ $result->assetPropertyValueHistory }); | ||
| 350 | } | ||
| 351 | |||
| 352 | return undef | ||
| 353 | } | ||
| 354 | sub GetAllInterpolatedAssetPropertyValues { | ||
| 355 | my $self = shift; | ||
| 356 | |||
| 357 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 358 | my $result = $self->GetInterpolatedAssetPropertyValues(@_); | ||
| 359 | my $next_result = $result; | ||
| 360 | |||
| 361 | if (not defined $callback) { | ||
| 362 | while ($next_result->nextToken) { | ||
| 363 | $next_result = $self->GetInterpolatedAssetPropertyValues(@_, nextToken => $next_result->nextToken); | ||
| 364 | push @{ $result->interpolatedAssetPropertyValues }, @{ $next_result->interpolatedAssetPropertyValues }; | ||
| 365 | } | ||
| 366 | return $result; | ||
| 367 | } else { | ||
| 368 | while ($result->nextToken) { | ||
| 369 | $callback->($_ => 'interpolatedAssetPropertyValues') foreach (@{ $result->interpolatedAssetPropertyValues }); | ||
| 370 | $result = $self->GetInterpolatedAssetPropertyValues(@_, nextToken => $result->nextToken); | ||
| 371 | } | ||
| 372 | $callback->($_ => 'interpolatedAssetPropertyValues') foreach (@{ $result->interpolatedAssetPropertyValues }); | ||
| 373 | } | ||
| 374 | |||
| 375 | return undef | ||
| 376 | } | ||
| 377 | sub ListAllAccessPolicies { | ||
| 378 | my $self = shift; | ||
| 379 | |||
| 380 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 381 | my $result = $self->ListAccessPolicies(@_); | ||
| 382 | my $next_result = $result; | ||
| 383 | |||
| 384 | if (not defined $callback) { | ||
| 385 | while ($next_result->nextToken) { | ||
| 386 | $next_result = $self->ListAccessPolicies(@_, nextToken => $next_result->nextToken); | ||
| 387 | push @{ $result->accessPolicySummaries }, @{ $next_result->accessPolicySummaries }; | ||
| 388 | } | ||
| 389 | return $result; | ||
| 390 | } else { | ||
| 391 | while ($result->nextToken) { | ||
| 392 | $callback->($_ => 'accessPolicySummaries') foreach (@{ $result->accessPolicySummaries }); | ||
| 393 | $result = $self->ListAccessPolicies(@_, nextToken => $result->nextToken); | ||
| 394 | } | ||
| 395 | $callback->($_ => 'accessPolicySummaries') foreach (@{ $result->accessPolicySummaries }); | ||
| 396 | } | ||
| 397 | |||
| 398 | return undef | ||
| 399 | } | ||
| 400 | sub ListAllAssetModels { | ||
| 401 | my $self = shift; | ||
| 402 | |||
| 403 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 404 | my $result = $self->ListAssetModels(@_); | ||
| 405 | my $next_result = $result; | ||
| 406 | |||
| 407 | if (not defined $callback) { | ||
| 408 | while ($next_result->nextToken) { | ||
| 409 | $next_result = $self->ListAssetModels(@_, nextToken => $next_result->nextToken); | ||
| 410 | push @{ $result->assetModelSummaries }, @{ $next_result->assetModelSummaries }; | ||
| 411 | } | ||
| 412 | return $result; | ||
| 413 | } else { | ||
| 414 | while ($result->nextToken) { | ||
| 415 | $callback->($_ => 'assetModelSummaries') foreach (@{ $result->assetModelSummaries }); | ||
| 416 | $result = $self->ListAssetModels(@_, nextToken => $result->nextToken); | ||
| 417 | } | ||
| 418 | $callback->($_ => 'assetModelSummaries') foreach (@{ $result->assetModelSummaries }); | ||
| 419 | } | ||
| 420 | |||
| 421 | return undef | ||
| 422 | } | ||
| 423 | sub ListAllAssetRelationships { | ||
| 424 | my $self = shift; | ||
| 425 | |||
| 426 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 427 | my $result = $self->ListAssetRelationships(@_); | ||
| 428 | my $next_result = $result; | ||
| 429 | |||
| 430 | if (not defined $callback) { | ||
| 431 | while ($next_result->nextToken) { | ||
| 432 | $next_result = $self->ListAssetRelationships(@_, nextToken => $next_result->nextToken); | ||
| 433 | push @{ $result->assetRelationshipSummaries }, @{ $next_result->assetRelationshipSummaries }; | ||
| 434 | } | ||
| 435 | return $result; | ||
| 436 | } else { | ||
| 437 | while ($result->nextToken) { | ||
| 438 | $callback->($_ => 'assetRelationshipSummaries') foreach (@{ $result->assetRelationshipSummaries }); | ||
| 439 | $result = $self->ListAssetRelationships(@_, nextToken => $result->nextToken); | ||
| 440 | } | ||
| 441 | $callback->($_ => 'assetRelationshipSummaries') foreach (@{ $result->assetRelationshipSummaries }); | ||
| 442 | } | ||
| 443 | |||
| 444 | return undef | ||
| 445 | } | ||
| 446 | sub ListAllAssets { | ||
| 447 | my $self = shift; | ||
| 448 | |||
| 449 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 450 | my $result = $self->ListAssets(@_); | ||
| 451 | my $next_result = $result; | ||
| 452 | |||
| 453 | if (not defined $callback) { | ||
| 454 | while ($next_result->nextToken) { | ||
| 455 | $next_result = $self->ListAssets(@_, nextToken => $next_result->nextToken); | ||
| 456 | push @{ $result->assetSummaries }, @{ $next_result->assetSummaries }; | ||
| 457 | } | ||
| 458 | return $result; | ||
| 459 | } else { | ||
| 460 | while ($result->nextToken) { | ||
| 461 | $callback->($_ => 'assetSummaries') foreach (@{ $result->assetSummaries }); | ||
| 462 | $result = $self->ListAssets(@_, nextToken => $result->nextToken); | ||
| 463 | } | ||
| 464 | $callback->($_ => 'assetSummaries') foreach (@{ $result->assetSummaries }); | ||
| 465 | } | ||
| 466 | |||
| 467 | return undef | ||
| 468 | } | ||
| 469 | sub ListAllAssociatedAssets { | ||
| 470 | my $self = shift; | ||
| 471 | |||
| 472 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 473 | my $result = $self->ListAssociatedAssets(@_); | ||
| 474 | my $next_result = $result; | ||
| 475 | |||
| 476 | if (not defined $callback) { | ||
| 477 | while ($next_result->nextToken) { | ||
| 478 | $next_result = $self->ListAssociatedAssets(@_, nextToken => $next_result->nextToken); | ||
| 479 | push @{ $result->assetSummaries }, @{ $next_result->assetSummaries }; | ||
| 480 | } | ||
| 481 | return $result; | ||
| 482 | } else { | ||
| 483 | while ($result->nextToken) { | ||
| 484 | $callback->($_ => 'assetSummaries') foreach (@{ $result->assetSummaries }); | ||
| 485 | $result = $self->ListAssociatedAssets(@_, nextToken => $result->nextToken); | ||
| 486 | } | ||
| 487 | $callback->($_ => 'assetSummaries') foreach (@{ $result->assetSummaries }); | ||
| 488 | } | ||
| 489 | |||
| 490 | return undef | ||
| 491 | } | ||
| 492 | sub ListAllDashboards { | ||
| 493 | my $self = shift; | ||
| 494 | |||
| 495 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 496 | my $result = $self->ListDashboards(@_); | ||
| 497 | my $next_result = $result; | ||
| 498 | |||
| 499 | if (not defined $callback) { | ||
| 500 | while ($next_result->nextToken) { | ||
| 501 | $next_result = $self->ListDashboards(@_, nextToken => $next_result->nextToken); | ||
| 502 | push @{ $result->dashboardSummaries }, @{ $next_result->dashboardSummaries }; | ||
| 503 | } | ||
| 504 | return $result; | ||
| 505 | } else { | ||
| 506 | while ($result->nextToken) { | ||
| 507 | $callback->($_ => 'dashboardSummaries') foreach (@{ $result->dashboardSummaries }); | ||
| 508 | $result = $self->ListDashboards(@_, nextToken => $result->nextToken); | ||
| 509 | } | ||
| 510 | $callback->($_ => 'dashboardSummaries') foreach (@{ $result->dashboardSummaries }); | ||
| 511 | } | ||
| 512 | |||
| 513 | return undef | ||
| 514 | } | ||
| 515 | sub ListAllGateways { | ||
| 516 | my $self = shift; | ||
| 517 | |||
| 518 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 519 | my $result = $self->ListGateways(@_); | ||
| 520 | my $next_result = $result; | ||
| 521 | |||
| 522 | if (not defined $callback) { | ||
| 523 | while ($next_result->nextToken) { | ||
| 524 | $next_result = $self->ListGateways(@_, nextToken => $next_result->nextToken); | ||
| 525 | push @{ $result->gatewaySummaries }, @{ $next_result->gatewaySummaries }; | ||
| 526 | } | ||
| 527 | return $result; | ||
| 528 | } else { | ||
| 529 | while ($result->nextToken) { | ||
| 530 | $callback->($_ => 'gatewaySummaries') foreach (@{ $result->gatewaySummaries }); | ||
| 531 | $result = $self->ListGateways(@_, nextToken => $result->nextToken); | ||
| 532 | } | ||
| 533 | $callback->($_ => 'gatewaySummaries') foreach (@{ $result->gatewaySummaries }); | ||
| 534 | } | ||
| 535 | |||
| 536 | return undef | ||
| 537 | } | ||
| 538 | sub ListAllPortals { | ||
| 539 | my $self = shift; | ||
| 540 | |||
| 541 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 542 | my $result = $self->ListPortals(@_); | ||
| 543 | my $next_result = $result; | ||
| 544 | |||
| 545 | if (not defined $callback) { | ||
| 546 | while ($next_result->nextToken) { | ||
| 547 | $next_result = $self->ListPortals(@_, nextToken => $next_result->nextToken); | ||
| 548 | push @{ $result->portalSummaries }, @{ $next_result->portalSummaries }; | ||
| 549 | } | ||
| 550 | return $result; | ||
| 551 | } else { | ||
| 552 | while ($result->nextToken) { | ||
| 553 | $callback->($_ => 'portalSummaries') foreach (@{ $result->portalSummaries }); | ||
| 554 | $result = $self->ListPortals(@_, nextToken => $result->nextToken); | ||
| 555 | } | ||
| 556 | $callback->($_ => 'portalSummaries') foreach (@{ $result->portalSummaries }); | ||
| 557 | } | ||
| 558 | |||
| 559 | return undef | ||
| 560 | } | ||
| 561 | sub ListAllProjectAssets { | ||
| 562 | my $self = shift; | ||
| 563 | |||
| 564 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 565 | my $result = $self->ListProjectAssets(@_); | ||
| 566 | my $next_result = $result; | ||
| 567 | |||
| 568 | if (not defined $callback) { | ||
| 569 | while ($next_result->nextToken) { | ||
| 570 | $next_result = $self->ListProjectAssets(@_, nextToken => $next_result->nextToken); | ||
| 571 | push @{ $result->assetIds }, @{ $next_result->assetIds }; | ||
| 572 | } | ||
| 573 | return $result; | ||
| 574 | } else { | ||
| 575 | while ($result->nextToken) { | ||
| 576 | $callback->($_ => 'assetIds') foreach (@{ $result->assetIds }); | ||
| 577 | $result = $self->ListProjectAssets(@_, nextToken => $result->nextToken); | ||
| 578 | } | ||
| 579 | $callback->($_ => 'assetIds') foreach (@{ $result->assetIds }); | ||
| 580 | } | ||
| 581 | |||
| 582 | return undef | ||
| 583 | } | ||
| 584 | sub ListAllProjects { | ||
| 585 | my $self = shift; | ||
| 586 | |||
| 587 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 588 | my $result = $self->ListProjects(@_); | ||
| 589 | my $next_result = $result; | ||
| 590 | |||
| 591 | if (not defined $callback) { | ||
| 592 | while ($next_result->nextToken) { | ||
| 593 | $next_result = $self->ListProjects(@_, nextToken => $next_result->nextToken); | ||
| 594 | push @{ $result->projectSummaries }, @{ $next_result->projectSummaries }; | ||
| 595 | } | ||
| 596 | return $result; | ||
| 597 | } else { | ||
| 598 | while ($result->nextToken) { | ||
| 599 | $callback->($_ => 'projectSummaries') foreach (@{ $result->projectSummaries }); | ||
| 600 | $result = $self->ListProjects(@_, nextToken => $result->nextToken); | ||
| 601 | } | ||
| 602 | $callback->($_ => 'projectSummaries') foreach (@{ $result->projectSummaries }); | ||
| 603 | } | ||
| 604 | |||
| 605 | return undef | ||
| 606 | } | ||
| 607 | |||
| 608 | |||
| 609 | sub operations { qw/AssociateAssets BatchAssociateProjectAssets BatchDisassociateProjectAssets BatchPutAssetPropertyValue CreateAccessPolicy CreateAsset CreateAssetModel CreateDashboard CreateGateway CreatePortal CreateProject DeleteAccessPolicy DeleteAsset DeleteAssetModel DeleteDashboard DeleteGateway DeletePortal DeleteProject DescribeAccessPolicy DescribeAsset DescribeAssetModel DescribeAssetProperty DescribeDashboard DescribeDefaultEncryptionConfiguration DescribeGateway DescribeGatewayCapabilityConfiguration DescribeLoggingOptions DescribePortal DescribeProject DisassociateAssets GetAssetPropertyAggregates GetAssetPropertyValue GetAssetPropertyValueHistory GetInterpolatedAssetPropertyValues ListAccessPolicies ListAssetModels ListAssetRelationships ListAssets ListAssociatedAssets ListDashboards ListGateways ListPortals ListProjectAssets ListProjects ListTagsForResource PutDefaultEncryptionConfiguration PutLoggingOptions TagResource UntagResource UpdateAccessPolicy UpdateAsset UpdateAssetModel UpdateAssetProperty UpdateDashboard UpdateGateway UpdateGatewayCapabilityConfiguration UpdatePortal UpdateProject / } | ||
| 610 | |||
| 611 | 1; | ||
| 612 | |||
| 613 | ### main pod documentation begin ### | ||
| 614 | |||
| 615 | =head1 NAME | ||
| 616 | |||
| 617 | Paws::IoTSiteWise - Perl Interface to AWS AWS IoT SiteWise | ||
| 618 | |||
| 619 | =head1 SYNOPSIS | ||
| 620 | |||
| 621 | use Paws; | ||
| 622 | |||
| 623 | my $obj = Paws->service('IoTSiteWise'); | ||
| 624 | my $res = $obj->Method( | ||
| 625 | Arg1 => $val1, | ||
| 626 | Arg2 => [ 'V1', 'V2' ], | ||
| 627 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 628 | # of the arguments type | ||
| 629 | Arg3 => { Att1 => 'Val1' }, | ||
| 630 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 631 | # the constructor of the arguments type | ||
| 632 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 633 | ); | ||
| 634 | |||
| 635 | =head1 DESCRIPTION | ||
| 636 | |||
| 637 | Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an | ||
| 638 | AWS service that connects Industrial Internet of Things (IIoT) | ||
| 639 | (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) | ||
| 640 | devices to the power of the AWS Cloud. For more information, see the | ||
| 641 | AWS IoT SiteWise User Guide | ||
| 642 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For | ||
| 643 | information about AWS IoT SiteWise quotas, see Quotas | ||
| 644 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) | ||
| 645 | in the I<AWS IoT SiteWise User Guide>. | ||
| 646 | |||
| 647 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02> | ||
| 648 | |||
| 649 | |||
| 650 | =head1 METHODS | ||
| 651 | |||
| 652 | =head2 AssociateAssets | ||
| 653 | |||
| 654 | =over | ||
| 655 | |||
| 656 | =item AssetId => Str | ||
| 657 | |||
| 658 | =item ChildAssetId => Str | ||
| 659 | |||
| 660 | =item HierarchyId => Str | ||
| 661 | |||
| 662 | =item [ClientToken => Str] | ||
| 663 | |||
| 664 | |||
| 665 | =back | ||
| 666 | |||
| 667 | Each argument is described in detail in: L<Paws::IoTSiteWise::AssociateAssets> | ||
| 668 | |||
| 669 | Returns: nothing | ||
| 670 | |||
| 671 | Associates a child asset with the given parent asset through a | ||
| 672 | hierarchy defined in the parent asset's model. For more information, | ||
| 673 | see Associating assets | ||
| 674 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) | ||
| 675 | in the I<AWS IoT SiteWise User Guide>. | ||
| 676 | |||
| 677 | |||
| 678 | =head2 BatchAssociateProjectAssets | ||
| 679 | |||
| 680 | =over | ||
| 681 | |||
| 682 | =item AssetIds => ArrayRef[Str|Undef] | ||
| 683 | |||
| 684 | =item ProjectId => Str | ||
| 685 | |||
| 686 | =item [ClientToken => Str] | ||
| 687 | |||
| 688 | |||
| 689 | =back | ||
| 690 | |||
| 691 | Each argument is described in detail in: L<Paws::IoTSiteWise::BatchAssociateProjectAssets> | ||
| 692 | |||
| 693 | Returns: a L<Paws::IoTSiteWise::BatchAssociateProjectAssetsResponse> instance | ||
| 694 | |||
| 695 | Associates a group (batch) of assets with an AWS IoT SiteWise Monitor | ||
| 696 | project. | ||
| 697 | |||
| 698 | |||
| 699 | =head2 BatchDisassociateProjectAssets | ||
| 700 | |||
| 701 | =over | ||
| 702 | |||
| 703 | =item AssetIds => ArrayRef[Str|Undef] | ||
| 704 | |||
| 705 | =item ProjectId => Str | ||
| 706 | |||
| 707 | =item [ClientToken => Str] | ||
| 708 | |||
| 709 | |||
| 710 | =back | ||
| 711 | |||
| 712 | Each argument is described in detail in: L<Paws::IoTSiteWise::BatchDisassociateProjectAssets> | ||
| 713 | |||
| 714 | Returns: a L<Paws::IoTSiteWise::BatchDisassociateProjectAssetsResponse> instance | ||
| 715 | |||
| 716 | Disassociates a group (batch) of assets from an AWS IoT SiteWise | ||
| 717 | Monitor project. | ||
| 718 | |||
| 719 | |||
| 720 | =head2 BatchPutAssetPropertyValue | ||
| 721 | |||
| 722 | =over | ||
| 723 | |||
| 724 | =item Entries => ArrayRef[L<Paws::IoTSiteWise::PutAssetPropertyValueEntry>] | ||
| 725 | |||
| 726 | |||
| 727 | =back | ||
| 728 | |||
| 729 | Each argument is described in detail in: L<Paws::IoTSiteWise::BatchPutAssetPropertyValue> | ||
| 730 | |||
| 731 | Returns: a L<Paws::IoTSiteWise::BatchPutAssetPropertyValueResponse> instance | ||
| 732 | |||
| 733 | Sends a list of asset property values to AWS IoT SiteWise. Each value | ||
| 734 | is a timestamp-quality-value (TQV) data point. For more information, | ||
| 735 | see Ingesting data using the API | ||
| 736 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) | ||
| 737 | in the I<AWS IoT SiteWise User Guide>. | ||
| 738 | |||
| 739 | To identify an asset property, you must specify one of the following: | ||
| 740 | |||
| 741 | =over | ||
| 742 | |||
| 743 | =item * | ||
| 744 | |||
| 745 | The C<assetId> and C<propertyId> of an asset property. | ||
| 746 | |||
| 747 | =item * | ||
| 748 | |||
| 749 | A C<propertyAlias>, which is a data stream alias (for example, | ||
| 750 | C</company/windfarm/3/turbine/7/temperature>). To define an asset | ||
| 751 | property's alias, see UpdateAssetProperty | ||
| 752 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 753 | |||
| 754 | =back | ||
| 755 | |||
| 756 | With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs | ||
| 757 | that have a timestamp of no more than 7 days in the past and no more | ||
| 758 | than 10 minutes in the future. AWS IoT SiteWise rejects timestamps | ||
| 759 | outside of the inclusive range of [-7 days, +10 minutes] and returns a | ||
| 760 | C<TimestampOutOfRangeException> error. | ||
| 761 | |||
| 762 | For each asset property, AWS IoT SiteWise overwrites TQVs with | ||
| 763 | duplicate timestamps unless the newer TQV has a different quality. For | ||
| 764 | example, if you store a TQV C<{T1, GOOD, V1}>, then storing C<{T1, | ||
| 765 | GOOD, V2}> replaces the existing TQV. | ||
| 766 | |||
| 767 | AWS IoT SiteWise authorizes access to each | ||
| 768 | C<BatchPutAssetPropertyValue> entry individually. For more information, | ||
| 769 | see BatchPutAssetPropertyValue authorization | ||
| 770 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) | ||
| 771 | in the I<AWS IoT SiteWise User Guide>. | ||
| 772 | |||
| 773 | |||
| 774 | =head2 CreateAccessPolicy | ||
| 775 | |||
| 776 | =over | ||
| 777 | |||
| 778 | =item AccessPolicyIdentity => L<Paws::IoTSiteWise::Identity> | ||
| 779 | |||
| 780 | =item AccessPolicyPermission => Str | ||
| 781 | |||
| 782 | =item AccessPolicyResource => L<Paws::IoTSiteWise::Resource> | ||
| 783 | |||
| 784 | =item [ClientToken => Str] | ||
| 785 | |||
| 786 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 787 | |||
| 788 | |||
| 789 | =back | ||
| 790 | |||
| 791 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateAccessPolicy> | ||
| 792 | |||
| 793 | Returns: a L<Paws::IoTSiteWise::CreateAccessPolicyResponse> instance | ||
| 794 | |||
| 795 | Creates an access policy that grants the specified identity (AWS SSO | ||
| 796 | user, AWS SSO group, or IAM user) access to the specified AWS IoT | ||
| 797 | SiteWise Monitor portal or project resource. | ||
| 798 | |||
| 799 | |||
| 800 | =head2 CreateAsset | ||
| 801 | |||
| 802 | =over | ||
| 803 | |||
| 804 | =item AssetModelId => Str | ||
| 805 | |||
| 806 | =item AssetName => Str | ||
| 807 | |||
| 808 | =item [ClientToken => Str] | ||
| 809 | |||
| 810 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 811 | |||
| 812 | |||
| 813 | =back | ||
| 814 | |||
| 815 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateAsset> | ||
| 816 | |||
| 817 | Returns: a L<Paws::IoTSiteWise::CreateAssetResponse> instance | ||
| 818 | |||
| 819 | Creates an asset from an existing asset model. For more information, | ||
| 820 | see Creating assets | ||
| 821 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) | ||
| 822 | in the I<AWS IoT SiteWise User Guide>. | ||
| 823 | |||
| 824 | |||
| 825 | =head2 CreateAssetModel | ||
| 826 | |||
| 827 | =over | ||
| 828 | |||
| 829 | =item AssetModelName => Str | ||
| 830 | |||
| 831 | =item [AssetModelCompositeModels => ArrayRef[L<Paws::IoTSiteWise::AssetModelCompositeModelDefinition>]] | ||
| 832 | |||
| 833 | =item [AssetModelDescription => Str] | ||
| 834 | |||
| 835 | =item [AssetModelHierarchies => ArrayRef[L<Paws::IoTSiteWise::AssetModelHierarchyDefinition>]] | ||
| 836 | |||
| 837 | =item [AssetModelProperties => ArrayRef[L<Paws::IoTSiteWise::AssetModelPropertyDefinition>]] | ||
| 838 | |||
| 839 | =item [ClientToken => Str] | ||
| 840 | |||
| 841 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 842 | |||
| 843 | |||
| 844 | =back | ||
| 845 | |||
| 846 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateAssetModel> | ||
| 847 | |||
| 848 | Returns: a L<Paws::IoTSiteWise::CreateAssetModelResponse> instance | ||
| 849 | |||
| 850 | Creates an asset model from specified property and hierarchy | ||
| 851 | definitions. You create assets from asset models. With asset models, | ||
| 852 | you can easily create assets of the same type that have standardized | ||
| 853 | definitions. Each asset created from a model inherits the asset model's | ||
| 854 | property and hierarchy definitions. For more information, see Defining | ||
| 855 | asset models | ||
| 856 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) | ||
| 857 | in the I<AWS IoT SiteWise User Guide>. | ||
| 858 | |||
| 859 | |||
| 860 | =head2 CreateDashboard | ||
| 861 | |||
| 862 | =over | ||
| 863 | |||
| 864 | =item DashboardDefinition => Str | ||
| 865 | |||
| 866 | =item DashboardName => Str | ||
| 867 | |||
| 868 | =item ProjectId => Str | ||
| 869 | |||
| 870 | =item [ClientToken => Str] | ||
| 871 | |||
| 872 | =item [DashboardDescription => Str] | ||
| 873 | |||
| 874 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 875 | |||
| 876 | |||
| 877 | =back | ||
| 878 | |||
| 879 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateDashboard> | ||
| 880 | |||
| 881 | Returns: a L<Paws::IoTSiteWise::CreateDashboardResponse> instance | ||
| 882 | |||
| 883 | Creates a dashboard in an AWS IoT SiteWise Monitor project. | ||
| 884 | |||
| 885 | |||
| 886 | =head2 CreateGateway | ||
| 887 | |||
| 888 | =over | ||
| 889 | |||
| 890 | =item GatewayName => Str | ||
| 891 | |||
| 892 | =item GatewayPlatform => L<Paws::IoTSiteWise::GatewayPlatform> | ||
| 893 | |||
| 894 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 895 | |||
| 896 | |||
| 897 | =back | ||
| 898 | |||
| 899 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateGateway> | ||
| 900 | |||
| 901 | Returns: a L<Paws::IoTSiteWise::CreateGatewayResponse> instance | ||
| 902 | |||
| 903 | Creates a gateway, which is a virtual or edge device that delivers | ||
| 904 | industrial data streams from local servers to AWS IoT SiteWise. For | ||
| 905 | more information, see Ingesting data using a gateway | ||
| 906 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) | ||
| 907 | in the I<AWS IoT SiteWise User Guide>. | ||
| 908 | |||
| 909 | |||
| 910 | =head2 CreatePortal | ||
| 911 | |||
| 912 | =over | ||
| 913 | |||
| 914 | =item PortalContactEmail => Str | ||
| 915 | |||
| 916 | =item PortalName => Str | ||
| 917 | |||
| 918 | =item RoleArn => Str | ||
| 919 | |||
| 920 | =item [Alarms => L<Paws::IoTSiteWise::Alarms>] | ||
| 921 | |||
| 922 | =item [ClientToken => Str] | ||
| 923 | |||
| 924 | =item [NotificationSenderEmail => Str] | ||
| 925 | |||
| 926 | =item [PortalAuthMode => Str] | ||
| 927 | |||
| 928 | =item [PortalDescription => Str] | ||
| 929 | |||
| 930 | =item [PortalLogoImageFile => L<Paws::IoTSiteWise::ImageFile>] | ||
| 931 | |||
| 932 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 933 | |||
| 934 | |||
| 935 | =back | ||
| 936 | |||
| 937 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreatePortal> | ||
| 938 | |||
| 939 | Returns: a L<Paws::IoTSiteWise::CreatePortalResponse> instance | ||
| 940 | |||
| 941 | Creates a portal, which can contain projects and dashboards. AWS IoT | ||
| 942 | SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and | ||
| 943 | manage user permissions. | ||
| 944 | |||
| 945 | Before you can sign in to a new portal, you must add at least one | ||
| 946 | identity to that portal. For more information, see Adding or removing | ||
| 947 | portal administrators | ||
| 948 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) | ||
| 949 | in the I<AWS IoT SiteWise User Guide>. | ||
| 950 | |||
| 951 | |||
| 952 | =head2 CreateProject | ||
| 953 | |||
| 954 | =over | ||
| 955 | |||
| 956 | =item PortalId => Str | ||
| 957 | |||
| 958 | =item ProjectName => Str | ||
| 959 | |||
| 960 | =item [ClientToken => Str] | ||
| 961 | |||
| 962 | =item [ProjectDescription => Str] | ||
| 963 | |||
| 964 | =item [Tags => L<Paws::IoTSiteWise::TagMap>] | ||
| 965 | |||
| 966 | |||
| 967 | =back | ||
| 968 | |||
| 969 | Each argument is described in detail in: L<Paws::IoTSiteWise::CreateProject> | ||
| 970 | |||
| 971 | Returns: a L<Paws::IoTSiteWise::CreateProjectResponse> instance | ||
| 972 | |||
| 973 | Creates a project in the specified portal. | ||
| 974 | |||
| 975 | |||
| 976 | =head2 DeleteAccessPolicy | ||
| 977 | |||
| 978 | =over | ||
| 979 | |||
| 980 | =item AccessPolicyId => Str | ||
| 981 | |||
| 982 | =item [ClientToken => Str] | ||
| 983 | |||
| 984 | |||
| 985 | =back | ||
| 986 | |||
| 987 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteAccessPolicy> | ||
| 988 | |||
| 989 | Returns: a L<Paws::IoTSiteWise::DeleteAccessPolicyResponse> instance | ||
| 990 | |||
| 991 | Deletes an access policy that grants the specified identity access to | ||
| 992 | the specified AWS IoT SiteWise Monitor resource. You can use this | ||
| 993 | operation to revoke access to an AWS IoT SiteWise Monitor resource. | ||
| 994 | |||
| 995 | |||
| 996 | =head2 DeleteAsset | ||
| 997 | |||
| 998 | =over | ||
| 999 | |||
| 1000 | =item AssetId => Str | ||
| 1001 | |||
| 1002 | =item [ClientToken => Str] | ||
| 1003 | |||
| 1004 | |||
| 1005 | =back | ||
| 1006 | |||
| 1007 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteAsset> | ||
| 1008 | |||
| 1009 | Returns: a L<Paws::IoTSiteWise::DeleteAssetResponse> instance | ||
| 1010 | |||
| 1011 | Deletes an asset. This action can't be undone. For more information, | ||
| 1012 | see Deleting assets and models | ||
| 1013 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) | ||
| 1014 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1015 | |||
| 1016 | You can't delete an asset that's associated to another asset. For more | ||
| 1017 | information, see DisassociateAssets | ||
| 1018 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html). | ||
| 1019 | |||
| 1020 | |||
| 1021 | =head2 DeleteAssetModel | ||
| 1022 | |||
| 1023 | =over | ||
| 1024 | |||
| 1025 | =item AssetModelId => Str | ||
| 1026 | |||
| 1027 | =item [ClientToken => Str] | ||
| 1028 | |||
| 1029 | |||
| 1030 | =back | ||
| 1031 | |||
| 1032 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteAssetModel> | ||
| 1033 | |||
| 1034 | Returns: a L<Paws::IoTSiteWise::DeleteAssetModelResponse> instance | ||
| 1035 | |||
| 1036 | Deletes an asset model. This action can't be undone. You must delete | ||
| 1037 | all assets created from an asset model before you can delete the model. | ||
| 1038 | Also, you can't delete an asset model if a parent asset model exists | ||
| 1039 | that contains a property formula expression that depends on the asset | ||
| 1040 | model that you want to delete. For more information, see Deleting | ||
| 1041 | assets and models | ||
| 1042 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) | ||
| 1043 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1044 | |||
| 1045 | |||
| 1046 | =head2 DeleteDashboard | ||
| 1047 | |||
| 1048 | =over | ||
| 1049 | |||
| 1050 | =item DashboardId => Str | ||
| 1051 | |||
| 1052 | =item [ClientToken => Str] | ||
| 1053 | |||
| 1054 | |||
| 1055 | =back | ||
| 1056 | |||
| 1057 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteDashboard> | ||
| 1058 | |||
| 1059 | Returns: a L<Paws::IoTSiteWise::DeleteDashboardResponse> instance | ||
| 1060 | |||
| 1061 | Deletes a dashboard from AWS IoT SiteWise Monitor. | ||
| 1062 | |||
| 1063 | |||
| 1064 | =head2 DeleteGateway | ||
| 1065 | |||
| 1066 | =over | ||
| 1067 | |||
| 1068 | =item GatewayId => Str | ||
| 1069 | |||
| 1070 | |||
| 1071 | =back | ||
| 1072 | |||
| 1073 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteGateway> | ||
| 1074 | |||
| 1075 | Returns: nothing | ||
| 1076 | |||
| 1077 | Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, | ||
| 1078 | some of the gateway's files remain in your gateway's file system. | ||
| 1079 | |||
| 1080 | |||
| 1081 | =head2 DeletePortal | ||
| 1082 | |||
| 1083 | =over | ||
| 1084 | |||
| 1085 | =item PortalId => Str | ||
| 1086 | |||
| 1087 | =item [ClientToken => Str] | ||
| 1088 | |||
| 1089 | |||
| 1090 | =back | ||
| 1091 | |||
| 1092 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeletePortal> | ||
| 1093 | |||
| 1094 | Returns: a L<Paws::IoTSiteWise::DeletePortalResponse> instance | ||
| 1095 | |||
| 1096 | Deletes a portal from AWS IoT SiteWise Monitor. | ||
| 1097 | |||
| 1098 | |||
| 1099 | =head2 DeleteProject | ||
| 1100 | |||
| 1101 | =over | ||
| 1102 | |||
| 1103 | =item ProjectId => Str | ||
| 1104 | |||
| 1105 | =item [ClientToken => Str] | ||
| 1106 | |||
| 1107 | |||
| 1108 | =back | ||
| 1109 | |||
| 1110 | Each argument is described in detail in: L<Paws::IoTSiteWise::DeleteProject> | ||
| 1111 | |||
| 1112 | Returns: a L<Paws::IoTSiteWise::DeleteProjectResponse> instance | ||
| 1113 | |||
| 1114 | Deletes a project from AWS IoT SiteWise Monitor. | ||
| 1115 | |||
| 1116 | |||
| 1117 | =head2 DescribeAccessPolicy | ||
| 1118 | |||
| 1119 | =over | ||
| 1120 | |||
| 1121 | =item AccessPolicyId => Str | ||
| 1122 | |||
| 1123 | |||
| 1124 | =back | ||
| 1125 | |||
| 1126 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeAccessPolicy> | ||
| 1127 | |||
| 1128 | Returns: a L<Paws::IoTSiteWise::DescribeAccessPolicyResponse> instance | ||
| 1129 | |||
| 1130 | Describes an access policy, which specifies an identity's access to an | ||
| 1131 | AWS IoT SiteWise Monitor portal or project. | ||
| 1132 | |||
| 1133 | |||
| 1134 | =head2 DescribeAsset | ||
| 1135 | |||
| 1136 | =over | ||
| 1137 | |||
| 1138 | =item AssetId => Str | ||
| 1139 | |||
| 1140 | |||
| 1141 | =back | ||
| 1142 | |||
| 1143 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeAsset> | ||
| 1144 | |||
| 1145 | Returns: a L<Paws::IoTSiteWise::DescribeAssetResponse> instance | ||
| 1146 | |||
| 1147 | Retrieves information about an asset. | ||
| 1148 | |||
| 1149 | |||
| 1150 | =head2 DescribeAssetModel | ||
| 1151 | |||
| 1152 | =over | ||
| 1153 | |||
| 1154 | =item AssetModelId => Str | ||
| 1155 | |||
| 1156 | |||
| 1157 | =back | ||
| 1158 | |||
| 1159 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeAssetModel> | ||
| 1160 | |||
| 1161 | Returns: a L<Paws::IoTSiteWise::DescribeAssetModelResponse> instance | ||
| 1162 | |||
| 1163 | Retrieves information about an asset model. | ||
| 1164 | |||
| 1165 | |||
| 1166 | =head2 DescribeAssetProperty | ||
| 1167 | |||
| 1168 | =over | ||
| 1169 | |||
| 1170 | =item AssetId => Str | ||
| 1171 | |||
| 1172 | =item PropertyId => Str | ||
| 1173 | |||
| 1174 | |||
| 1175 | =back | ||
| 1176 | |||
| 1177 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeAssetProperty> | ||
| 1178 | |||
| 1179 | Returns: a L<Paws::IoTSiteWise::DescribeAssetPropertyResponse> instance | ||
| 1180 | |||
| 1181 | Retrieves information about an asset property. | ||
| 1182 | |||
| 1183 | When you call this operation for an attribute property, this response | ||
| 1184 | includes the default attribute value that you define in the asset | ||
| 1185 | model. If you update the default value in the model, this operation's | ||
| 1186 | response includes the new default value. | ||
| 1187 | |||
| 1188 | This operation doesn't return the value of the asset property. To get | ||
| 1189 | the value of an asset property, use GetAssetPropertyValue | ||
| 1190 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html). | ||
| 1191 | |||
| 1192 | |||
| 1193 | =head2 DescribeDashboard | ||
| 1194 | |||
| 1195 | =over | ||
| 1196 | |||
| 1197 | =item DashboardId => Str | ||
| 1198 | |||
| 1199 | |||
| 1200 | =back | ||
| 1201 | |||
| 1202 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeDashboard> | ||
| 1203 | |||
| 1204 | Returns: a L<Paws::IoTSiteWise::DescribeDashboardResponse> instance | ||
| 1205 | |||
| 1206 | Retrieves information about a dashboard. | ||
| 1207 | |||
| 1208 | |||
| 1209 | =head2 DescribeDefaultEncryptionConfiguration | ||
| 1210 | |||
| 1211 | |||
| 1212 | |||
| 1213 | |||
| 1214 | |||
| 1215 | |||
| 1216 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeDefaultEncryptionConfiguration> | ||
| 1217 | |||
| 1218 | Returns: a L<Paws::IoTSiteWise::DescribeDefaultEncryptionConfigurationResponse> instance | ||
| 1219 | |||
| 1220 | Retrieves information about the default encryption configuration for | ||
| 1221 | the AWS account in the default or specified region. For more | ||
| 1222 | information, see Key management | ||
| 1223 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) | ||
| 1224 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1225 | |||
| 1226 | |||
| 1227 | =head2 DescribeGateway | ||
| 1228 | |||
| 1229 | =over | ||
| 1230 | |||
| 1231 | =item GatewayId => Str | ||
| 1232 | |||
| 1233 | |||
| 1234 | =back | ||
| 1235 | |||
| 1236 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeGateway> | ||
| 1237 | |||
| 1238 | Returns: a L<Paws::IoTSiteWise::DescribeGatewayResponse> instance | ||
| 1239 | |||
| 1240 | Retrieves information about a gateway. | ||
| 1241 | |||
| 1242 | |||
| 1243 | =head2 DescribeGatewayCapabilityConfiguration | ||
| 1244 | |||
| 1245 | =over | ||
| 1246 | |||
| 1247 | =item CapabilityNamespace => Str | ||
| 1248 | |||
| 1249 | =item GatewayId => Str | ||
| 1250 | |||
| 1251 | |||
| 1252 | =back | ||
| 1253 | |||
| 1254 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeGatewayCapabilityConfiguration> | ||
| 1255 | |||
| 1256 | Returns: a L<Paws::IoTSiteWise::DescribeGatewayCapabilityConfigurationResponse> instance | ||
| 1257 | |||
| 1258 | Retrieves information about a gateway capability configuration. Each | ||
| 1259 | gateway capability defines data sources for a gateway. A capability | ||
| 1260 | configuration can contain multiple data source configurations. If you | ||
| 1261 | define OPC-UA sources for a gateway in the AWS IoT SiteWise console, | ||
| 1262 | all of your OPC-UA sources are stored in one capability configuration. | ||
| 1263 | To list all capability configurations for a gateway, use | ||
| 1264 | DescribeGateway | ||
| 1265 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html). | ||
| 1266 | |||
| 1267 | |||
| 1268 | =head2 DescribeLoggingOptions | ||
| 1269 | |||
| 1270 | |||
| 1271 | |||
| 1272 | |||
| 1273 | |||
| 1274 | |||
| 1275 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeLoggingOptions> | ||
| 1276 | |||
| 1277 | Returns: a L<Paws::IoTSiteWise::DescribeLoggingOptionsResponse> instance | ||
| 1278 | |||
| 1279 | Retrieves the current AWS IoT SiteWise logging options. | ||
| 1280 | |||
| 1281 | |||
| 1282 | =head2 DescribePortal | ||
| 1283 | |||
| 1284 | =over | ||
| 1285 | |||
| 1286 | =item PortalId => Str | ||
| 1287 | |||
| 1288 | |||
| 1289 | =back | ||
| 1290 | |||
| 1291 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribePortal> | ||
| 1292 | |||
| 1293 | Returns: a L<Paws::IoTSiteWise::DescribePortalResponse> instance | ||
| 1294 | |||
| 1295 | Retrieves information about a portal. | ||
| 1296 | |||
| 1297 | |||
| 1298 | =head2 DescribeProject | ||
| 1299 | |||
| 1300 | =over | ||
| 1301 | |||
| 1302 | =item ProjectId => Str | ||
| 1303 | |||
| 1304 | |||
| 1305 | =back | ||
| 1306 | |||
| 1307 | Each argument is described in detail in: L<Paws::IoTSiteWise::DescribeProject> | ||
| 1308 | |||
| 1309 | Returns: a L<Paws::IoTSiteWise::DescribeProjectResponse> instance | ||
| 1310 | |||
| 1311 | Retrieves information about a project. | ||
| 1312 | |||
| 1313 | |||
| 1314 | =head2 DisassociateAssets | ||
| 1315 | |||
| 1316 | =over | ||
| 1317 | |||
| 1318 | =item AssetId => Str | ||
| 1319 | |||
| 1320 | =item ChildAssetId => Str | ||
| 1321 | |||
| 1322 | =item HierarchyId => Str | ||
| 1323 | |||
| 1324 | =item [ClientToken => Str] | ||
| 1325 | |||
| 1326 | |||
| 1327 | =back | ||
| 1328 | |||
| 1329 | Each argument is described in detail in: L<Paws::IoTSiteWise::DisassociateAssets> | ||
| 1330 | |||
| 1331 | Returns: nothing | ||
| 1332 | |||
| 1333 | Disassociates a child asset from the given parent asset through a | ||
| 1334 | hierarchy defined in the parent asset's model. | ||
| 1335 | |||
| 1336 | |||
| 1337 | =head2 GetAssetPropertyAggregates | ||
| 1338 | |||
| 1339 | =over | ||
| 1340 | |||
| 1341 | =item AggregateTypes => ArrayRef[Str|Undef] | ||
| 1342 | |||
| 1343 | =item EndDate => Str | ||
| 1344 | |||
| 1345 | =item Resolution => Str | ||
| 1346 | |||
| 1347 | =item StartDate => Str | ||
| 1348 | |||
| 1349 | =item [AssetId => Str] | ||
| 1350 | |||
| 1351 | =item [MaxResults => Int] | ||
| 1352 | |||
| 1353 | =item [NextToken => Str] | ||
| 1354 | |||
| 1355 | =item [PropertyAlias => Str] | ||
| 1356 | |||
| 1357 | =item [PropertyId => Str] | ||
| 1358 | |||
| 1359 | =item [Qualities => ArrayRef[Str|Undef]] | ||
| 1360 | |||
| 1361 | =item [TimeOrdering => Str] | ||
| 1362 | |||
| 1363 | |||
| 1364 | =back | ||
| 1365 | |||
| 1366 | Each argument is described in detail in: L<Paws::IoTSiteWise::GetAssetPropertyAggregates> | ||
| 1367 | |||
| 1368 | Returns: a L<Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse> instance | ||
| 1369 | |||
| 1370 | Gets aggregated values for an asset property. For more information, see | ||
| 1371 | Querying aggregates | ||
| 1372 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) | ||
| 1373 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1374 | |||
| 1375 | To identify an asset property, you must specify one of the following: | ||
| 1376 | |||
| 1377 | =over | ||
| 1378 | |||
| 1379 | =item * | ||
| 1380 | |||
| 1381 | The C<assetId> and C<propertyId> of an asset property. | ||
| 1382 | |||
| 1383 | =item * | ||
| 1384 | |||
| 1385 | A C<propertyAlias>, which is a data stream alias (for example, | ||
| 1386 | C</company/windfarm/3/turbine/7/temperature>). To define an asset | ||
| 1387 | property's alias, see UpdateAssetProperty | ||
| 1388 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 1389 | |||
| 1390 | =back | ||
| 1391 | |||
| 1392 | |||
| 1393 | |||
| 1394 | =head2 GetAssetPropertyValue | ||
| 1395 | |||
| 1396 | =over | ||
| 1397 | |||
| 1398 | =item [AssetId => Str] | ||
| 1399 | |||
| 1400 | =item [PropertyAlias => Str] | ||
| 1401 | |||
| 1402 | =item [PropertyId => Str] | ||
| 1403 | |||
| 1404 | |||
| 1405 | =back | ||
| 1406 | |||
| 1407 | Each argument is described in detail in: L<Paws::IoTSiteWise::GetAssetPropertyValue> | ||
| 1408 | |||
| 1409 | Returns: a L<Paws::IoTSiteWise::GetAssetPropertyValueResponse> instance | ||
| 1410 | |||
| 1411 | Gets an asset property's current value. For more information, see | ||
| 1412 | Querying current values | ||
| 1413 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) | ||
| 1414 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1415 | |||
| 1416 | To identify an asset property, you must specify one of the following: | ||
| 1417 | |||
| 1418 | =over | ||
| 1419 | |||
| 1420 | =item * | ||
| 1421 | |||
| 1422 | The C<assetId> and C<propertyId> of an asset property. | ||
| 1423 | |||
| 1424 | =item * | ||
| 1425 | |||
| 1426 | A C<propertyAlias>, which is a data stream alias (for example, | ||
| 1427 | C</company/windfarm/3/turbine/7/temperature>). To define an asset | ||
| 1428 | property's alias, see UpdateAssetProperty | ||
| 1429 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 1430 | |||
| 1431 | =back | ||
| 1432 | |||
| 1433 | |||
| 1434 | |||
| 1435 | =head2 GetAssetPropertyValueHistory | ||
| 1436 | |||
| 1437 | =over | ||
| 1438 | |||
| 1439 | =item [AssetId => Str] | ||
| 1440 | |||
| 1441 | =item [EndDate => Str] | ||
| 1442 | |||
| 1443 | =item [MaxResults => Int] | ||
| 1444 | |||
| 1445 | =item [NextToken => Str] | ||
| 1446 | |||
| 1447 | =item [PropertyAlias => Str] | ||
| 1448 | |||
| 1449 | =item [PropertyId => Str] | ||
| 1450 | |||
| 1451 | =item [Qualities => ArrayRef[Str|Undef]] | ||
| 1452 | |||
| 1453 | =item [StartDate => Str] | ||
| 1454 | |||
| 1455 | =item [TimeOrdering => Str] | ||
| 1456 | |||
| 1457 | |||
| 1458 | =back | ||
| 1459 | |||
| 1460 | Each argument is described in detail in: L<Paws::IoTSiteWise::GetAssetPropertyValueHistory> | ||
| 1461 | |||
| 1462 | Returns: a L<Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse> instance | ||
| 1463 | |||
| 1464 | Gets the history of an asset property's values. For more information, | ||
| 1465 | see Querying historical values | ||
| 1466 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) | ||
| 1467 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1468 | |||
| 1469 | To identify an asset property, you must specify one of the following: | ||
| 1470 | |||
| 1471 | =over | ||
| 1472 | |||
| 1473 | =item * | ||
| 1474 | |||
| 1475 | The C<assetId> and C<propertyId> of an asset property. | ||
| 1476 | |||
| 1477 | =item * | ||
| 1478 | |||
| 1479 | A C<propertyAlias>, which is a data stream alias (for example, | ||
| 1480 | C</company/windfarm/3/turbine/7/temperature>). To define an asset | ||
| 1481 | property's alias, see UpdateAssetProperty | ||
| 1482 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 1483 | |||
| 1484 | =back | ||
| 1485 | |||
| 1486 | |||
| 1487 | |||
| 1488 | =head2 GetInterpolatedAssetPropertyValues | ||
| 1489 | |||
| 1490 | =over | ||
| 1491 | |||
| 1492 | =item EndTimeInSeconds => Int | ||
| 1493 | |||
| 1494 | =item IntervalInSeconds => Int | ||
| 1495 | |||
| 1496 | =item Quality => Str | ||
| 1497 | |||
| 1498 | =item StartTimeInSeconds => Int | ||
| 1499 | |||
| 1500 | =item Type => Str | ||
| 1501 | |||
| 1502 | =item [AssetId => Str] | ||
| 1503 | |||
| 1504 | =item [EndTimeOffsetInNanos => Int] | ||
| 1505 | |||
| 1506 | =item [MaxResults => Int] | ||
| 1507 | |||
| 1508 | =item [NextToken => Str] | ||
| 1509 | |||
| 1510 | =item [PropertyAlias => Str] | ||
| 1511 | |||
| 1512 | =item [PropertyId => Str] | ||
| 1513 | |||
| 1514 | =item [StartTimeOffsetInNanos => Int] | ||
| 1515 | |||
| 1516 | |||
| 1517 | =back | ||
| 1518 | |||
| 1519 | Each argument is described in detail in: L<Paws::IoTSiteWise::GetInterpolatedAssetPropertyValues> | ||
| 1520 | |||
| 1521 | Returns: a L<Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse> instance | ||
| 1522 | |||
| 1523 | Get interpolated values for an asset property for a specified time | ||
| 1524 | interval, during a period of time. For example, you can use the this | ||
| 1525 | operation to return the interpolated temperature values for a wind | ||
| 1526 | turbine every 24 hours over a duration of 7 days. | ||
| 1527 | |||
| 1528 | This API isn't available in China (Beijing). | ||
| 1529 | |||
| 1530 | To identify an asset property, you must specify one of the following: | ||
| 1531 | |||
| 1532 | =over | ||
| 1533 | |||
| 1534 | =item * | ||
| 1535 | |||
| 1536 | The C<assetId> and C<propertyId> of an asset property. | ||
| 1537 | |||
| 1538 | =item * | ||
| 1539 | |||
| 1540 | A C<propertyAlias>, which is a data stream alias (for example, | ||
| 1541 | C</company/windfarm/3/turbine/7/temperature>). To define an asset | ||
| 1542 | property's alias, see UpdateAssetProperty | ||
| 1543 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 1544 | |||
| 1545 | =back | ||
| 1546 | |||
| 1547 | |||
| 1548 | |||
| 1549 | =head2 ListAccessPolicies | ||
| 1550 | |||
| 1551 | =over | ||
| 1552 | |||
| 1553 | =item [IamArn => Str] | ||
| 1554 | |||
| 1555 | =item [IdentityId => Str] | ||
| 1556 | |||
| 1557 | =item [IdentityType => Str] | ||
| 1558 | |||
| 1559 | =item [MaxResults => Int] | ||
| 1560 | |||
| 1561 | =item [NextToken => Str] | ||
| 1562 | |||
| 1563 | =item [ResourceId => Str] | ||
| 1564 | |||
| 1565 | =item [ResourceType => Str] | ||
| 1566 | |||
| 1567 | |||
| 1568 | =back | ||
| 1569 | |||
| 1570 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListAccessPolicies> | ||
| 1571 | |||
| 1572 | Returns: a L<Paws::IoTSiteWise::ListAccessPoliciesResponse> instance | ||
| 1573 | |||
| 1574 | Retrieves a paginated list of access policies for an identity (an AWS | ||
| 1575 | SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise | ||
| 1576 | Monitor resource (a portal or project). | ||
| 1577 | |||
| 1578 | |||
| 1579 | =head2 ListAssetModels | ||
| 1580 | |||
| 1581 | =over | ||
| 1582 | |||
| 1583 | =item [MaxResults => Int] | ||
| 1584 | |||
| 1585 | =item [NextToken => Str] | ||
| 1586 | |||
| 1587 | |||
| 1588 | =back | ||
| 1589 | |||
| 1590 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListAssetModels> | ||
| 1591 | |||
| 1592 | Returns: a L<Paws::IoTSiteWise::ListAssetModelsResponse> instance | ||
| 1593 | |||
| 1594 | Retrieves a paginated list of summaries of all asset models. | ||
| 1595 | |||
| 1596 | |||
| 1597 | =head2 ListAssetRelationships | ||
| 1598 | |||
| 1599 | =over | ||
| 1600 | |||
| 1601 | =item AssetId => Str | ||
| 1602 | |||
| 1603 | =item TraversalType => Str | ||
| 1604 | |||
| 1605 | =item [MaxResults => Int] | ||
| 1606 | |||
| 1607 | =item [NextToken => Str] | ||
| 1608 | |||
| 1609 | |||
| 1610 | =back | ||
| 1611 | |||
| 1612 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListAssetRelationships> | ||
| 1613 | |||
| 1614 | Returns: a L<Paws::IoTSiteWise::ListAssetRelationshipsResponse> instance | ||
| 1615 | |||
| 1616 | Retrieves a paginated list of asset relationships for an asset. You can | ||
| 1617 | use this operation to identify an asset's root asset and all associated | ||
| 1618 | assets between that asset and its root. | ||
| 1619 | |||
| 1620 | |||
| 1621 | =head2 ListAssets | ||
| 1622 | |||
| 1623 | =over | ||
| 1624 | |||
| 1625 | =item [AssetModelId => Str] | ||
| 1626 | |||
| 1627 | =item [Filter => Str] | ||
| 1628 | |||
| 1629 | =item [MaxResults => Int] | ||
| 1630 | |||
| 1631 | =item [NextToken => Str] | ||
| 1632 | |||
| 1633 | |||
| 1634 | =back | ||
| 1635 | |||
| 1636 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListAssets> | ||
| 1637 | |||
| 1638 | Returns: a L<Paws::IoTSiteWise::ListAssetsResponse> instance | ||
| 1639 | |||
| 1640 | Retrieves a paginated list of asset summaries. | ||
| 1641 | |||
| 1642 | You can use this operation to do the following: | ||
| 1643 | |||
| 1644 | =over | ||
| 1645 | |||
| 1646 | =item * | ||
| 1647 | |||
| 1648 | List assets based on a specific asset model. | ||
| 1649 | |||
| 1650 | =item * | ||
| 1651 | |||
| 1652 | List top-level assets. | ||
| 1653 | |||
| 1654 | =back | ||
| 1655 | |||
| 1656 | You can't use this operation to list all assets. To retrieve summaries | ||
| 1657 | for all of your assets, use ListAssetModels | ||
| 1658 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) | ||
| 1659 | to get all of your asset model IDs. Then, use ListAssets to get all | ||
| 1660 | assets for each asset model. | ||
| 1661 | |||
| 1662 | |||
| 1663 | =head2 ListAssociatedAssets | ||
| 1664 | |||
| 1665 | =over | ||
| 1666 | |||
| 1667 | =item AssetId => Str | ||
| 1668 | |||
| 1669 | =item [HierarchyId => Str] | ||
| 1670 | |||
| 1671 | =item [MaxResults => Int] | ||
| 1672 | |||
| 1673 | =item [NextToken => Str] | ||
| 1674 | |||
| 1675 | =item [TraversalDirection => Str] | ||
| 1676 | |||
| 1677 | |||
| 1678 | =back | ||
| 1679 | |||
| 1680 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListAssociatedAssets> | ||
| 1681 | |||
| 1682 | Returns: a L<Paws::IoTSiteWise::ListAssociatedAssetsResponse> instance | ||
| 1683 | |||
| 1684 | Retrieves a paginated list of associated assets. | ||
| 1685 | |||
| 1686 | You can use this operation to do the following: | ||
| 1687 | |||
| 1688 | =over | ||
| 1689 | |||
| 1690 | =item * | ||
| 1691 | |||
| 1692 | List child assets associated to a parent asset by a hierarchy that you | ||
| 1693 | specify. | ||
| 1694 | |||
| 1695 | =item * | ||
| 1696 | |||
| 1697 | List an asset's parent asset. | ||
| 1698 | |||
| 1699 | =back | ||
| 1700 | |||
| 1701 | |||
| 1702 | |||
| 1703 | =head2 ListDashboards | ||
| 1704 | |||
| 1705 | =over | ||
| 1706 | |||
| 1707 | =item ProjectId => Str | ||
| 1708 | |||
| 1709 | =item [MaxResults => Int] | ||
| 1710 | |||
| 1711 | =item [NextToken => Str] | ||
| 1712 | |||
| 1713 | |||
| 1714 | =back | ||
| 1715 | |||
| 1716 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListDashboards> | ||
| 1717 | |||
| 1718 | Returns: a L<Paws::IoTSiteWise::ListDashboardsResponse> instance | ||
| 1719 | |||
| 1720 | Retrieves a paginated list of dashboards for an AWS IoT SiteWise | ||
| 1721 | Monitor project. | ||
| 1722 | |||
| 1723 | |||
| 1724 | =head2 ListGateways | ||
| 1725 | |||
| 1726 | =over | ||
| 1727 | |||
| 1728 | =item [MaxResults => Int] | ||
| 1729 | |||
| 1730 | =item [NextToken => Str] | ||
| 1731 | |||
| 1732 | |||
| 1733 | =back | ||
| 1734 | |||
| 1735 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListGateways> | ||
| 1736 | |||
| 1737 | Returns: a L<Paws::IoTSiteWise::ListGatewaysResponse> instance | ||
| 1738 | |||
| 1739 | Retrieves a paginated list of gateways. | ||
| 1740 | |||
| 1741 | |||
| 1742 | =head2 ListPortals | ||
| 1743 | |||
| 1744 | =over | ||
| 1745 | |||
| 1746 | =item [MaxResults => Int] | ||
| 1747 | |||
| 1748 | =item [NextToken => Str] | ||
| 1749 | |||
| 1750 | |||
| 1751 | =back | ||
| 1752 | |||
| 1753 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListPortals> | ||
| 1754 | |||
| 1755 | Returns: a L<Paws::IoTSiteWise::ListPortalsResponse> instance | ||
| 1756 | |||
| 1757 | Retrieves a paginated list of AWS IoT SiteWise Monitor portals. | ||
| 1758 | |||
| 1759 | |||
| 1760 | =head2 ListProjectAssets | ||
| 1761 | |||
| 1762 | =over | ||
| 1763 | |||
| 1764 | =item ProjectId => Str | ||
| 1765 | |||
| 1766 | =item [MaxResults => Int] | ||
| 1767 | |||
| 1768 | =item [NextToken => Str] | ||
| 1769 | |||
| 1770 | |||
| 1771 | =back | ||
| 1772 | |||
| 1773 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListProjectAssets> | ||
| 1774 | |||
| 1775 | Returns: a L<Paws::IoTSiteWise::ListProjectAssetsResponse> instance | ||
| 1776 | |||
| 1777 | Retrieves a paginated list of assets associated with an AWS IoT | ||
| 1778 | SiteWise Monitor project. | ||
| 1779 | |||
| 1780 | |||
| 1781 | =head2 ListProjects | ||
| 1782 | |||
| 1783 | =over | ||
| 1784 | |||
| 1785 | =item PortalId => Str | ||
| 1786 | |||
| 1787 | =item [MaxResults => Int] | ||
| 1788 | |||
| 1789 | =item [NextToken => Str] | ||
| 1790 | |||
| 1791 | |||
| 1792 | =back | ||
| 1793 | |||
| 1794 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListProjects> | ||
| 1795 | |||
| 1796 | Returns: a L<Paws::IoTSiteWise::ListProjectsResponse> instance | ||
| 1797 | |||
| 1798 | Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor | ||
| 1799 | portal. | ||
| 1800 | |||
| 1801 | |||
| 1802 | =head2 ListTagsForResource | ||
| 1803 | |||
| 1804 | =over | ||
| 1805 | |||
| 1806 | =item ResourceArn => Str | ||
| 1807 | |||
| 1808 | |||
| 1809 | =back | ||
| 1810 | |||
| 1811 | Each argument is described in detail in: L<Paws::IoTSiteWise::ListTagsForResource> | ||
| 1812 | |||
| 1813 | Returns: a L<Paws::IoTSiteWise::ListTagsForResourceResponse> instance | ||
| 1814 | |||
| 1815 | Retrieves the list of tags for an AWS IoT SiteWise resource. | ||
| 1816 | |||
| 1817 | |||
| 1818 | =head2 PutDefaultEncryptionConfiguration | ||
| 1819 | |||
| 1820 | =over | ||
| 1821 | |||
| 1822 | =item EncryptionType => Str | ||
| 1823 | |||
| 1824 | =item [KmsKeyId => Str] | ||
| 1825 | |||
| 1826 | |||
| 1827 | =back | ||
| 1828 | |||
| 1829 | Each argument is described in detail in: L<Paws::IoTSiteWise::PutDefaultEncryptionConfiguration> | ||
| 1830 | |||
| 1831 | Returns: a L<Paws::IoTSiteWise::PutDefaultEncryptionConfigurationResponse> instance | ||
| 1832 | |||
| 1833 | Sets the default encryption configuration for the AWS account. For more | ||
| 1834 | information, see Key management | ||
| 1835 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) | ||
| 1836 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1837 | |||
| 1838 | |||
| 1839 | =head2 PutLoggingOptions | ||
| 1840 | |||
| 1841 | =over | ||
| 1842 | |||
| 1843 | =item LoggingOptions => L<Paws::IoTSiteWise::LoggingOptions> | ||
| 1844 | |||
| 1845 | |||
| 1846 | =back | ||
| 1847 | |||
| 1848 | Each argument is described in detail in: L<Paws::IoTSiteWise::PutLoggingOptions> | ||
| 1849 | |||
| 1850 | Returns: a L<Paws::IoTSiteWise::PutLoggingOptionsResponse> instance | ||
| 1851 | |||
| 1852 | Sets logging options for AWS IoT SiteWise. | ||
| 1853 | |||
| 1854 | |||
| 1855 | =head2 TagResource | ||
| 1856 | |||
| 1857 | =over | ||
| 1858 | |||
| 1859 | =item ResourceArn => Str | ||
| 1860 | |||
| 1861 | =item Tags => L<Paws::IoTSiteWise::TagMap> | ||
| 1862 | |||
| 1863 | |||
| 1864 | =back | ||
| 1865 | |||
| 1866 | Each argument is described in detail in: L<Paws::IoTSiteWise::TagResource> | ||
| 1867 | |||
| 1868 | Returns: a L<Paws::IoTSiteWise::TagResourceResponse> instance | ||
| 1869 | |||
| 1870 | Adds tags to an AWS IoT SiteWise resource. If a tag already exists for | ||
| 1871 | the resource, this operation updates the tag's value. | ||
| 1872 | |||
| 1873 | |||
| 1874 | =head2 UntagResource | ||
| 1875 | |||
| 1876 | =over | ||
| 1877 | |||
| 1878 | =item ResourceArn => Str | ||
| 1879 | |||
| 1880 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 1881 | |||
| 1882 | |||
| 1883 | =back | ||
| 1884 | |||
| 1885 | Each argument is described in detail in: L<Paws::IoTSiteWise::UntagResource> | ||
| 1886 | |||
| 1887 | Returns: a L<Paws::IoTSiteWise::UntagResourceResponse> instance | ||
| 1888 | |||
| 1889 | Removes a tag from an AWS IoT SiteWise resource. | ||
| 1890 | |||
| 1891 | |||
| 1892 | =head2 UpdateAccessPolicy | ||
| 1893 | |||
| 1894 | =over | ||
| 1895 | |||
| 1896 | =item AccessPolicyId => Str | ||
| 1897 | |||
| 1898 | =item AccessPolicyIdentity => L<Paws::IoTSiteWise::Identity> | ||
| 1899 | |||
| 1900 | =item AccessPolicyPermission => Str | ||
| 1901 | |||
| 1902 | =item AccessPolicyResource => L<Paws::IoTSiteWise::Resource> | ||
| 1903 | |||
| 1904 | =item [ClientToken => Str] | ||
| 1905 | |||
| 1906 | |||
| 1907 | =back | ||
| 1908 | |||
| 1909 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateAccessPolicy> | ||
| 1910 | |||
| 1911 | Returns: a L<Paws::IoTSiteWise::UpdateAccessPolicyResponse> instance | ||
| 1912 | |||
| 1913 | Updates an existing access policy that specifies an identity's access | ||
| 1914 | to an AWS IoT SiteWise Monitor portal or project resource. | ||
| 1915 | |||
| 1916 | |||
| 1917 | =head2 UpdateAsset | ||
| 1918 | |||
| 1919 | =over | ||
| 1920 | |||
| 1921 | =item AssetId => Str | ||
| 1922 | |||
| 1923 | =item AssetName => Str | ||
| 1924 | |||
| 1925 | =item [ClientToken => Str] | ||
| 1926 | |||
| 1927 | |||
| 1928 | =back | ||
| 1929 | |||
| 1930 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateAsset> | ||
| 1931 | |||
| 1932 | Returns: a L<Paws::IoTSiteWise::UpdateAssetResponse> instance | ||
| 1933 | |||
| 1934 | Updates an asset's name. For more information, see Updating assets and | ||
| 1935 | models | ||
| 1936 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) | ||
| 1937 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1938 | |||
| 1939 | |||
| 1940 | =head2 UpdateAssetModel | ||
| 1941 | |||
| 1942 | =over | ||
| 1943 | |||
| 1944 | =item AssetModelId => Str | ||
| 1945 | |||
| 1946 | =item AssetModelName => Str | ||
| 1947 | |||
| 1948 | =item [AssetModelCompositeModels => ArrayRef[L<Paws::IoTSiteWise::AssetModelCompositeModel>]] | ||
| 1949 | |||
| 1950 | =item [AssetModelDescription => Str] | ||
| 1951 | |||
| 1952 | =item [AssetModelHierarchies => ArrayRef[L<Paws::IoTSiteWise::AssetModelHierarchy>]] | ||
| 1953 | |||
| 1954 | =item [AssetModelProperties => ArrayRef[L<Paws::IoTSiteWise::AssetModelProperty>]] | ||
| 1955 | |||
| 1956 | =item [ClientToken => Str] | ||
| 1957 | |||
| 1958 | |||
| 1959 | =back | ||
| 1960 | |||
| 1961 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateAssetModel> | ||
| 1962 | |||
| 1963 | Returns: a L<Paws::IoTSiteWise::UpdateAssetModelResponse> instance | ||
| 1964 | |||
| 1965 | Updates an asset model and all of the assets that were created from the | ||
| 1966 | model. Each asset created from the model inherits the updated asset | ||
| 1967 | model's property and hierarchy definitions. For more information, see | ||
| 1968 | Updating assets and models | ||
| 1969 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) | ||
| 1970 | in the I<AWS IoT SiteWise User Guide>. | ||
| 1971 | |||
| 1972 | This operation overwrites the existing model with the provided model. | ||
| 1973 | To avoid deleting your asset model's properties or hierarchies, you | ||
| 1974 | must include their IDs and definitions in the updated asset model | ||
| 1975 | payload. For more information, see DescribeAssetModel | ||
| 1976 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html). | ||
| 1977 | |||
| 1978 | If you remove a property from an asset model, AWS IoT SiteWise deletes | ||
| 1979 | all previous data for that property. If you remove a hierarchy | ||
| 1980 | definition from an asset model, AWS IoT SiteWise disassociates every | ||
| 1981 | asset associated with that hierarchy. You can't change the type or data | ||
| 1982 | type of an existing property. | ||
| 1983 | |||
| 1984 | |||
| 1985 | =head2 UpdateAssetProperty | ||
| 1986 | |||
| 1987 | =over | ||
| 1988 | |||
| 1989 | =item AssetId => Str | ||
| 1990 | |||
| 1991 | =item PropertyId => Str | ||
| 1992 | |||
| 1993 | =item [ClientToken => Str] | ||
| 1994 | |||
| 1995 | =item [PropertyAlias => Str] | ||
| 1996 | |||
| 1997 | =item [PropertyNotificationState => Str] | ||
| 1998 | |||
| 1999 | |||
| 2000 | =back | ||
| 2001 | |||
| 2002 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateAssetProperty> | ||
| 2003 | |||
| 2004 | Returns: nothing | ||
| 2005 | |||
| 2006 | Updates an asset property's alias and notification state. | ||
| 2007 | |||
| 2008 | This operation overwrites the property's existing alias and | ||
| 2009 | notification state. To keep your existing property's alias or | ||
| 2010 | notification state, you must include the existing values in the | ||
| 2011 | UpdateAssetProperty request. For more information, see | ||
| 2012 | DescribeAssetProperty | ||
| 2013 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html). | ||
| 2014 | |||
| 2015 | |||
| 2016 | =head2 UpdateDashboard | ||
| 2017 | |||
| 2018 | =over | ||
| 2019 | |||
| 2020 | =item DashboardDefinition => Str | ||
| 2021 | |||
| 2022 | =item DashboardId => Str | ||
| 2023 | |||
| 2024 | =item DashboardName => Str | ||
| 2025 | |||
| 2026 | =item [ClientToken => Str] | ||
| 2027 | |||
| 2028 | =item [DashboardDescription => Str] | ||
| 2029 | |||
| 2030 | |||
| 2031 | =back | ||
| 2032 | |||
| 2033 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateDashboard> | ||
| 2034 | |||
| 2035 | Returns: a L<Paws::IoTSiteWise::UpdateDashboardResponse> instance | ||
| 2036 | |||
| 2037 | Updates an AWS IoT SiteWise Monitor dashboard. | ||
| 2038 | |||
| 2039 | |||
| 2040 | =head2 UpdateGateway | ||
| 2041 | |||
| 2042 | =over | ||
| 2043 | |||
| 2044 | =item GatewayId => Str | ||
| 2045 | |||
| 2046 | =item GatewayName => Str | ||
| 2047 | |||
| 2048 | |||
| 2049 | =back | ||
| 2050 | |||
| 2051 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateGateway> | ||
| 2052 | |||
| 2053 | Returns: nothing | ||
| 2054 | |||
| 2055 | Updates a gateway's name. | ||
| 2056 | |||
| 2057 | |||
| 2058 | =head2 UpdateGatewayCapabilityConfiguration | ||
| 2059 | |||
| 2060 | =over | ||
| 2061 | |||
| 2062 | =item CapabilityConfiguration => Str | ||
| 2063 | |||
| 2064 | =item CapabilityNamespace => Str | ||
| 2065 | |||
| 2066 | =item GatewayId => Str | ||
| 2067 | |||
| 2068 | |||
| 2069 | =back | ||
| 2070 | |||
| 2071 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateGatewayCapabilityConfiguration> | ||
| 2072 | |||
| 2073 | Returns: a L<Paws::IoTSiteWise::UpdateGatewayCapabilityConfigurationResponse> instance | ||
| 2074 | |||
| 2075 | Updates a gateway capability configuration or defines a new capability | ||
| 2076 | configuration. Each gateway capability defines data sources for a | ||
| 2077 | gateway. A capability configuration can contain multiple data source | ||
| 2078 | configurations. If you define OPC-UA sources for a gateway in the AWS | ||
| 2079 | IoT SiteWise console, all of your OPC-UA sources are stored in one | ||
| 2080 | capability configuration. To list all capability configurations for a | ||
| 2081 | gateway, use DescribeGateway | ||
| 2082 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html). | ||
| 2083 | |||
| 2084 | |||
| 2085 | =head2 UpdatePortal | ||
| 2086 | |||
| 2087 | =over | ||
| 2088 | |||
| 2089 | =item PortalContactEmail => Str | ||
| 2090 | |||
| 2091 | =item PortalId => Str | ||
| 2092 | |||
| 2093 | =item PortalName => Str | ||
| 2094 | |||
| 2095 | =item RoleArn => Str | ||
| 2096 | |||
| 2097 | =item [Alarms => L<Paws::IoTSiteWise::Alarms>] | ||
| 2098 | |||
| 2099 | =item [ClientToken => Str] | ||
| 2100 | |||
| 2101 | =item [NotificationSenderEmail => Str] | ||
| 2102 | |||
| 2103 | =item [PortalDescription => Str] | ||
| 2104 | |||
| 2105 | =item [PortalLogoImage => L<Paws::IoTSiteWise::Image>] | ||
| 2106 | |||
| 2107 | |||
| 2108 | =back | ||
| 2109 | |||
| 2110 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdatePortal> | ||
| 2111 | |||
| 2112 | Returns: a L<Paws::IoTSiteWise::UpdatePortalResponse> instance | ||
| 2113 | |||
| 2114 | Updates an AWS IoT SiteWise Monitor portal. | ||
| 2115 | |||
| 2116 | |||
| 2117 | =head2 UpdateProject | ||
| 2118 | |||
| 2119 | =over | ||
| 2120 | |||
| 2121 | =item ProjectId => Str | ||
| 2122 | |||
| 2123 | =item ProjectName => Str | ||
| 2124 | |||
| 2125 | =item [ClientToken => Str] | ||
| 2126 | |||
| 2127 | =item [ProjectDescription => Str] | ||
| 2128 | |||
| 2129 | |||
| 2130 | =back | ||
| 2131 | |||
| 2132 | Each argument is described in detail in: L<Paws::IoTSiteWise::UpdateProject> | ||
| 2133 | |||
| 2134 | Returns: a L<Paws::IoTSiteWise::UpdateProjectResponse> instance | ||
| 2135 | |||
| 2136 | Updates an AWS IoT SiteWise Monitor project. | ||
| 2137 | |||
| 2138 | |||
| 2139 | |||
| 2140 | |||
| 2141 | =head1 PAGINATORS | ||
| 2142 | |||
| 2143 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 2144 | |||
| 2145 | =head2 GetAllAssetPropertyAggregates(sub { },AggregateTypes => ArrayRef[Str|Undef], EndDate => Str, Resolution => Str, StartDate => Str, [AssetId => Str, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, Qualities => ArrayRef[Str|Undef], TimeOrdering => Str]) | ||
| 2146 | |||
| 2147 | =head2 GetAllAssetPropertyAggregates(AggregateTypes => ArrayRef[Str|Undef], EndDate => Str, Resolution => Str, StartDate => Str, [AssetId => Str, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, Qualities => ArrayRef[Str|Undef], TimeOrdering => Str]) | ||
| 2148 | |||
| 2149 | |||
| 2150 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2151 | |||
| 2152 | - aggregatedValues, passing the object as the first parameter, and the string 'aggregatedValues' as the second parameter | ||
| 2153 | |||
| 2154 | If not, it will return a a L<Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2155 | |||
| 2156 | |||
| 2157 | =head2 GetAllAssetPropertyValueHistory(sub { },[AssetId => Str, EndDate => Str, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, Qualities => ArrayRef[Str|Undef], StartDate => Str, TimeOrdering => Str]) | ||
| 2158 | |||
| 2159 | =head2 GetAllAssetPropertyValueHistory([AssetId => Str, EndDate => Str, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, Qualities => ArrayRef[Str|Undef], StartDate => Str, TimeOrdering => Str]) | ||
| 2160 | |||
| 2161 | |||
| 2162 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2163 | |||
| 2164 | - assetPropertyValueHistory, passing the object as the first parameter, and the string 'assetPropertyValueHistory' as the second parameter | ||
| 2165 | |||
| 2166 | If not, it will return a a L<Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2167 | |||
| 2168 | |||
| 2169 | =head2 GetAllInterpolatedAssetPropertyValues(sub { },EndTimeInSeconds => Int, IntervalInSeconds => Int, Quality => Str, StartTimeInSeconds => Int, Type => Str, [AssetId => Str, EndTimeOffsetInNanos => Int, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, StartTimeOffsetInNanos => Int]) | ||
| 2170 | |||
| 2171 | =head2 GetAllInterpolatedAssetPropertyValues(EndTimeInSeconds => Int, IntervalInSeconds => Int, Quality => Str, StartTimeInSeconds => Int, Type => Str, [AssetId => Str, EndTimeOffsetInNanos => Int, MaxResults => Int, NextToken => Str, PropertyAlias => Str, PropertyId => Str, StartTimeOffsetInNanos => Int]) | ||
| 2172 | |||
| 2173 | |||
| 2174 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2175 | |||
| 2176 | - interpolatedAssetPropertyValues, passing the object as the first parameter, and the string 'interpolatedAssetPropertyValues' as the second parameter | ||
| 2177 | |||
| 2178 | If not, it will return a a L<Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2179 | |||
| 2180 | |||
| 2181 | =head2 ListAllAccessPolicies(sub { },[IamArn => Str, IdentityId => Str, IdentityType => Str, MaxResults => Int, NextToken => Str, ResourceId => Str, ResourceType => Str]) | ||
| 2182 | |||
| 2183 | =head2 ListAllAccessPolicies([IamArn => Str, IdentityId => Str, IdentityType => Str, MaxResults => Int, NextToken => Str, ResourceId => Str, ResourceType => Str]) | ||
| 2184 | |||
| 2185 | |||
| 2186 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2187 | |||
| 2188 | - accessPolicySummaries, passing the object as the first parameter, and the string 'accessPolicySummaries' as the second parameter | ||
| 2189 | |||
| 2190 | If not, it will return a a L<Paws::IoTSiteWise::ListAccessPoliciesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2191 | |||
| 2192 | |||
| 2193 | =head2 ListAllAssetModels(sub { },[MaxResults => Int, NextToken => Str]) | ||
| 2194 | |||
| 2195 | =head2 ListAllAssetModels([MaxResults => Int, NextToken => Str]) | ||
| 2196 | |||
| 2197 | |||
| 2198 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2199 | |||
| 2200 | - assetModelSummaries, passing the object as the first parameter, and the string 'assetModelSummaries' as the second parameter | ||
| 2201 | |||
| 2202 | If not, it will return a a L<Paws::IoTSiteWise::ListAssetModelsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2203 | |||
| 2204 | |||
| 2205 | =head2 ListAllAssetRelationships(sub { },AssetId => Str, TraversalType => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2206 | |||
| 2207 | =head2 ListAllAssetRelationships(AssetId => Str, TraversalType => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2208 | |||
| 2209 | |||
| 2210 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2211 | |||
| 2212 | - assetRelationshipSummaries, passing the object as the first parameter, and the string 'assetRelationshipSummaries' as the second parameter | ||
| 2213 | |||
| 2214 | If not, it will return a a L<Paws::IoTSiteWise::ListAssetRelationshipsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2215 | |||
| 2216 | |||
| 2217 | =head2 ListAllAssets(sub { },[AssetModelId => Str, Filter => Str, MaxResults => Int, NextToken => Str]) | ||
| 2218 | |||
| 2219 | =head2 ListAllAssets([AssetModelId => Str, Filter => Str, MaxResults => Int, NextToken => Str]) | ||
| 2220 | |||
| 2221 | |||
| 2222 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2223 | |||
| 2224 | - assetSummaries, passing the object as the first parameter, and the string 'assetSummaries' as the second parameter | ||
| 2225 | |||
| 2226 | If not, it will return a a L<Paws::IoTSiteWise::ListAssetsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2227 | |||
| 2228 | |||
| 2229 | =head2 ListAllAssociatedAssets(sub { },AssetId => Str, [HierarchyId => Str, MaxResults => Int, NextToken => Str, TraversalDirection => Str]) | ||
| 2230 | |||
| 2231 | =head2 ListAllAssociatedAssets(AssetId => Str, [HierarchyId => Str, MaxResults => Int, NextToken => Str, TraversalDirection => Str]) | ||
| 2232 | |||
| 2233 | |||
| 2234 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2235 | |||
| 2236 | - assetSummaries, passing the object as the first parameter, and the string 'assetSummaries' as the second parameter | ||
| 2237 | |||
| 2238 | If not, it will return a a L<Paws::IoTSiteWise::ListAssociatedAssetsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2239 | |||
| 2240 | |||
| 2241 | =head2 ListAllDashboards(sub { },ProjectId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2242 | |||
| 2243 | =head2 ListAllDashboards(ProjectId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2244 | |||
| 2245 | |||
| 2246 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2247 | |||
| 2248 | - dashboardSummaries, passing the object as the first parameter, and the string 'dashboardSummaries' as the second parameter | ||
| 2249 | |||
| 2250 | If not, it will return a a L<Paws::IoTSiteWise::ListDashboardsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2251 | |||
| 2252 | |||
| 2253 | =head2 ListAllGateways(sub { },[MaxResults => Int, NextToken => Str]) | ||
| 2254 | |||
| 2255 | =head2 ListAllGateways([MaxResults => Int, NextToken => Str]) | ||
| 2256 | |||
| 2257 | |||
| 2258 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2259 | |||
| 2260 | - gatewaySummaries, passing the object as the first parameter, and the string 'gatewaySummaries' as the second parameter | ||
| 2261 | |||
| 2262 | If not, it will return a a L<Paws::IoTSiteWise::ListGatewaysResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2263 | |||
| 2264 | |||
| 2265 | =head2 ListAllPortals(sub { },[MaxResults => Int, NextToken => Str]) | ||
| 2266 | |||
| 2267 | =head2 ListAllPortals([MaxResults => Int, NextToken => Str]) | ||
| 2268 | |||
| 2269 | |||
| 2270 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2271 | |||
| 2272 | - portalSummaries, passing the object as the first parameter, and the string 'portalSummaries' as the second parameter | ||
| 2273 | |||
| 2274 | If not, it will return a a L<Paws::IoTSiteWise::ListPortalsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2275 | |||
| 2276 | |||
| 2277 | =head2 ListAllProjectAssets(sub { },ProjectId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2278 | |||
| 2279 | =head2 ListAllProjectAssets(ProjectId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2280 | |||
| 2281 | |||
| 2282 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2283 | |||
| 2284 | - assetIds, passing the object as the first parameter, and the string 'assetIds' as the second parameter | ||
| 2285 | |||
| 2286 | If not, it will return a a L<Paws::IoTSiteWise::ListProjectAssetsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2287 | |||
| 2288 | |||
| 2289 | =head2 ListAllProjects(sub { },PortalId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2290 | |||
| 2291 | =head2 ListAllProjects(PortalId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 2292 | |||
| 2293 | |||
| 2294 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 2295 | |||
| 2296 | - projectSummaries, passing the object as the first parameter, and the string 'projectSummaries' as the second parameter | ||
| 2297 | |||
| 2298 | If not, it will return a a L<Paws::IoTSiteWise::ListProjectsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 2299 | |||
| 2300 | |||
| 2301 | |||
| 2302 | |||
| 2303 | |||
| 2304 | =head1 SEE ALSO | ||
| 2305 | |||
| 2306 | This service class forms part of L<Paws> | ||
| 2307 | |||
| 2308 | =head1 BUGS and CONTRIBUTIONS | ||
| 2309 | |||
| 2310 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 2311 | |||
| 2312 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 2313 | |||
| 2314 | =cut | ||
| 2315 |