NimbleStudio / Paginator / ListStudios

ListStudios#

class NimbleStudio.Paginator.ListStudios#

paginator = client.get_paginator('list_studios')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

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

{
    'studios': [
        {
            'adminRoleArn': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'displayName': 'string',
            'homeRegion': 'string',
            'ssoClientId': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
            'statusMessage': 'string',
            'studioEncryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
            },
            'studioId': 'string',
            'studioName': 'string',
            'studioUrl': 'string',
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1),
            'userRoleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- studios (list) –
  
  A collection of studios.
  - (dict) –
    
    Represents a studio resource.
    
    A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.
    
    When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.
    
    The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
    
    The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
    
    Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.
    - adminRoleArn (string) –
      
      The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    - arn (string) –
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - createdAt (datetime) –
      
      The ISO timestamp in seconds for when the resource was created.
    - displayName (string) –
      
      A friendly name for the studio.
    - homeRegion (string) –
      
      The Amazon Web Services Region where the studio resource is located.
    - ssoClientId (string) –
      
      The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
    - state (string) –
      
      The current state of the studio resource.
    - statusCode (string) –
      
      Status codes that provide additional detail on the studio state.
    - statusMessage (string) –
      
      Additional detail on the studio state.
    - studioEncryptionConfiguration (dict) –
      
      Configuration of the encryption method that is used for the studio.
      - 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.
    - studioId (string) –
      
      The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    - studioName (string) –
      
      The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    - studioUrl (string) –
      
      The address of the web page for the studio.
    - tags (dict) –
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) –
        
        (string) –
    - updatedAt (datetime) –
      
      The ISO timestamp in seconds for when the resource was updated.
    - userRoleArn (string) –
      
      The IAM role that studio users assume when logging in to the Nimble Studio portal.
- NextToken (string) –
  
  A token to resume pagination.