« blib/lib/Paws/IoTThingsGraph/FlowTemplateSummary.pm
↑ Summary
blib/lib/Paws/IoTThingsGraph/GetEntitiesResponse.pm »
| 1 | |||
| 2 | package Paws::IoTThingsGraph::GetEntities; | ||
| 3 | use Moose; | ||
| 4 | has Ids => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ids' , required => 1); | ||
| 5 | has NamespaceVersion => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'namespaceVersion' ); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetEntities'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTThingsGraph::GetEntitiesResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::IoTThingsGraph::GetEntities - Arguments for method GetEntities on L<Paws::IoTThingsGraph> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method GetEntities on the | ||
| 23 | L<AWS IoT Things Graph|Paws::IoTThingsGraph> service. Use the attributes of this class | ||
| 24 | as arguments to method GetEntities. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetEntities. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $iotthingsgraph = Paws->service('IoTThingsGraph'); | ||
| 31 | my $GetEntitiesResponse = $iotthingsgraph->GetEntities( | ||
| 32 | Ids => [ | ||
| 33 | 'MyUrn', ... # max: 160 | ||
| 34 | ], | ||
| 35 | NamespaceVersion => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Descriptions = $GetEntitiesResponse->Descriptions; | ||
| 40 | |||
| 41 | # Returns a L<Paws::IoTThingsGraph::GetEntitiesResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph/GetEntities> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> Ids => ArrayRef[Str|Undef] | ||
| 50 | |||
| 51 | An array of entity IDs. | ||
| 52 | |||
| 53 | The IDs should be in the following format. | ||
| 54 | |||
| 55 | C<urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME> | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 NamespaceVersion => Int | ||
| 60 | |||
| 61 | The version of the user's namespace. Defaults to the latest version of | ||
| 62 | the user's namespace. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, documenting arguments for method GetEntities in L<Paws::IoTThingsGraph> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |