NimbleStudio / Client / list_studio_components

list_studio_components

NimbleStudio.Client.list_studio_components(**kwargs)

Lists the StudioComponents in a studio.

See also: AWS API Documentation

Request Syntax

response = client.list_studio_components(
    maxResults=123,
    nextToken='string',
    states=[
        'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
    ],
    studioId='string',
    types=[
        'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
    ]
)

Parameters:

• maxResults (integer) – The max number of results to return in the response.

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

• states (list) –

  Filters the request to studio components that are in one of the given states.

  • (string) –

    The current state of the studio component resource.

    While a studio component is being created, modified, or deleted, its state will be CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, or DELETE_IN_PROGRESS.

    These are called transition states.

    No modifications may be made to the studio component while it is in a transition state.

    If creation of the resource fails, the state will change to CREATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.

    If updating the resource fails, the state will change to UPDATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.

    If deleting the resource fails, the state will change to DELETE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the DELETED state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.

• studioId (string) –

  [REQUIRED]

  The studio ID.

• types (list) –

  Filters the request to studio components that are of one of the given types.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'studioComponents': [
        {
            'arn': 'string',
            'configuration': {
                'activeDirectoryConfiguration': {
                    'computerAttributes': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'directoryId': 'string',
                    'organizationalUnitDistinguishedName': 'string'
                },
                'computeFarmConfiguration': {
                    'activeDirectoryUser': 'string',
                    'endpoint': 'string'
                },
                'licenseServiceConfiguration': {
                    'endpoint': 'string'
                },
                'sharedFileSystemConfiguration': {
                    'endpoint': 'string',
                    'fileSystemId': 'string',
                    'linuxMountPoint': 'string',
                    'shareName': 'string',
                    'windowsMountDrive': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'ec2SecurityGroupIds': [
                'string',
            ],
            'initializationScripts': [
                {
                    'launchProfileProtocolVersion': 'string',
                    'platform': 'LINUX'|'WINDOWS',
                    'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                    'script': 'string'
                },
            ],
            'name': 'string',
            'runtimeRoleArn': 'string',
            'scriptParameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'secureInitializationRoleArn': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
            'statusMessage': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'tags': {
                'string': 'string'
            },
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

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

  • studioComponents (list) –

    A collection of studio components.

    • (dict) –

      A studio component represents a network resource to be used by a studio’s users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.

      Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

      A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.

      • arn (string) –

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

      • configuration (dict) –

        The configuration of the studio component, based on component type.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • activeDirectoryConfiguration (dict) –

          The configuration for a Directory Service for Microsoft Active Directory studio resource.

          • computerAttributes (list) –

            A collection of custom attributes for an Active Directory computer.

            • (dict) –

              An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

              • name (string) –

                The name for the LDAP attribute.

              • value (string) –

                The value for the LDAP attribute.

          • directoryId (string) –

            The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.

          • organizationalUnitDistinguishedName (string) –

            The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

        • computeFarmConfiguration (dict) –

          The configuration for a render farm that is associated with a studio resource.

          • activeDirectoryUser (string) –

            The name of an Active Directory user that is used on ComputeFarm worker instances.

          • endpoint (string) –

            The endpoint of the ComputeFarm that is accessed by the studio component resource.

        • licenseServiceConfiguration (dict) –

          The configuration for a license service that is associated with a studio resource.

          • endpoint (string) –

            The endpoint of the license service that is accessed by the studio component resource.

        • sharedFileSystemConfiguration (dict) –

          The configuration for a shared file storage system that is associated with a studio resource.

          • endpoint (string) –

            The endpoint of the shared file system that is accessed by the studio component resource.

          • fileSystemId (string) –

            The unique identifier for a file system.

          • linuxMountPoint (string) –

            The mount location for a shared file system on a Linux virtual workstation.

          • shareName (string) –

            The name of the file share.

          • windowsMountDrive (string) –

            The mount location for a shared file system on a Windows virtual workstation.

      • createdAt (datetime) –

        The ISO timestamp in seconds for when the resource was created.

      • createdBy (string) –

        The user ID of the user that created the studio component.

      • description (string) –

        A human-readable description for the studio component resource.

      • ec2SecurityGroupIds (list) –

        The EC2 security groups that control access to the studio component.

        • (string) –

      • initializationScripts (list) –

        Initialization scripts for studio components.

        • (dict) –

          Initialization scripts for studio components.

          • launchProfileProtocolVersion (string) –

            The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.

          • platform (string) –

            The platform of the initialization script, either Windows or Linux.

          • runContext (string) –

            The method to use when running the initialization script.

          • script (string) –

            The initialization script.

      • name (string) –

        A friendly name for the studio component resource.

      • runtimeRoleArn (string) –

        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

      • scriptParameters (list) –

        Parameters for the studio component scripts.

        • (dict) –

          A parameter for a studio component script, in the form of a key-value pair.

          • key (string) –

            A script parameter key.

          • value (string) –

            A script parameter value.

      • secureInitializationRoleArn (string) –

        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

      • state (string) –

        The current state.

      • statusCode (string) –

        The status code.

      • statusMessage (string) –

        The status message for the studio component.

      • studioComponentId (string) –

        The unique identifier for a studio component resource.

      • subtype (string) –

        The specific subtype of a studio component.

      • tags (dict) –

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

        • (string) –

          • (string) –

      • type (string) –

        The type of the studio component.

      • updatedAt (datetime) –

        The ISO timestamp in seconds for when the resource was updated.

      • updatedBy (string) –

        The user ID of the user that most recently updated the resource.

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