« blib/lib/Paws/IoTSiteWise/GetAssetPropertyValue.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/GetAssetPropertyValueHistoryResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::GetAssetPropertyValueHistory; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'assetId'); | ||
| 5 | has EndDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endDate'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 8 | has PropertyAlias => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyAlias'); | ||
| 9 | has PropertyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyId'); | ||
| 10 | has Qualities => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'qualities'); | ||
| 11 | has StartDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startDate'); | ||
| 12 | has TimeOrdering => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'timeOrdering'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetAssetPropertyValueHistory'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/properties/history'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::IoTSiteWise::GetAssetPropertyValueHistory - Arguments for method GetAssetPropertyValueHistory on L<Paws::IoTSiteWise> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method GetAssetPropertyValueHistory on the | ||
| 31 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 32 | as arguments to method GetAssetPropertyValueHistory. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetAssetPropertyValueHistory. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 39 | my $GetAssetPropertyValueHistoryResponse = | ||
| 40 | $iotsitewise->GetAssetPropertyValueHistory( | ||
| 41 | AssetId => 'MyID', # OPTIONAL | ||
| 42 | EndDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | PropertyAlias => 'MyAssetPropertyAlias', # OPTIONAL | ||
| 46 | PropertyId => 'MyID', # OPTIONAL | ||
| 47 | Qualities => [ | ||
| 48 | 'GOOD', ... # values: GOOD, BAD, UNCERTAIN | ||
| 49 | ], # OPTIONAL | ||
| 50 | StartDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 51 | TimeOrdering => 'ASCENDING', # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $AssetPropertyValueHistory = | ||
| 56 | $GetAssetPropertyValueHistoryResponse->AssetPropertyValueHistory; | ||
| 57 | my $NextToken = $GetAssetPropertyValueHistoryResponse->NextToken; | ||
| 58 | |||
| 59 | # Returns a L<Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/GetAssetPropertyValueHistory> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 AssetId => Str | ||
| 68 | |||
| 69 | The ID of the asset. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 EndDate => Str | ||
| 74 | |||
| 75 | The inclusive end of the range from which to query historical data, | ||
| 76 | expressed in seconds in Unix epoch time. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxResults => Int | ||
| 81 | |||
| 82 | The maximum number of results to be returned per paginated request. | ||
| 83 | |||
| 84 | Default: 100 | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 NextToken => Str | ||
| 89 | |||
| 90 | The token to be used for the next set of paginated results. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 PropertyAlias => Str | ||
| 95 | |||
| 96 | The property alias that identifies the property, such as an OPC-UA | ||
| 97 | server data stream path (for example, | ||
| 98 | C</company/windfarm/3/turbine/7/temperature>). For more information, | ||
| 99 | see Mapping industrial data streams to asset properties | ||
| 100 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) | ||
| 101 | in the I<AWS IoT SiteWise User Guide>. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 PropertyId => Str | ||
| 106 | |||
| 107 | The ID of the asset property. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 Qualities => ArrayRef[Str|Undef] | ||
| 112 | |||
| 113 | The quality by which to filter asset data. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 StartDate => Str | ||
| 118 | |||
| 119 | The exclusive start of the range from which to query historical data, | ||
| 120 | expressed in seconds in Unix epoch time. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 TimeOrdering => Str | ||
| 125 | |||
| 126 | The chronological sorting order of the requested information. | ||
| 127 | |||
| 128 | Default: C<ASCENDING> | ||
| 129 | |||
| 130 | Valid values are: C<"ASCENDING">, C<"DESCENDING"> | ||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method GetAssetPropertyValueHistory in L<Paws::IoTSiteWise> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |