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

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.

Usage example
client = boto3.client("nimble")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerErrorException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
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

Method definition
def accept_eulas(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
    eulaIds: Sequence[str] = ...,
) -> AcceptEulasResponseTypeDef:  # (1)
    ...
  1. See AcceptEulasResponseTypeDef
Usage example with kwargs
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

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

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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def create_streaming_session_stream(
    self,
    *,
    sessionId: str,
    studioId: str,
    clientToken: str = ...,
    expirationInSeconds: int = ...,
) -> CreateStreamingSessionStreamResponseTypeDef:  # (1)
    ...
  1. See CreateStreamingSessionStreamResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def delete_launch_profile(
    self,
    *,
    launchProfileId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteLaunchProfileResponseTypeDef:  # (1)
    ...
  1. See DeleteLaunchProfileResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_launch_profile_member(
    self,
    *,
    launchProfileId: str,
    principalId: str,
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def delete_streaming_image(
    self,
    *,
    streamingImageId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStreamingImageResponseTypeDef:  # (1)
    ...
  1. See DeleteStreamingImageResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStreamingSessionResponseTypeDef:  # (1)
    ...
  1. See DeleteStreamingSessionResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_studio(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStudioResponseTypeDef:  # (1)
    ...
  1. See DeleteStudioResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_studio_component(
    self,
    *,
    studioComponentId: str,
    studioId: str,
    clientToken: str = ...,
) -> DeleteStudioComponentResponseTypeDef:  # (1)
    ...
  1. See DeleteStudioComponentResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_studio_member(
    self,
    *,
    principalId: str,
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

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

Method definition
def get_eula(
    self,
    *,
    eulaId: str,
) -> GetEulaResponseTypeDef:  # (1)
    ...
  1. See GetEulaResponseTypeDef
Usage example with kwargs
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

Method definition
def get_launch_profile(
    self,
    *,
    launchProfileId: str,
    studioId: str,
) -> GetLaunchProfileResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileResponseTypeDef
Usage example with kwargs
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

Method definition
def get_launch_profile_details(
    self,
    *,
    launchProfileId: str,
    studioId: str,
) -> GetLaunchProfileDetailsResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileDetailsResponseTypeDef
Usage example with kwargs
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

Method definition
def get_launch_profile_initialization(
    self,
    *,
    launchProfileId: str,
    launchProfileProtocolVersions: Sequence[str],
    launchPurpose: str,
    platform: str,
    studioId: str,
) -> GetLaunchProfileInitializationResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileInitializationResponseTypeDef
Usage example with kwargs
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

Method definition
def get_launch_profile_member(
    self,
    *,
    launchProfileId: str,
    principalId: str,
    studioId: str,
) -> GetLaunchProfileMemberResponseTypeDef:  # (1)
    ...
  1. See GetLaunchProfileMemberResponseTypeDef
Usage example with kwargs
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

Method definition
def get_streaming_image(
    self,
    *,
    streamingImageId: str,
    studioId: str,
) -> GetStreamingImageResponseTypeDef:  # (1)
    ...
  1. See GetStreamingImageResponseTypeDef
Usage example with kwargs
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

Method definition
def get_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
) -> GetStreamingSessionResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionResponseTypeDef
Usage example with kwargs
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

Method definition
def get_streaming_session_backup(
    self,
    *,
    backupId: str,
    studioId: str,
) -> GetStreamingSessionBackupResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionBackupResponseTypeDef
Usage example with kwargs
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

Method definition
def get_streaming_session_stream(
    self,
    *,
    sessionId: str,
    streamId: str,
    studioId: str,
) -> GetStreamingSessionStreamResponseTypeDef:  # (1)
    ...
  1. See GetStreamingSessionStreamResponseTypeDef
Usage example with kwargs
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

Method definition
def get_studio(
    self,
    *,
    studioId: str,
) -> GetStudioResponseTypeDef:  # (1)
    ...
  1. See GetStudioResponseTypeDef
Usage example with kwargs
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

Method definition
def get_studio_component(
    self,
    *,
    studioComponentId: str,
    studioId: str,
) -> GetStudioComponentResponseTypeDef:  # (1)
    ...
  1. See GetStudioComponentResponseTypeDef
Usage example with kwargs
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

Method definition
def get_studio_member(
    self,
    *,
    principalId: str,
    studioId: str,
) -> GetStudioMemberResponseTypeDef:  # (1)
    ...
  1. See GetStudioMemberResponseTypeDef
Usage example with kwargs
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

Method definition
def list_eula_acceptances(
    self,
    *,
    studioId: str,
    eulaIds: Sequence[str] = ...,
    nextToken: str = ...,
) -> ListEulaAcceptancesResponseTypeDef:  # (1)
    ...
  1. See ListEulaAcceptancesResponseTypeDef
Usage example with kwargs
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

Method definition
def list_eulas(
    self,
    *,
    eulaIds: Sequence[str] = ...,
    nextToken: str = ...,
) -> ListEulasResponseTypeDef:  # (1)
    ...
  1. See ListEulasResponseTypeDef
Usage example with kwargs
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

Method definition
def list_launch_profile_members(
    self,
    *,
    launchProfileId: str,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLaunchProfileMembersResponseTypeDef:  # (1)
    ...
  1. See ListLaunchProfileMembersResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def list_streaming_images(
    self,
    *,
    studioId: str,
    nextToken: str = ...,
    owner: str = ...,
) -> ListStreamingImagesResponseTypeDef:  # (1)
    ...
  1. See ListStreamingImagesResponseTypeDef
Usage example with kwargs
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

Method definition
def list_streaming_session_backups(
    self,
    *,
    studioId: str,
    nextToken: str = ...,
    ownedBy: str = ...,
) -> ListStreamingSessionBackupsResponseTypeDef:  # (1)
    ...
  1. See ListStreamingSessionBackupsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_streaming_sessions(
    self,
    *,
    studioId: str,
    createdBy: str = ...,
    nextToken: str = ...,
    ownedBy: str = ...,
    sessionIds: str = ...,
) -> ListStreamingSessionsResponseTypeDef:  # (1)
    ...
  1. See ListStreamingSessionsResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def list_studio_members(
    self,
    *,
    studioId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStudioMembersResponseTypeDef:  # (1)
    ...
  1. See ListStudioMembersResponseTypeDef
Usage example with kwargs
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

Method definition
def list_studios(
    self,
    *,
    nextToken: str = ...,
) -> ListStudiosResponseTypeDef:  # (1)
    ...
  1. See ListStudiosResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def put_studio_members(
    self,
    *,
    identityStoreId: str,
    members: Sequence[NewStudioMemberTypeDef],  # (1)
    studioId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See NewStudioMemberTypeDef
Usage example with kwargs
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

Method definition
def start_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
    backupId: str = ...,
    clientToken: str = ...,
) -> StartStreamingSessionResponseTypeDef:  # (1)
    ...
  1. See StartStreamingSessionResponseTypeDef
Usage example with kwargs
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

Method definition
def start_studio_sso_configuration_repair(
    self,
    *,
    studioId: str,
    clientToken: str = ...,
) -> StartStudioSSOConfigurationRepairResponseTypeDef:  # (1)
    ...
  1. See StartStudioSSOConfigurationRepairResponseTypeDef
Usage example with kwargs
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

Method definition
def stop_streaming_session(
    self,
    *,
    sessionId: str,
    studioId: str,
    clientToken: str = ...,
    volumeRetentionMode: VolumeRetentionModeType = ...,  # (1)
) -> StopStreamingSessionResponseTypeDef:  # (2)
    ...
  1. See VolumeRetentionModeType
  2. See StopStreamingSessionResponseTypeDef
Usage example with kwargs
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.