![]() |
![]()
| ![]() |
![]()
NAMEPaws::IoTThingsGraph::SearchEntities - Arguments for method SearchEntities on Paws::IoTThingsGraph DESCRIPTIONThis class represents the parameters used for calling the method SearchEntities on the AWS IoT Things Graph service. Use the attributes of this class as arguments to method SearchEntities. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchEntities. SYNOPSISmy $iotthingsgraph = Paws->service('IoTThingsGraph'); my $SearchEntitiesResponse = $iotthingsgraph->SearchEntities( EntityTypes => [ 'DEVICE', ... # values: DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM ], Filters => [ { Name => 'NAME' , # values: NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID; OPTIONAL Value => [ 'MyEntityFilterValue', ... ], # OPTIONAL }, ... ], # OPTIONAL MaxResults => 1, # OPTIONAL NamespaceVersion => 1, # OPTIONAL NextToken => 'MyNextToken', # OPTIONAL ); # Results: my $Descriptions = $SearchEntitiesResponse->Descriptions; my $NextToken = $SearchEntitiesResponse->NextToken; # Returns a L<Paws::IoTThingsGraph::SearchEntitiesResponse> 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/iotthingsgraph/SearchEntities> ATTRIBUTESREQUIRED EntityTypes => ArrayRef[Str|Undef]The entity types for which to search. Filters => ArrayRef[Paws::IoTThingsGraph::EntityFilter]Optional filter to apply to the search. Valid filters are "NAME" "NAMESPACE", "SEMANTIC_TYPE_PATH" and "REFERENCED_ENTITY_ID". "REFERENCED_ENTITY_ID" filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state. Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria. MaxResults => IntThe maximum number of results to return in the response. NamespaceVersion => IntThe version of the user's namespace. Defaults to the latest version of the user's namespace. NextToken => StrThe string that specifies the next page of results. Use this when you're paginating results. SEE ALSOThis class forms part of Paws, documenting arguments for method SearchEntities in Paws::IoTThingsGraph BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|