NAME

Paws::IoTSiteWise::GetAssetPropertyAggregates - Arguments for method GetAssetPropertyAggregates on Paws::IoTSiteWise

DESCRIPTION

This class represents the parameters used for calling the method GetAssetPropertyAggregates on the AWS IoT SiteWise service. Use the attributes of this class as arguments to method GetAssetPropertyAggregates.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetAssetPropertyAggregates.

SYNOPSIS

my $iotsitewise = Paws->service('IoTSiteWise');
my $GetAssetPropertyAggregatesResponse =
  $iotsitewise->GetAssetPropertyAggregates(
  AggregateTypes => [
    'AVERAGE',
    ...  # values: AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
  ],
  EndDate       => '1970-01-01T01:00:00',
  Resolution    => 'MyResolution',
  StartDate     => '1970-01-01T01:00:00',
  AssetId       => 'MyID',                    # OPTIONAL
  MaxResults    => 1,                         # OPTIONAL
  NextToken     => 'MyNextToken',             # OPTIONAL
  PropertyAlias => 'MyAssetPropertyAlias',    # OPTIONAL
  PropertyId    => 'MyID',                    # OPTIONAL
  Qualities     => [
    'GOOD', ...                               # values: GOOD, BAD, UNCERTAIN
  ],    # OPTIONAL
  TimeOrdering => 'ASCENDING',    # OPTIONAL
  );

# Results:
my $AggregatedValues =
  $GetAssetPropertyAggregatesResponse->AggregatedValues;
my $NextToken = $GetAssetPropertyAggregatesResponse->NextToken;

# Returns a L<Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/GetAssetPropertyAggregates

ATTRIBUTES

REQUIRED AggregateTypes => ArrayRef[Str|Undef]

The data aggregating function.

AssetId => Str

The ID of the asset.

REQUIRED EndDate => Str

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

MaxResults => Int

The maximum number of results to be returned per paginated request.

Default: 100

NextToken => Str

The token to be used for the next set of paginated results.

PropertyAlias => Str

The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the AWS IoT SiteWise User Guide.

PropertyId => Str

The ID of the asset property.

Qualities => ArrayRef[Str|Undef]

The quality by which to filter asset data.

REQUIRED Resolution => Str

The time interval over which to aggregate data.

REQUIRED StartDate => Str

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

TimeOrdering => Str

The chronological sorting order of the requested information.

Default: ASCENDING

Valid values are: "ASCENDING", "DESCENDING"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetAssetPropertyAggregates in Paws::IoTSiteWise

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues