« blib/lib/Paws/IoTSiteWise/ListAssetModelsResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/ListAssetRelationshipsResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::ListAssetRelationships; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'assetId', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | has TraversalType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'traversalType', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAssetRelationships'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assets/{assetId}/assetRelationships'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::ListAssetRelationshipsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTSiteWise::ListAssetRelationships - Arguments for method ListAssetRelationships on L<Paws::IoTSiteWise> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListAssetRelationships on the | ||
| 26 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 27 | as arguments to method ListAssetRelationships. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAssetRelationships. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 34 | my $ListAssetRelationshipsResponse = $iotsitewise->ListAssetRelationships( | ||
| 35 | AssetId => 'MyID', | ||
| 36 | TraversalType => 'PATH_TO_ROOT', | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AssetRelationshipSummaries = | ||
| 43 | $ListAssetRelationshipsResponse->AssetRelationshipSummaries; | ||
| 44 | my $NextToken = $ListAssetRelationshipsResponse->NextToken; | ||
| 45 | |||
| 46 | # Returns a L<Paws::IoTSiteWise::ListAssetRelationshipsResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/ListAssetRelationships> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> AssetId => Str | ||
| 55 | |||
| 56 | The ID of the asset. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 MaxResults => Int | ||
| 61 | |||
| 62 | The maximum number of results to be returned per paginated request. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 NextToken => Str | ||
| 67 | |||
| 68 | The token to be used for the next set of paginated results. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> TraversalType => Str | ||
| 73 | |||
| 74 | The type of traversal to use to identify asset relationships. Choose | ||
| 75 | the following option: | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<PATH_TO_ROOT> E<ndash> Identify the asset's parent assets up to the | ||
| 82 | root asset. The asset that you specify in C<assetId> is the first | ||
| 83 | result in the list of C<assetRelationshipSummaries>, and the root asset | ||
| 84 | is the last result. | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | |||
| 89 | Valid values are: C<"PATH_TO_ROOT"> | ||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method ListAssetRelationships in L<Paws::IoTSiteWise> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |