NimbleStudio / Client / get_studio_component

get_studio_component

NimbleStudio.Client.get_studio_component(**kwargs)

Gets a studio component resource.

See also: AWS API Documentation

Request Syntax

response = client.get_studio_component(
    studioComponentId='string',
    studioId='string'
)

Parameters:

• studioComponentId (string) –

  [REQUIRED]

  The studio component ID.

• studioId (string) –

  [REQUIRED]

  The studio ID.

Return type:

dict

Returns:

Response Syntax

{
    'studioComponent': {
        '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) –

  • studioComponent (dict) –

    Information about the studio component.

    • 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