NimbleStudio / Paginator / ListStreamingSessionBackups

ListStreamingSessionBackups

class NimbleStudio.Paginator.ListStreamingSessionBackups

paginator = client.get_paginator('list_streaming_session_backups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NimbleStudio.Client.list_streaming_session_backups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ownedBy='string',
    studioId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ownedBy (string) – The user ID of the user that owns the streaming session.

• studioId (string) –

  [REQUIRED]

  The studio ID.

• 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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'streamingSessionBackups': [
        {
            'arn': 'string',
            'backupId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'launchProfileId': 'string',
            'ownedBy': 'string',
            'sessionId': 'string',
            'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED'|'STOP_IN_PROGRESS'|'START_IN_PROGRESS'|'STOPPED'|'STOP_FAILED'|'START_FAILED',
            'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR'|'STREAMING_SESSION_STOPPED'|'STREAMING_SESSION_STARTED'|'STREAMING_SESSION_STOP_IN_PROGRESS'|'STREAMING_SESSION_START_IN_PROGRESS'|'AMI_VALIDATION_ERROR',
            'statusMessage': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • streamingSessionBackups (list) –

    Information about the streaming session backups.

    • (dict) –

      Information about the streaming session backup.

      • arn (string) –

        The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • backupId (string) –

        The ID of the backup.

      • createdAt (datetime) –

        The ISO timestamp in for when the resource was created.

      • launchProfileId (string) –

        The ID of the launch profile which allowed the backups for the streaming session.

      • ownedBy (string) –

        The user ID of the user that owns the streaming session.

      • sessionId (string) –

        The streaming session ID for the StreamingSessionBackup.

      • state (string) –

        The streaming session state.

      • statusCode (string) –

        The status code.

      • statusMessage (string) –

        The status message for the streaming session backup.

      • tags (dict) –

        A collection of labels, in the form of key-value pairs, that apply to this resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.