NimbleStudio / Client / get_launch_profile_initialization

get_launch_profile_initialization#

NimbleStudio.Client.get_launch_profile_initialization(**kwargs)#

Get a launch profile initialization.

See also: AWS API Documentation

Request Syntax

response = client.get_launch_profile_initialization(
    launchProfileId='string',
    launchProfileProtocolVersions=[
        'string',
    ],
    launchPurpose='string',
    platform='string',
    studioId='string'
)
Parameters:
  • launchProfileId (string) –

    [REQUIRED]

    The ID of the launch profile used to control access from the streaming session.

  • launchProfileProtocolVersions (list) –

    [REQUIRED]

    The launch profile protocol versions supported by the client.

    • (string) –

  • launchPurpose (string) –

    [REQUIRED]

    The launch purpose.

  • platform (string) –

    [REQUIRED]

    The platform where this Launch Profile will be used, either Windows or Linux.

  • studioId (string) –

    [REQUIRED]

    The studio ID.

Return type:

dict

Returns:

Response Syntax

{
    'launchProfileInitialization': {
        'activeDirectory': {
            'computerAttributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'directoryId': 'string',
            'directoryName': 'string',
            'dnsIpAddresses': [
                'string',
            ],
            'organizationalUnitDistinguishedName': 'string',
            'studioComponentId': 'string',
            'studioComponentName': 'string'
        },
        'ec2SecurityGroupIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersion': 'string',
        'launchPurpose': 'string',
        'name': 'string',
        'platform': 'LINUX'|'WINDOWS',
        'systemInitializationScripts': [
            {
                'runtimeRoleArn': 'string',
                'script': 'string',
                'secureInitializationRoleArn': 'string',
                'studioComponentId': 'string',
                'studioComponentName': 'string'
            },
        ],
        'userInitializationScripts': [
            {
                'runtimeRoleArn': 'string',
                'script': 'string',
                'secureInitializationRoleArn': 'string',
                'studioComponentId': 'string',
                'studioComponentName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • launchProfileInitialization (dict) –

      The launch profile initialization.

      • activeDirectory (dict) –

        A LaunchProfileInitializationActiveDirectory 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 launch profile.

        • directoryName (string) –

          The directory name.

        • dnsIpAddresses (list) –

          The DNS IP address.

          • (string) –

        • organizationalUnitDistinguishedName (string) –

          The name for the organizational unit distinguished name.

        • studioComponentId (string) –

          The unique identifier for a studio component resource.

        • studioComponentName (string) –

          The name for the studio component.

      • ec2SecurityGroupIds (list) –

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

        • (string) –

      • launchProfileId (string) –

        The ID of the launch profile used to control access from the streaming session.

      • launchProfileProtocolVersion (string) –

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

      • launchPurpose (string) –

        The launch purpose.

      • name (string) –

        The name for the launch profile.

      • platform (string) –

        The platform of the launch platform, either Windows or Linux.

      • systemInitializationScripts (list) –

        The system initializtion scripts.

        • (dict) –

          The launch profile initialization script is used when start streaming session runs.

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

          • script (string) –

            The initialization script.

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

          • studioComponentId (string) –

            The unique identifier for a studio component resource.

          • studioComponentName (string) –

            The name for the studio component.

      • userInitializationScripts (list) –

        The user initializtion scripts.

        • (dict) –

          The launch profile initialization script is used when start streaming session runs.

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

          • script (string) –

            The initialization script.

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

          • studioComponentId (string) –

            The unique identifier for a studio component resource.

          • studioComponentName (string) –

            The name for the studio component.

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