/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::GameLift::DescribeGameSessionDetails

NAME

Paws::GameLift::DescribeGameSessionDetails - Arguments for method DescribeGameSessionDetails on Paws::GameLift

DESCRIPTION

This class represents the parameters used for calling the method DescribeGameSessionDetails on the Amazon GameLift service. Use the attributes of this class as arguments to method DescribeGameSessionDetails.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeGameSessionDetails.

SYNOPSIS

my $gamelift = Paws->service('GameLift');
my $DescribeGameSessionDetailsOutput =
  $gamelift->DescribeGameSessionDetails(
  AliasId       => 'MyAliasIdOrArn',           # OPTIONAL
  FleetId       => 'MyFleetIdOrArn',           # OPTIONAL
  GameSessionId => 'MyArnStringModel',         # OPTIONAL
  Limit         => 1,                          # OPTIONAL
  Location      => 'MyLocationStringModel',    # OPTIONAL
  NextToken     => 'MyNonZeroAndMaxString',    # OPTIONAL
  StatusFilter  => 'MyNonZeroAndMaxString',    # OPTIONAL
  );

# Results:
my $GameSessionDetails =
  $DescribeGameSessionDetailsOutput->GameSessionDetails;
my $NextToken = $DescribeGameSessionDetailsOutput->NextToken;

# Returns a L<Paws::GameLift::DescribeGameSessionDetailsOutput> 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/gamelift/DescribeGameSessionDetails

ATTRIBUTES

AliasId => Str

A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

FleetId => Str

A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

GameSessionId => Str

A unique identifier for the game session to retrieve.

Limit => Int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location => Str

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

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.

StatusFilter => Str

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeGameSessionDetails in Paws::GameLift

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues