Documentation

GameLiftClient extends AwsClient
in package

This client is used to interact with the **Amazon GameLift** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
acceptMatch()  :
acceptMatchAsync()  :
claimGameServer()  :
claimGameServerAsync()  :
createAlias()  :
createAliasAsync()  :
createBuild()  :
createBuildAsync()  :
createFleet()  :
createFleetAsync()  :
createGameServerGroup()  :
createGameServerGroupAsync()  :
createGameSession()  :
createGameSessionAsync()  :
createGameSessionQueue()  :
createGameSessionQueueAsync()  :
createMatchmakingConfiguration()  :
createMatchmakingConfigurationAsync()  :
createMatchmakingRuleSet()  :
createMatchmakingRuleSetAsync()  :
createPlayerSession()  :
createPlayerSessionAsync()  :
createPlayerSessions()  :
createPlayerSessionsAsync()  :
createScript()  :
createScriptAsync()  :
createVpcPeeringAuthorization()  :
createVpcPeeringAuthorizationAsync()  :
createVpcPeeringConnection()  :
createVpcPeeringConnectionAsync()  :
deleteAlias()  :
deleteAliasAsync()  :
deleteBuild()  :
deleteBuildAsync()  :
deleteFleet()  :
deleteFleetAsync()  :
deleteGameServerGroup()  :
deleteGameServerGroupAsync()  :
deleteGameSessionQueue()  :
deleteGameSessionQueueAsync()  :
deleteMatchmakingConfiguration()  :
deleteMatchmakingConfigurationAsync()  :
deleteMatchmakingRuleSet()  :
deleteMatchmakingRuleSetAsync()  :
deleteScalingPolicy()  :
deleteScalingPolicyAsync()  :
deleteScript()  :
deleteScriptAsync()  :
deleteVpcPeeringAuthorization()  :
deleteVpcPeeringAuthorizationAsync()  :
deleteVpcPeeringConnection()  :
deleteVpcPeeringConnectionAsync()  :
deregisterGameServer()  :
deregisterGameServerAsync()  :
describeAlias()  :
describeAliasAsync()  :
describeBuild()  :
describeBuildAsync()  :
describeEC2InstanceLimits()  :
describeEC2InstanceLimitsAsync()  :
describeFleetAttributes()  :
describeFleetAttributesAsync()  :
describeFleetCapacity()  :
describeFleetCapacityAsync()  :
describeFleetEvents()  :
describeFleetEventsAsync()  :
describeFleetPortSettings()  :
describeFleetPortSettingsAsync()  :
describeFleetUtilization()  :
describeFleetUtilizationAsync()  :
describeGameServer()  :
describeGameServerAsync()  :
describeGameServerGroup()  :
describeGameServerGroupAsync()  :
describeGameServerInstances()  :
describeGameServerInstancesAsync()  :
describeGameSessionDetails()  :
describeGameSessionDetailsAsync()  :
describeGameSessionPlacement()  :
describeGameSessionPlacementAsync()  :
describeGameSessionQueues()  :
describeGameSessionQueuesAsync()  :
describeGameSessions()  :
describeGameSessionsAsync()  :
describeInstances()  :
describeInstancesAsync()  :
describeMatchmaking()  :
describeMatchmakingAsync()  :
describeMatchmakingConfigurations()  :
describeMatchmakingConfigurationsAsync()  :
describeMatchmakingRuleSets()  :
describeMatchmakingRuleSetsAsync()  :
describePlayerSessions()  :
describePlayerSessionsAsync()  :
describeRuntimeConfiguration()  :
describeRuntimeConfigurationAsync()  :
describeScalingPolicies()  :
describeScalingPoliciesAsync()  :
describeScript()  :
describeScriptAsync()  :
describeVpcPeeringAuthorizations()  :
describeVpcPeeringAuthorizationsAsync()  :
describeVpcPeeringConnections()  :
describeVpcPeeringConnectionsAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getGameSessionLogUrl()  :
getGameSessionLogUrlAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInstanceAccess()  :
getInstanceAccessAsync()  :
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listAliases()  :
listAliasesAsync()  :
listBuilds()  :
listBuildsAsync()  :
listFleets()  :
listFleetsAsync()  :
listGameServerGroups()  :
listGameServerGroupsAsync()  :
listGameServers()  :
listGameServersAsync()  :
listScripts()  :
listScriptsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
putScalingPolicy()  :
putScalingPolicyAsync()  :
registerGameServer()  :
registerGameServerAsync()  :
requestUploadCredentials()  :
requestUploadCredentialsAsync()  :
resolveAlias()  :
resolveAliasAsync()  :
resumeGameServerGroup()  :
resumeGameServerGroupAsync()  :
searchGameSessions()  :
searchGameSessionsAsync()  :
startFleetActions()  :
startFleetActionsAsync()  :
startGameSessionPlacement()  :
startGameSessionPlacementAsync()  :
startMatchBackfill()  :
startMatchBackfillAsync()  :
startMatchmaking()  :
startMatchmakingAsync()  :
stopFleetActions()  :
stopFleetActionsAsync()  :
stopGameSessionPlacement()  :
stopGameSessionPlacementAsync()  :
stopMatchmaking()  :
stopMatchmakingAsync()  :
suspendGameServerGroup()  :
suspendGameServerGroupAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateAlias()  :
updateAliasAsync()  :
updateBuild()  :
updateBuildAsync()  :
updateFleetAttributes()  :
updateFleetAttributesAsync()  :
updateFleetCapacity()  :
updateFleetCapacityAsync()  :
updateFleetPortSettings()  :
updateFleetPortSettingsAsync()  :
updateGameServer()  :
updateGameServerAsync()  :
updateGameServerGroup()  :
updateGameServerGroupAsync()  :
updateGameSession()  :
updateGameSessionAsync()  :
updateGameSessionQueue()  :
updateGameSessionQueueAsync()  :
updateMatchmakingConfiguration()  :
updateMatchmakingConfigurationAsync()  :
updateRuntimeConfiguration()  :
updateRuntimeConfigurationAsync()  :
updateScript()  :
updateScriptAsync()  :
validateMatchmakingRuleSet()  :
validateMatchmakingRuleSetAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed —

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

acceptMatch()

public acceptMatch(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

acceptMatchAsync()

public acceptMatchAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

claimGameServer()

public claimGameServer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

claimGameServerAsync()

public claimGameServerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createAlias()

public createAlias(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createAliasAsync()

public createAliasAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBuild()

public createBuild(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBuildAsync()

public createBuildAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createFleet()

public createFleet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createFleetAsync()

public createFleetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameServerGroup()

public createGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameServerGroupAsync()

public createGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameSession()

public createGameSession(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameSessionAsync()

public createGameSessionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameSessionQueue()

public createGameSessionQueue(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGameSessionQueueAsync()

public createGameSessionQueueAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createMatchmakingConfiguration()

public createMatchmakingConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createMatchmakingConfigurationAsync()

public createMatchmakingConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createMatchmakingRuleSet()

public createMatchmakingRuleSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createMatchmakingRuleSetAsync()

public createMatchmakingRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPlayerSession()

public createPlayerSession(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPlayerSessionAsync()

public createPlayerSessionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPlayerSessions()

public createPlayerSessions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPlayerSessionsAsync()

public createPlayerSessionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createScript()

public createScript(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createScriptAsync()

public createScriptAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createVpcPeeringAuthorization()

public createVpcPeeringAuthorization(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createVpcPeeringAuthorizationAsync()

public createVpcPeeringAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createVpcPeeringConnection()

public createVpcPeeringConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createVpcPeeringConnectionAsync()

public createVpcPeeringConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteAlias()

public deleteAlias(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteAliasAsync()

public deleteAliasAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBuild()

public deleteBuild(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBuildAsync()

public deleteBuildAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteFleet()

public deleteFleet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteFleetAsync()

public deleteFleetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGameServerGroup()

public deleteGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGameServerGroupAsync()

public deleteGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGameSessionQueue()

public deleteGameSessionQueue(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGameSessionQueueAsync()

public deleteGameSessionQueueAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteMatchmakingConfiguration()

public deleteMatchmakingConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteMatchmakingConfigurationAsync()

public deleteMatchmakingConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteMatchmakingRuleSet()

public deleteMatchmakingRuleSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteMatchmakingRuleSetAsync()

public deleteMatchmakingRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteScalingPolicy()

public deleteScalingPolicy(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteScalingPolicyAsync()

public deleteScalingPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteScript()

public deleteScript(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteScriptAsync()

public deleteScriptAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVpcPeeringAuthorization()

public deleteVpcPeeringAuthorization(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVpcPeeringAuthorizationAsync()

public deleteVpcPeeringAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVpcPeeringConnection()

public deleteVpcPeeringConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVpcPeeringConnectionAsync()

public deleteVpcPeeringConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deregisterGameServer()

public deregisterGameServer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deregisterGameServerAsync()

public deregisterGameServerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAlias()

public describeAlias(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAliasAsync()

public describeAliasAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeBuild()

public describeBuild(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeBuildAsync()

public describeBuildAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEC2InstanceLimits()

public describeEC2InstanceLimits(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEC2InstanceLimitsAsync()

public describeEC2InstanceLimitsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetAttributes()

public describeFleetAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetAttributesAsync()

public describeFleetAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetCapacity()

public describeFleetCapacity(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetCapacityAsync()

public describeFleetCapacityAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetEvents()

public describeFleetEvents(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetEventsAsync()

public describeFleetEventsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetPortSettings()

public describeFleetPortSettings(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetPortSettingsAsync()

public describeFleetPortSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetUtilization()

public describeFleetUtilization(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetUtilizationAsync()

public describeFleetUtilizationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServer()

public describeGameServer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServerAsync()

public describeGameServerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServerGroup()

public describeGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServerGroupAsync()

public describeGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServerInstances()

public describeGameServerInstances(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameServerInstancesAsync()

public describeGameServerInstancesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionDetails()

public describeGameSessionDetails(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionDetailsAsync()

public describeGameSessionDetailsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionPlacement()

public describeGameSessionPlacement(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionPlacementAsync()

public describeGameSessionPlacementAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionQueues()

public describeGameSessionQueues(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionQueuesAsync()

public describeGameSessionQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessions()

public describeGameSessions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGameSessionsAsync()

public describeGameSessionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInstances()

public describeInstances(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInstancesAsync()

public describeInstancesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmaking()

public describeMatchmaking(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmakingAsync()

public describeMatchmakingAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmakingConfigurations()

public describeMatchmakingConfigurations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmakingConfigurationsAsync()

public describeMatchmakingConfigurationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmakingRuleSets()

public describeMatchmakingRuleSets(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeMatchmakingRuleSetsAsync()

public describeMatchmakingRuleSetsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describePlayerSessions()

public describePlayerSessions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describePlayerSessionsAsync()

public describePlayerSessionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRuntimeConfiguration()

public describeRuntimeConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRuntimeConfigurationAsync()

public describeRuntimeConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeScalingPolicies()

public describeScalingPolicies(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeScalingPoliciesAsync()

public describeScalingPoliciesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeScript()

public describeScript(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeScriptAsync()

public describeScriptAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVpcPeeringAuthorizations()

public describeVpcPeeringAuthorizations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVpcPeeringAuthorizationsAsync()

public describeVpcPeeringAuthorizationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVpcPeeringConnections()

public describeVpcPeeringConnections(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVpcPeeringConnectionsAsync()

public describeVpcPeeringConnectionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface —

getGameSessionLogUrl()

public getGameSessionLogUrl(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getGameSessionLogUrlAsync()

public getGameSessionLogUrlAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getInstanceAccess()

public getInstanceAccess(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getInstanceAccessAsync()

public getInstanceAccessAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

listAliases()

public listAliases(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listAliasesAsync()

public listAliasesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listBuilds()

public listBuilds(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listBuildsAsync()

public listBuildsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listFleets()

public listFleets(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listFleetsAsync()

public listFleetsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGameServerGroups()

public listGameServerGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGameServerGroupsAsync()

public listGameServerGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGameServers()

public listGameServers(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGameServersAsync()

public listGameServersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listScripts()

public listScripts(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listScriptsAsync()

public listScriptsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putScalingPolicy()

public putScalingPolicy(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putScalingPolicyAsync()

public putScalingPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

registerGameServer()

public registerGameServer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

registerGameServerAsync()

public registerGameServerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

requestUploadCredentials()

public requestUploadCredentials(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

requestUploadCredentialsAsync()

public requestUploadCredentialsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resolveAlias()

public resolveAlias(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resolveAliasAsync()

public resolveAliasAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resumeGameServerGroup()

public resumeGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resumeGameServerGroupAsync()

public resumeGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

searchGameSessions()

public searchGameSessions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

searchGameSessionsAsync()

public searchGameSessionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startFleetActions()

public startFleetActions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startFleetActionsAsync()

public startFleetActionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startGameSessionPlacement()

public startGameSessionPlacement(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startGameSessionPlacementAsync()

public startGameSessionPlacementAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMatchBackfill()

public startMatchBackfill(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMatchBackfillAsync()

public startMatchBackfillAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMatchmaking()

public startMatchmaking(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMatchmakingAsync()

public startMatchmakingAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopFleetActions()

public stopFleetActions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopFleetActionsAsync()

public stopFleetActionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopGameSessionPlacement()

public stopGameSessionPlacement(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopGameSessionPlacementAsync()

public stopGameSessionPlacementAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopMatchmaking()

public stopMatchmaking(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopMatchmakingAsync()

public stopMatchmakingAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

suspendGameServerGroup()

public suspendGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

suspendGameServerGroupAsync()

public suspendGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateAlias()

public updateAlias(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateAliasAsync()

public updateAliasAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateBuild()

public updateBuild(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateBuildAsync()

public updateBuildAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetAttributes()

public updateFleetAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetAttributesAsync()

public updateFleetAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetCapacity()

public updateFleetCapacity(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetCapacityAsync()

public updateFleetCapacityAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetPortSettings()

public updateFleetPortSettings(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateFleetPortSettingsAsync()

public updateFleetPortSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameServer()

public updateGameServer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameServerAsync()

public updateGameServerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameServerGroup()

public updateGameServerGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameServerGroupAsync()

public updateGameServerGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameSession()

public updateGameSession(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameSessionAsync()

public updateGameSessionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameSessionQueue()

public updateGameSessionQueue(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGameSessionQueueAsync()

public updateGameSessionQueueAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateMatchmakingConfiguration()

public updateMatchmakingConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateMatchmakingConfigurationAsync()

public updateMatchmakingConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateRuntimeConfiguration()

public updateRuntimeConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateRuntimeConfigurationAsync()

public updateRuntimeConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateScript()

public updateScript(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateScriptAsync()

public updateScriptAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

validateMatchmakingRuleSet()

public validateMatchmakingRuleSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

validateMatchmakingRuleSetAsync()

public validateMatchmakingRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results