GameLiftStreams / Paginator / ListStreamUrls

ListStreamUrls

class GameLiftStreams.Paginator.ListStreamUrls
paginator = client.get_paginator('list_stream_urls')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameLiftStreams.Client.list_stream_urls().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Status='ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
    StreamGroupIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • Status (string) –

    Filters the list to stream URLs with the specified status.

    • ACTIVE: The stream URL is valid and can start stream sessions.

    • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

    • REVOKED: The stream URL was revoked and can no longer start stream sessions.

    • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

  • StreamGroupIdentifier (string) –

    Filters the list to stream URLs that belong to the specified stream group.

    This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'StreamUrlId': 'string',
            'StreamUrl': 'string',
            'Status': 'ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
            'StatusReason': 'userRevoked'|'revokedAndTerminatingSessions'|'revokedAndSessionsTerminated'|'streamGroupDeleted'|'applicationDeleted',
            'ExpiresAt': datetime(2015, 1, 1),
            'CreatedAt': datetime(2015, 1, 1),
            'UsageLimit': 123,
            'RemainingUses': 123,
            'StreamGroupArn': 'string',
            'ApplicationArn': 'string',
            'SessionLengthSeconds': 123,
            'Description': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • Items (list) –

      A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.

      • (dict) –

        Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl.

        • Arn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID].

        • StreamUrlId (string) –

          The unique identifier for the stream URL resource, for example su-1AB2C3De4.

        • StreamUrl (string) –

          The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.

        • Status (string) –

          The current status of the stream URL. Possible statuses include the following:

          • ACTIVE: The stream URL is valid and can start stream sessions.

          • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

          • REVOKED: The stream URL was revoked and can no longer start stream sessions.

          • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

        • StatusReason (string) –

          Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

          • userRevoked: You revoked the stream URL.

          • revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

          • revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

          • streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

          • applicationDeleted: The application was deleted, which revoked the stream URL.

        • ExpiresAt (datetime) –

          The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

        • CreatedAt (datetime) –

          A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

        • UsageLimit (integer) –

          The maximum number of times the stream URL can start a stream session.

        • RemainingUses (integer) –

          The number of times the stream URL can still be used to start a stream session.

        • StreamGroupArn (string) –

          The stream group that runs the stream sessions.

          This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

        • ApplicationArn (string) –

          The application that runs in the stream sessions.

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

        • SessionLengthSeconds (integer) –

          The maximum length of time, in seconds, that a stream session started from this stream URL can run.

        • Description (string) –

          The descriptive label for the stream URL.