« blib/lib/Paws/IoTSiteWise/AssetSummary.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/AssociatedAssetsSummary.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::AssociateAssets; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'assetId', required => 1); | ||
| 5 | has ChildAssetId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'childAssetId', required => 1); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 7 | has HierarchyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'hierarchyId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AssociateAssets'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assets/{assetId}/associate'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTSiteWise::AssociateAssets - Arguments for method AssociateAssets on L<Paws::IoTSiteWise> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method AssociateAssets on the | ||
| 26 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 27 | as arguments to method AssociateAssets. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AssociateAssets. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 34 | $iotsitewise->AssociateAssets( | ||
| 35 | AssetId => 'MyID', | ||
| 36 | ChildAssetId => 'MyID', | ||
| 37 | HierarchyId => 'MyID', | ||
| 38 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/AssociateAssets> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> AssetId => Str | ||
| 48 | |||
| 49 | The ID of the parent asset. | ||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ChildAssetId => Str | ||
| 54 | |||
| 55 | The ID of the child asset to be associated. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 ClientToken => Str | ||
| 60 | |||
| 61 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 62 | idempotency of the request. Don't reuse this client token if a new | ||
| 63 | idempotent request is required. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> HierarchyId => Str | ||
| 68 | |||
| 69 | The ID of a hierarchy in the parent asset's model. Hierarchies allow | ||
| 70 | different groupings of assets to be formed that all come from the same | ||
| 71 | asset model. For more information, see Asset hierarchies | ||
| 72 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) | ||
| 73 | in the I<AWS IoT SiteWise User Guide>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method AssociateAssets in L<Paws::IoTSiteWise> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |