« blib/lib/Paws/IoTSiteWise/UpdateAssetModelResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/UpdateAssetResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::UpdateAssetProperty; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'assetId', required => 1); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 6 | has PropertyAlias => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'propertyAlias'); | ||
| 7 | has PropertyId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'propertyId', required => 1); | ||
| 8 | has PropertyNotificationState => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'propertyNotificationState'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAssetProperty'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assets/{assetId}/properties/{propertyId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTSiteWise::UpdateAssetProperty - Arguments for method UpdateAssetProperty on L<Paws::IoTSiteWise> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateAssetProperty on the | ||
| 27 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateAssetProperty. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAssetProperty. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 35 | $iotsitewise->UpdateAssetProperty( | ||
| 36 | AssetId => 'MyID', | ||
| 37 | PropertyId => 'MyID', | ||
| 38 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 39 | PropertyAlias => 'MyPropertyAlias', # OPTIONAL | ||
| 40 | PropertyNotificationState => 'ENABLED', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/UpdateAssetProperty> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> AssetId => Str | ||
| 50 | |||
| 51 | The ID of the asset to be updated. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 ClientToken => Str | ||
| 56 | |||
| 57 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 58 | idempotency of the request. Don't reuse this client token if a new | ||
| 59 | idempotent request is required. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 PropertyAlias => Str | ||
| 64 | |||
| 65 | The property alias that identifies the property, such as an OPC-UA | ||
| 66 | server data stream path (for example, | ||
| 67 | C</company/windfarm/3/turbine/7/temperature>). For more information, | ||
| 68 | see Mapping industrial data streams to asset properties | ||
| 69 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) | ||
| 70 | in the I<AWS IoT SiteWise User Guide>. | ||
| 71 | |||
| 72 | If you omit this parameter, the alias is removed from the property. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> PropertyId => Str | ||
| 77 | |||
| 78 | The ID of the asset property to be updated. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 PropertyNotificationState => Str | ||
| 83 | |||
| 84 | The MQTT notification state (enabled or disabled) for this asset | ||
| 85 | property. When the notification state is enabled, AWS IoT SiteWise | ||
| 86 | publishes property value updates to a unique MQTT topic. For more | ||
| 87 | information, see Interacting with other services | ||
| 88 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) | ||
| 89 | in the I<AWS IoT SiteWise User Guide>. | ||
| 90 | |||
| 91 | If you omit this parameter, the notification state is set to | ||
| 92 | C<DISABLED>. | ||
| 93 | |||
| 94 | Valid values are: C<"ENABLED">, C<"DISABLED"> | ||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method UpdateAssetProperty in L<Paws::IoTSiteWise> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |