NimbleStudio / Client / list_streaming_images

list_streaming_images

NimbleStudio.Client.list_streaming_images(**kwargs)

List the streaming image resources available to this studio.

This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

See also: AWS API Documentation

Request Syntax

response = client.list_streaming_images(
    nextToken='string',
    owner='string',
    studioId='string'
)

Parameters:

• nextToken (string) – The token for the next set of results, or null if there are no more results.

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

• studioId (string) –

  [REQUIRED]

  The studio ID.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
            }
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    The token for the next set of results, or null if there are no more results.

  • 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) –

Exceptions

• NimbleStudio.Client.exceptions.ResourceNotFoundException

• NimbleStudio.Client.exceptions.ConflictException

• NimbleStudio.Client.exceptions.ThrottlingException

• NimbleStudio.Client.exceptions.ValidationException

• NimbleStudio.Client.exceptions.AccessDeniedException

• NimbleStudio.Client.exceptions.InternalServerErrorException

• NimbleStudio.Client.exceptions.ServiceQuotaExceededException