package Paws::GameLift::SearchGameSessions; use Moose; has AliasId => (is => 'ro', isa => 'Str'); has FilterExpression => (is => 'ro', isa => 'Str'); has FleetId => (is => 'ro', isa => 'Str'); has Limit => (is => 'ro', isa => 'Int'); has Location => (is => 'ro', isa => 'Str'); has NextToken => (is => 'ro', isa => 'Str'); has SortExpression => (is => 'ro', isa => 'Str'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchGameSessions'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::SearchGameSessionsOutput'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::GameLift::SearchGameSessions - Arguments for method SearchGameSessions on L =head1 DESCRIPTION This class represents the parameters used for calling the method SearchGameSessions on the L service. Use the attributes of this class as arguments to method SearchGameSessions. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchGameSessions. =head1 SYNOPSIS my $gamelift = Paws->service('GameLift'); my $SearchGameSessionsOutput = $gamelift->SearchGameSessions( AliasId => 'MyAliasIdOrArn', # OPTIONAL FilterExpression => 'MyNonZeroAndMaxString', # OPTIONAL FleetId => 'MyFleetIdOrArn', # OPTIONAL Limit => 1, # OPTIONAL Location => 'MyLocationStringModel', # OPTIONAL NextToken => 'MyNonZeroAndMaxString', # OPTIONAL SortExpression => 'MyNonZeroAndMaxString', # OPTIONAL ); # Results: my $GameSessions = $SearchGameSessionsOutput->GameSessions; my $NextToken = $SearchGameSessionsOutput->NextToken; # Returns a L 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 L =head1 ATTRIBUTES =head2 AliasId => Str A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both. =head2 FilterExpression => Str String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in C status. A filter expression can contain one or multiple conditions. Each condition consists of the following: =over =item * B -- Name of a game session attribute. Valid values are C, C, C, C, C, C, C. =item * B -- Valid comparators are: C<=>, CE>, C>, C>, C=>, C=>. =item * B -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators C<=> and CE>. For example, the following filter expression searches on C: "C. =back To chain multiple conditions in a single expression, use the logical keywords C, C, and C and parentheses as needed. For example: C, C. Session search evaluates conditions from left to right using the following precedence rules: =over =item 1. C<=>, CE>, C>, C>, C=>, C=> =item 2. Parentheses =item 3. NOT =item 4. AND =item 5. OR =back For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: C<"maximumSessionsE=10 AND hasAvailablePlayerSessions=true">. =head2 FleetId => Str A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both. =head2 Limit => Int The maximum number of results to return. Use this parameter with C to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20. =head2 Location => Str A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as C. =head2 NextToken => Str A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. =head2 SortExpression => Str Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements: =over =item * B -- Name of a game session attribute. Valid values are C, C, C, C, C, C, C. =item * B -- Valid sort orders are C (ascending) and C (descending). =back For example, this sort expression returns the oldest active sessions first: C<"SortExpression": "creationTimeMillis ASC">. Results with a null value for the sort operand are returned at the end of the list. =head1 SEE ALSO This class forms part of L, documenting arguments for method SearchGameSessions in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut