Skip to content

ShaderCacheSummary

Source code in docs_src/capo_gameliftstreams/types/shader_cache_summary.py
class ShaderCacheSummary(TypedDict, closed=True):
    identifier: "capo_gameliftstreams.types.identifier.Identifier"
    """<p>A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is <code>1271e693c50b940e228582f1ccdd4e27</code>.</p>"""
    application_arn: "capo_gameliftstreams.types.arn.Arn"
    """<p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the application resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>"""
    status: NotRequired[
        "capo_gameliftstreams.types.shader_cache_status.ShaderCacheStatus"
    ]
    """<p>The current status of the shader cache. Possible statuses include the following:</p> <ul> <li> <p> <code>INITIALIZED</code>: Amazon GameLift Streams received the request and is preparing the shader cache.</p> </li> <li> <p> <code>PROCESSING</code>: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.</p> </li> <li> <p> <code>READY</code>: The shader cache is replicated and available for use in stream sessions.</p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is deleting the shader cache.</p> </li> <li> <p> <code>ERROR</code>: An error occurred during shader cache processing. Create a new shader cache to try again.</p> </li> </ul>"""
    last_updated_at: NotRequired["datetime.datetime"]
    """<p>A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>"""
    storage_bytes: NotRequired["int"]
    """<p>The total storage used by all compiled shader files in this shader cache, in bytes.</p>"""
    associated_stream_groups: NotRequired["capo_gameliftstreams.types.arn_list.ArnList"]
    """<p>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 <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/shader-caches.html">Shader caches</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p> <p>This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify stream group resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>"""

application_arn instance-attribute

application_arn: Arn

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

associated_stream_groups instance-attribute

associated_stream_groups: NotRequired[ArnList]

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.

identifier instance-attribute

identifier: Identifier

A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.

last_updated_at instance-attribute

last_updated_at: NotRequired[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).

status instance-attribute

status: NotRequired[ShaderCacheStatus]

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.

storage_bytes instance-attribute

storage_bytes: NotRequired[int]

The total storage used by all compiled shader files in this shader cache, in bytes.