GameLiftStreams / Client / list_application_shader_caches

list_application_shader_caches¶

GameLiftStreams.Client.list_application_shader_caches(**kwargs)¶

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

response = client.list_application_shader_caches(
    Identifier='string'
)

Parameters:

Identifier (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Identifier': 'string',
            'ApplicationArn': 'string',
            'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR',
            'LastUpdatedAt': datetime(2015, 1, 1),
            'StorageBytes': 123,
            'AssociatedStreamGroups': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) –
- Items (list) –
  
  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.
  - (dict) –
    
    Describes a shader cache associated with an Amazon GameLift Streams application.
    - Identifier (string) –
      
      A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.
    - ApplicationArn (string) –
      
      An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
    - Status (string) –
      
      The current status of the shader cache. Possible statuses include the following:
      - INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.
      - PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.
      - READY: The shader cache is replicated and available for use in stream sessions.
      - DELETING: Amazon GameLift Streams is deleting the shader cache.
      - ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.
    - LastUpdatedAt (datetime) –
      
      A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
    - StorageBytes (integer) –
      
      The total storage used by all compiled shader files in this shader cache, in bytes.
    - AssociatedStreamGroups (list) –
      
      The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.
      
      This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
      - (string) –

Exceptions

GameLiftStreams.Client.exceptions.AccessDeniedException
GameLiftStreams.Client.exceptions.ResourceNotFoundException
GameLiftStreams.Client.exceptions.ThrottlingException
GameLiftStreams.Client.exceptions.InternalServerException
GameLiftStreams.Client.exceptions.ValidationException