View a markdown version of this page

ListApplicationShaderCaches - Amazon GameLift Streams

ListApplicationShaderCaches

Lists the shader caches associated with an Amazon GameLift Streams application. Each shader cache entry includes its status, associated stream groups, and size in bytes.

Returns shader caches associated with the specified Amazon GameLift Streams application in all statuses.

Request Syntax

GET /applications/Identifier/shadercaches HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Items": [ { "ApplicationArn": "string", "AssociatedStreamGroups": [ "string" ], "Identifier": "string", "LastUpdatedAt": number, "Status": "string", "StorageBytes": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Items

A collection of shader cache metadata for the specified Amazon GameLift Streams application. Each item includes the shader cache status, associated stream groups, and storage size.

Type: Array of ShaderCacheSummary objects

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.

Message

Description of the error.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error and is unable to complete the request.

Message

Description of the error.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found. Correct the request before you try again.

Message

Description of the error.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Retry the request after the suggested wait time.

Message

Description of the error.

HTTP Status Code: 429

ValidationException

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.

Message

Description of the error.

HTTP Status Code: 400

Examples

CLI Example

The following example shows how to use the AWS CLI to list shader caches for a Amazon GameLift Streams application.

Sample Request

aws gameliftstreams list-application-shader-caches \ --identifier arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: