« blib/lib/Paws/IoTSiteWise/GatewayPlatform.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/GetAssetPropertyAggregates.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSiteWise::GatewaySummary; | ||
| 3 | use Moose; | ||
| 4 | has CreationDate => (is => 'ro', isa => 'Str', request_name => 'creationDate', traits => ['NameInRequest'], required => 1); | ||
| 5 | has GatewayCapabilitySummaries => (is => 'ro', isa => 'ArrayRef[Paws::IoTSiteWise::GatewayCapabilitySummary]', request_name => 'gatewayCapabilitySummaries', traits => ['NameInRequest']); | ||
| 6 | has GatewayId => (is => 'ro', isa => 'Str', request_name => 'gatewayId', traits => ['NameInRequest'], required => 1); | ||
| 7 | has GatewayName => (is => 'ro', isa => 'Str', request_name => 'gatewayName', traits => ['NameInRequest'], required => 1); | ||
| 8 | has LastUpdateDate => (is => 'ro', isa => 'Str', request_name => 'lastUpdateDate', traits => ['NameInRequest'], required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::IoTSiteWise::GatewaySummary | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::IoTSiteWise::GatewaySummary object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CreationDate => $value, ..., LastUpdateDate => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSiteWise::GatewaySummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CreationDate | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains a summary of a gateway. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CreationDate => Str | ||
| 46 | |||
| 47 | The date the gateway was created, in Unix epoch time. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 GatewayCapabilitySummaries => ArrayRef[L<Paws::IoTSiteWise::GatewayCapabilitySummary>] | ||
| 51 | |||
| 52 | A list of gateway capability summaries that each contain a namespace | ||
| 53 | and status. Each gateway capability defines data sources for the | ||
| 54 | gateway. To retrieve a capability configuration's definition, use | ||
| 55 | DescribeGatewayCapabilityConfiguration | ||
| 56 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> GatewayId => Str | ||
| 60 | |||
| 61 | The ID of the gateway device. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> GatewayName => Str | ||
| 65 | |||
| 66 | The name of the asset. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> LastUpdateDate => Str | ||
| 70 | |||
| 71 | The date the gateway was last updated, in Unix epoch time. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |