NimbleStudio / Paginator / ListStreamingImages

ListStreamingImages

class NimbleStudio.Paginator.ListStreamingImages

paginator = client.get_paginator('list_streaming_images')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• owner (string) – Filter this request to streaming images with the given owner

• 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

{
    'streamingImages': [
        {
            'arn': 'string',
            'description': 'string',
            'ec2ImageId': 'string',
            'encryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'CUSTOMER_MANAGED_KEY'
            },
            'eulaIds': [
                'string',
            ],
            'name': 'string',
            'owner': 'string',
            'platform': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • streamingImages (list) –

    A collection of streaming images.

    • (dict) –

      Represents a streaming image resource.

      Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

      Amazon provides a number of streaming images that include popular 3rd-party software.

      You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.

      • arn (string) –

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

      • description (string) –

        A human-readable description of the streaming image.

      • ec2ImageId (string) –

        The ID of an EC2 machine image with which to create the streaming image.

      • encryptionConfiguration (dict) –

        The encryption configuration.

        • keyArn (string) –

          The ARN for a KMS key that is used to encrypt studio data.

        • keyType (string) –

          The type of KMS key that is used to encrypt studio data.

      • eulaIds (list) –

        The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • (string) –

      • name (string) –

        A friendly name for a streaming image resource.

      • owner (string) –

        The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.

      • platform (string) –

        The platform of the streaming image, either Windows or Linux.

      • state (string) –

        The current state.

      • statusCode (string) –

        The status code.

      • statusMessage (string) –

        The status message for the streaming image.

      • streamingImageId (string) –

        The ID of the streaming image.

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