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: StudioComponentConfigurationTypeDef = ...,  # (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
  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 completion for boto3.client("nimble").delete_launch_profile method. boto3 documentation

# delete_launch_profile method definition

def delete_launch_profile(
    self,
    *,
    launchProfileId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteLaunchProfileResponseTypeDef:  # (1)
    ...
  1. See DeleteLaunchProfileResponseTypeDef
# delete_launch_profile method usage example with argument unpacking

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

parent.delete_launch_profile(**kwargs)
  1. See DeleteLaunchProfileRequestRequestTypeDef

delete_launch_profile_member#

Delete a user from launch profile membership.

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

# delete_launch_profile_member method definition

def delete_launch_profile_member(
    self,
    *,
    launchProfileId: str,
    principalId: str,
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
# delete_launch_profile_member method usage example with argument unpacking

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

parent.delete_launch_profile_member(**kwargs)
  1. See DeleteLaunchProfileMemberRequestRequestTypeDef

delete_streaming_image#

Delete streaming image.

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

# delete_streaming_image method definition

def delete_streaming_image(
    self,
    *,
    streamingImageId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStreamingImageResponseTypeDef:  # (1)
    ...
  1. See DeleteStreamingImageResponseTypeDef
# delete_streaming_image method usage example with argument unpacking

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

parent.delete_streaming_image(**kwargs)
  1. See DeleteStreamingImageRequestRequestTypeDef

delete_streaming_session#

Deletes streaming session resource.

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

# delete_streaming_session method definition

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

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

parent.delete_streaming_session(**kwargs)
  1. See DeleteStreamingSessionRequestRequestTypeDef

delete_studio#

Delete a studio resource.

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

# delete_studio method definition

def delete_studio(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStudioResponseTypeDef:  # (1)
    ...
  1. See DeleteStudioResponseTypeDef
# delete_studio method usage example with argument unpacking

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

parent.delete_studio(**kwargs)
  1. See DeleteStudioRequestRequestTypeDef

delete_studio_component#

Deletes a studio component resource.

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

# delete_studio_component method definition

def delete_studio_component(
    self,
    *,
    studioComponentId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStudioComponentResponseTypeDef:  # (1)
    ...
  1. See DeleteStudioComponentResponseTypeDef
# delete_studio_component method usage example with argument unpacking

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

parent.delete_studio_component(**kwargs)
  1. See DeleteStudioComponentRequestRequestTypeDef

delete_studio_member#

Delete a user from studio membership.

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

# delete_studio_member method definition

def delete_studio_member(
    self,
    *,
    principalId: str,
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
# delete_studio_member method usage example with argument unpacking

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

parent.delete_studio_member(**kwargs)
  1. See DeleteStudioMemberRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_eula#

Get EULA.

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

# get_eula method definition

def get_eula(
    self,
    *,
    eulaId: str,
) -> GetEulaResponseTypeDef:  # (1)
    ...
  1. See GetEulaResponseTypeDef
# get_eula method usage example with argument unpacking

kwargs: GetEulaRequestRequestTypeDef = {  # (1)
    "eulaId": ...,
}

parent.get_eula(**kwargs)
  1. See GetEulaRequestRequestTypeDef

get_launch_profile#

Get a launch profile.

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

# get_launch_profile method definition

def get_launch_profile(
    self,
    *,
    launchProfileId: str,
    studioId: str,
) -> GetLaunchProfileResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileResponseTypeDef
# get_launch_profile method usage example with argument unpacking

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

parent.get_launch_profile(**kwargs)
  1. See GetLaunchProfileRequestRequestTypeDef

get_launch_profile_details#

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.

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

# get_launch_profile_details method definition

def get_launch_profile_details(
    self,
    *,
    launchProfileId: str,
    studioId: str,
) -> GetLaunchProfileDetailsResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileDetailsResponseTypeDef
# get_launch_profile_details method usage example with argument unpacking

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

parent.get_launch_profile_details(**kwargs)
  1. See GetLaunchProfileDetailsRequestRequestTypeDef

get_launch_profile_initialization#

Get a launch profile initialization.

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

# get_launch_profile_initialization method definition

def get_launch_profile_initialization(
    self,
    *,
    launchProfileId: str,
    launchProfileProtocolVersions: Sequence[str],
    launchPurpose: str,
    platform: str,
    studioId: str,
) -> GetLaunchProfileInitializationResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileInitializationResponseTypeDef
# get_launch_profile_initialization method usage example with argument unpacking

kwargs: GetLaunchProfileInitializationRequestRequestTypeDef = {  # (1)
    "launchProfileId": ...,
    "launchProfileProtocolVersions": ...,
    "launchPurpose": ...,
    "platform": ...,
    "studioId": ...,
}

parent.get_launch_profile_initialization(**kwargs)
  1. See GetLaunchProfileInitializationRequestRequestTypeDef

get_launch_profile_member#

Get a user persona in launch profile membership.

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

# get_launch_profile_member method definition

def get_launch_profile_member(
    self,
    *,
    launchProfileId: str,
    principalId: str,
    studioId: str,
) -> GetLaunchProfileMemberResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileMemberResponseTypeDef
# get_launch_profile_member method usage example with argument unpacking

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

parent.get_launch_profile_member(**kwargs)
  1. See GetLaunchProfileMemberRequestRequestTypeDef

get_streaming_image#

Get streaming image.

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

# get_streaming_image method definition

def get_streaming_image(
    self,
    *,
    streamingImageId: str,
    studioId: str,
) -> GetStreamingImageResponseTypeDef:  # (1)
    ...
  1. See GetStreamingImageResponseTypeDef
# get_streaming_image method usage example with argument unpacking

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

parent.get_streaming_image(**kwargs)
  1. See GetStreamingImageRequestRequestTypeDef

get_streaming_session#

Gets StreamingSession resource.

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

# get_streaming_session method definition

def get_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
) -> GetStreamingSessionResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionResponseTypeDef
# get_streaming_session method usage example with argument unpacking

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

parent.get_streaming_session(**kwargs)
  1. See GetStreamingSessionRequestRequestTypeDef

get_streaming_session_backup#

Gets StreamingSessionBackup resource.

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

# get_streaming_session_backup method definition

def get_streaming_session_backup(
    self,
    *,
    backupId: str,
    studioId: str,
) -> GetStreamingSessionBackupResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionBackupResponseTypeDef
# get_streaming_session_backup method usage example with argument unpacking

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

parent.get_streaming_session_backup(**kwargs)
  1. See GetStreamingSessionBackupRequestRequestTypeDef

get_streaming_session_stream#

Gets a StreamingSessionStream for a streaming session.

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

# get_streaming_session_stream method definition

def get_streaming_session_stream(
    self,
    *,
    sessionId: str,
    streamId: str,
    studioId: str,
) -> GetStreamingSessionStreamResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionStreamResponseTypeDef
# get_streaming_session_stream method usage example with argument unpacking

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

parent.get_streaming_session_stream(**kwargs)
  1. See GetStreamingSessionStreamRequestRequestTypeDef

get_studio#

Get a studio resource.

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

# get_studio method definition

def get_studio(
    self,
    *,
    studioId: str,
) -> GetStudioResponseTypeDef:  # (1)
    ...
  1. See GetStudioResponseTypeDef
# get_studio method usage example with argument unpacking

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

parent.get_studio(**kwargs)
  1. See GetStudioRequestRequestTypeDef

get_studio_component#

Gets a studio component resource.

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

# get_studio_component method definition

def get_studio_component(
    self,
    *,
    studioComponentId: str,
    studioId: str,
) -> GetStudioComponentResponseTypeDef:  # (1)
    ...
  1. See GetStudioComponentResponseTypeDef
# get_studio_component method usage example with argument unpacking

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

parent.get_studio_component(**kwargs)
  1. See GetStudioComponentRequestRequestTypeDef

get_studio_member#

Get a user's membership in a studio.

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

# get_studio_member method definition

def get_studio_member(
    self,
    *,
    principalId: str,
    studioId: str,
) -> GetStudioMemberResponseTypeDef:  # (1)
    ...
  1. See GetStudioMemberResponseTypeDef
# get_studio_member method usage example with argument unpacking

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

parent.get_studio_member(**kwargs)
  1. See GetStudioMemberRequestRequestTypeDef

list_eula_acceptances#

List EULA acceptances.

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

# list_eula_acceptances method definition

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

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

parent.list_eula_acceptances(**kwargs)
  1. See ListEulaAcceptancesRequestRequestTypeDef

list_eulas#

List EULAs.

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

# list_eulas method definition

def list_eulas(
    self,
    *,
    eulaIds: Sequence[str] = ...,
    nextToken: str = ...,
) -> ListEulasResponseTypeDef:  # (1)
    ...
  1. See ListEulasResponseTypeDef
# list_eulas method usage example with argument unpacking

kwargs: ListEulasRequestRequestTypeDef = {  # (1)
    "eulaIds": ...,
}

parent.list_eulas(**kwargs)
  1. See ListEulasRequestRequestTypeDef

list_launch_profile_members#

Get all users in a given launch profile membership.

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

# list_launch_profile_members method definition

def list_launch_profile_members(
    self,
    *,
    launchProfileId: str,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLaunchProfileMembersResponseTypeDef:  # (1)
    ...
  1. See ListLaunchProfileMembersResponseTypeDef
# list_launch_profile_members method usage example with argument unpacking

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

parent.list_launch_profile_members(**kwargs)
  1. See ListLaunchProfileMembersRequestRequestTypeDef

list_launch_profiles#

List all the launch profiles a studio.

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

# list_launch_profiles method definition

def list_launch_profiles(
    self,
    *,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    principalId: str = ...,
    states: Sequence[LaunchProfileStateType] = ...,  # (1)
) -> ListLaunchProfilesResponseTypeDef:  # (2)
    ...
  1. See LaunchProfileStateType
  2. See ListLaunchProfilesResponseTypeDef
# list_launch_profiles method usage example with argument unpacking

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

parent.list_launch_profiles(**kwargs)
  1. See ListLaunchProfilesRequestRequestTypeDef

list_streaming_images#

List the streaming image resources available to this studio.

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

# list_streaming_images method definition

def list_streaming_images(
    self,
    *,
    studioId: str,
    nextToken: str = ...,
    owner: str = ...,
) -> ListStreamingImagesResponseTypeDef:  # (1)
    ...
  1. See ListStreamingImagesResponseTypeDef
# list_streaming_images method usage example with argument unpacking

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

parent.list_streaming_images(**kwargs)
  1. See ListStreamingImagesRequestRequestTypeDef

list_streaming_session_backups#

Lists the backups of a streaming session in a studio.

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

# list_streaming_session_backups method definition

def list_streaming_session_backups(
    self,
    *,
    studioId: str,
    nextToken: str = ...,
    ownedBy: str = ...,
) -> ListStreamingSessionBackupsResponseTypeDef:  # (1)
    ...
  1. See ListStreamingSessionBackupsResponseTypeDef
# list_streaming_session_backups method usage example with argument unpacking

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

parent.list_streaming_session_backups(**kwargs)
  1. See ListStreamingSessionBackupsRequestRequestTypeDef

list_streaming_sessions#

Lists the streaming sessions in a studio.

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

# list_streaming_sessions method definition

def list_streaming_sessions(
    self,
    *,
    studioId: str,
    createdBy: str = ...,
    nextToken: str = ...,
    ownedBy: str = ...,
    sessionIds: str = ...,
) -> ListStreamingSessionsResponseTypeDef:  # (1)
    ...
  1. See ListStreamingSessionsResponseTypeDef
# list_streaming_sessions method usage example with argument unpacking

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

parent.list_streaming_sessions(**kwargs)
  1. See ListStreamingSessionsRequestRequestTypeDef

list_studio_components#

Lists the StudioComponents in a studio.

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

# list_studio_components method definition

def list_studio_components(
    self,
    *,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    states: Sequence[StudioComponentStateType] = ...,  # (1)
    types: Sequence[StudioComponentTypeType] = ...,  # (2)
) -> ListStudioComponentsResponseTypeDef:  # (3)
    ...
  1. See StudioComponentStateType
  2. See StudioComponentTypeType
  3. See ListStudioComponentsResponseTypeDef
# list_studio_components method usage example with argument unpacking

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

parent.list_studio_components(**kwargs)
  1. See ListStudioComponentsRequestRequestTypeDef

list_studio_members#

Get all users in a given studio membership.

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

# list_studio_members method definition

def list_studio_members(
    self,
    *,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStudioMembersResponseTypeDef:  # (1)
    ...
  1. See ListStudioMembersResponseTypeDef
# list_studio_members method usage example with argument unpacking

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

parent.list_studio_members(**kwargs)
  1. See ListStudioMembersRequestRequestTypeDef

list_studios#

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

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

# list_studios method definition

def list_studios(
    self,
    *,
    nextToken: str = ...,
) -> ListStudiosResponseTypeDef:  # (1)
    ...
  1. See ListStudiosResponseTypeDef
# list_studios method usage example with argument unpacking

kwargs: ListStudiosRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_studios(**kwargs)
  1. See ListStudiosRequestRequestTypeDef

list_tags_for_resource#

Gets the tags for a resource, given its Amazon Resource Names (ARN).

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_launch_profile_members#

Add/update users with given persona to launch profile membership.

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

# put_launch_profile_members method definition

def put_launch_profile_members(
    self,
    *,
    identityStoreId: str,
    launchProfileId: str,
    members: Sequence[NewLaunchProfileMemberTypeDef],  # (1)
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See NewLaunchProfileMemberTypeDef
# put_launch_profile_members method usage example with argument unpacking

kwargs: PutLaunchProfileMembersRequestRequestTypeDef = {  # (1)
    "identityStoreId": ...,
    "launchProfileId": ...,
    "members": ...,
    "studioId": ...,
}

parent.put_launch_profile_members(**kwargs)
  1. See PutLaunchProfileMembersRequestRequestTypeDef

put_studio_members#

Add/update users with given persona to studio membership.

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

# put_studio_members method definition

def put_studio_members(
    self,
    *,
    identityStoreId: str,
    members: Sequence[NewStudioMemberTypeDef],  # (1)
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See NewStudioMemberTypeDef
# put_studio_members method usage example with argument unpacking

kwargs: PutStudioMembersRequestRequestTypeDef = {  # (1)
    "identityStoreId": ...,
    "members": ...,
    "studioId": ...,
}

parent.put_studio_members(**kwargs)
  1. See PutStudioMembersRequestRequestTypeDef

start_streaming_session#

Transitions sessions from the STOPPED state into the READY state.

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

# start_streaming_session method definition

def start_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
    backupId: str = ...,
    clientToken: str = ...,
) -> StartStreamingSessionResponseTypeDef:  # (1)
    ...
  1. See StartStreamingSessionResponseTypeDef
# start_streaming_session method usage example with argument unpacking

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

parent.start_streaming_session(**kwargs)
  1. See StartStreamingSessionRequestRequestTypeDef

start_studio_sso_configuration_repair#

Repairs the IAM Identity Center configuration for a given studio.

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

# start_studio_sso_configuration_repair method definition

def start_studio_sso_configuration_repair(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
) -> StartStudioSSOConfigurationRepairResponseTypeDef:  # (1)
    ...
  1. See StartStudioSSOConfigurationRepairResponseTypeDef
# start_studio_sso_configuration_repair method usage example with argument unpacking

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

parent.start_studio_sso_configuration_repair(**kwargs)
  1. See StartStudioSSOConfigurationRepairRequestRequestTypeDef

stop_streaming_session#

Transitions sessions from the READY state into the STOPPED state.

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

# stop_streaming_session method definition

def stop_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
    clientToken: str = ...,
    volumeRetentionMode: VolumeRetentionModeType = ...,  # (1)
) -> StopStreamingSessionResponseTypeDef:  # (2)
    ...
  1. See VolumeRetentionModeType
  2. See StopStreamingSessionResponseTypeDef
# stop_streaming_session method usage example with argument unpacking

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

parent.stop_streaming_session(**kwargs)
  1. See StopStreamingSessionRequestRequestTypeDef

tag_resource#

Creates tags for a resource, given its ARN.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Deletes the tags for a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_launch_profile#

Update a launch profile.

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

# update_launch_profile method definition

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

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

parent.update_launch_profile(**kwargs)
  1. See UpdateLaunchProfileRequestRequestTypeDef

update_launch_profile_member#

Update a user persona in launch profile membership.

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

# update_launch_profile_member method definition

def update_launch_profile_member(
    self,
    *,
    launchProfileId: str,
    persona: LaunchProfilePersonaType,  # (1)
    principalId: str,
    studioId: str,
    clientToken: str = ...,
) -> UpdateLaunchProfileMemberResponseTypeDef:  # (2)
    ...
  1. See LaunchProfilePersonaType
  2. See UpdateLaunchProfileMemberResponseTypeDef
# update_launch_profile_member method usage example with argument unpacking

kwargs: UpdateLaunchProfileMemberRequestRequestTypeDef = {  # (1)
    "launchProfileId": ...,
    "persona": ...,
    "principalId": ...,
    "studioId": ...,
}

parent.update_launch_profile_member(**kwargs)
  1. See UpdateLaunchProfileMemberRequestRequestTypeDef

update_streaming_image#

Update streaming image.

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

# update_streaming_image method definition

def update_streaming_image(
    self,
    *,
    streamingImageId: str,
    studioId: str,
    clientToken: str = ...,
    description: str = ...,
    name: str = ...,
) -> UpdateStreamingImageResponseTypeDef:  # (1)
    ...
  1. See UpdateStreamingImageResponseTypeDef
# update_streaming_image method usage example with argument unpacking

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

parent.update_streaming_image(**kwargs)
  1. See UpdateStreamingImageRequestRequestTypeDef

update_studio#

Update a Studio resource.

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

# update_studio method definition

def update_studio(
    self,
    *,
    studioId: str,
    adminRoleArn: str = ...,
    clientToken: str = ...,
    displayName: str = ...,
    userRoleArn: str = ...,
) -> UpdateStudioResponseTypeDef:  # (1)
    ...
  1. See UpdateStudioResponseTypeDef
# update_studio method usage example with argument unpacking

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

parent.update_studio(**kwargs)
  1. See UpdateStudioRequestRequestTypeDef

update_studio_component#

Updates a studio component resource.

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

# update_studio_component method definition

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

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

parent.update_studio_component(**kwargs)
  1. See UpdateStudioComponentRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("nimble").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("nimble").get_waiter method with overloads.