Skip to content

NimbleStudioClient#

Index > NimbleStudio > NimbleStudioClient

Auto-generated documentation for NimbleStudio type annotations stubs module mypy-boto3-nimble.

NimbleStudioClient#

Type annotations and code completion for boto3.client("nimble"). boto3 documentation

# NimbleStudioClient usage example

from boto3.session import Session
from mypy_boto3_nimble.client import NimbleStudioClient

def get_nimble_client() -> NimbleStudioClient:
    return Session().client("nimble")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("nimble").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("nimble")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_nimble.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

accept_eulas#

Accept EULAs.

Type annotations and code completion for boto3.client("nimble").accept_eulas method. boto3 documentation

# accept_eulas method definition

def accept_eulas(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
    eulaIds: Sequence[str] = ...,
) -> AcceptEulasResponseTypeDef:  # (1)
    ...
  1. See AcceptEulasResponseTypeDef
# accept_eulas method usage example with argument unpacking

kwargs: AcceptEulasRequestRequestTypeDef = {  # (1)
    "studioId": ...,
}

parent.accept_eulas(**kwargs)
  1. See AcceptEulasRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("nimble").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("nimble").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_launch_profile#

Create a launch profile.

Type annotations and code completion for boto3.client("nimble").create_launch_profile method. boto3 documentation

# create_launch_profile method definition

def create_launch_profile(
    self,
    *,
    ec2SubnetIds: Sequence[str],
    launchProfileProtocolVersions: Sequence[str],
    name: str,
    streamConfiguration: StreamConfigurationCreateTypeDef,  # (1)
    studioComponentIds: Sequence[str],
    studioId: str,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateLaunchProfileResponseTypeDef:  # (2)
    ...
  1. See StreamConfigurationCreateTypeDef
  2. See CreateLaunchProfileResponseTypeDef
# create_launch_profile method usage example with argument unpacking

kwargs: CreateLaunchProfileRequestRequestTypeDef = {  # (1)
    "ec2SubnetIds": ...,
    "launchProfileProtocolVersions": ...,
    "name": ...,
    "streamConfiguration": ...,
    "studioComponentIds": ...,
    "studioId": ...,
}

parent.create_launch_profile(**kwargs)
  1. See CreateLaunchProfileRequestRequestTypeDef

create_streaming_image#

Creates a streaming image resource in a studio.

Type annotations and code completion for boto3.client("nimble").create_streaming_image method. boto3 documentation

# create_streaming_image method definition

def create_streaming_image(
    self,
    *,
    ec2ImageId: str,
    name: str,
    studioId: str,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateStreamingImageResponseTypeDef:  # (1)
    ...
  1. See CreateStreamingImageResponseTypeDef
# create_streaming_image method usage example with argument unpacking

kwargs: CreateStreamingImageRequestRequestTypeDef = {  # (1)
    "ec2ImageId": ...,
    "name": ...,
    "studioId": ...,
}

parent.create_streaming_image(**kwargs)
  1. See CreateStreamingImageRequestRequestTypeDef

create_streaming_session#

Creates a streaming session in a studio.

Type annotations and code completion for boto3.client("nimble").create_streaming_session method. boto3 documentation

# create_streaming_session method definition

def create_streaming_session(
    self,
    *,
    launchProfileId: str,
    studioId: str,
    clientToken: str = ...,
    ec2InstanceType: StreamingInstanceTypeType = ...,  # (1)
    ownedBy: str = ...,
    streamingImageId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateStreamingSessionResponseTypeDef:  # (2)
    ...
  1. See StreamingInstanceTypeType
  2. See CreateStreamingSessionResponseTypeDef
# create_streaming_session method usage example with argument unpacking

kwargs: CreateStreamingSessionRequestRequestTypeDef = {  # (1)
    "launchProfileId": ...,
    "studioId": ...,
}

parent.create_streaming_session(**kwargs)
  1. See CreateStreamingSessionRequestRequestTypeDef

create_streaming_session_stream#

Creates a streaming session stream for a streaming session.

Type annotations and code completion for boto3.client("nimble").create_streaming_session_stream method. boto3 documentation

# create_streaming_session_stream method definition

def create_streaming_session_stream(
    self,
    *,
    sessionId: str,
    studioId: str,
    clientToken: str = ...,
    expirationInSeconds: int = ...,
) -> CreateStreamingSessionStreamResponseTypeDef:  # (1)
    ...
  1. See CreateStreamingSessionStreamResponseTypeDef
# create_streaming_session_stream method usage example with argument unpacking

kwargs: CreateStreamingSessionStreamRequestRequestTypeDef = {  # (1)
    "sessionId": ...,
    "studioId": ...,
}

parent.create_streaming_session_stream(**kwargs)
  1. See CreateStreamingSessionStreamRequestRequestTypeDef

create_studio#

Create a new studio.

Type annotations and code completion for boto3.client("nimble").create_studio method. boto3 documentation

# create_studio method definition

def create_studio(
    self,
    *,
    adminRoleArn: str,
    displayName: str,
    studioName: str,
    userRoleArn: str,
    clientToken: str = ...,
    studioEncryptionConfiguration: StudioEncryptionConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateStudioResponseTypeDef:  # (2)
    ...
  1. See StudioEncryptionConfigurationTypeDef
  2. See CreateStudioResponseTypeDef
# create_studio method usage example with argument unpacking

kwargs: CreateStudioRequestRequestTypeDef = {  # (1)
    "adminRoleArn": ...,
    "displayName": ...,
    "studioName": ...,
    "userRoleArn": ...,
}

parent.create_studio(**kwargs)
  1. See CreateStudioRequestRequestTypeDef

create_studio_component#

Creates a studio component resource.

Type annotations and code completion for boto3.client("nimble").create_studio_component method. boto3 documentation

# create_studio_component method definition

def create_studio_component(
    self,
    *,
    name: str,
    studioId: str,
    type: StudioComponentTypeType,  # (1)
    clientToken: str = ...,
    configuration: Union[StudioComponentConfigurationTypeDef, StudioComponentConfigurationExtraOutputTypeDef] = ...,  # (2)
    description: str = ...,
    ec2SecurityGroupIds: Sequence[str] = ...,
    initializationScripts: Sequence[StudioComponentInitializationScriptTypeDef] = ...,  # (3)
    runtimeRoleArn: str = ...,
    scriptParameters: Sequence[ScriptParameterKeyValueTypeDef] = ...,  # (4)
    secureInitializationRoleArn: str = ...,
    subtype: StudioComponentSubtypeType = ...,  # (5)
    tags: Mapping[str, str] = ...,
) -> CreateStudioComponentResponseTypeDef:  # (6)
    ...
  1. See StudioComponentTypeType
  2. See StudioComponentConfigurationTypeDef StudioComponentConfigurationExtraOutputTypeDef
  3. See StudioComponentInitializationScriptTypeDef
  4. See ScriptParameterKeyValueTypeDef
  5. See StudioComponentSubtypeType
  6. See CreateStudioComponentResponseTypeDef
# create_studio_component method usage example with argument unpacking

kwargs: CreateStudioComponentRequestRequestTypeDef = {  # (1)
    "name": ...,
    "studioId": ...,
    "type": ...,
}

parent.create_studio_component(**kwargs)
  1. See CreateStudioComponentRequestRequestTypeDef

delete_launch_profile#

Permanently delete a launch profile.

Type annotations and code comple