NimbleStudioClient#
Index > NimbleStudio > NimbleStudioClient
Auto-generated documentation for NimbleStudio type annotations stubs module types-aiobotocore-nimble.
NimbleStudioClient#
Type annotations and code completion for session.client("nimble")
boto3 documentation
# NimbleStudioClient usage example
from aioboto3.session import Session
from types_aiobotocore_nimble.client import NimbleStudioClient
session = Session()
async with session.client("nimble") as client:
client: NimbleStudioClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("nimble").exceptions
structure.
# NimbleStudioClient.exceptions usage example
async with session.client("nimble") as client:
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)
# NimbleStudioClient.exceptions type checking example
from types_aiobotocore_nimble.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
accept_eulas#
Accept EULAs.
Type annotations and code completion for session.client("nimble").accept_eulas
method.
boto3 documentation
# accept_eulas method definition
await def accept_eulas(
self,
*,
studioId: str,
clientToken: str = ...,
eulaIds: Sequence[str] = ...,
) -> AcceptEulasResponseTypeDef: # (1)
...
# accept_eulas method usage example with argument unpacking
kwargs: AcceptEulasRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.accept_eulas(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.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 session.client("nimble").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_launch_profile#
Create a launch profile.
Type annotations and code completion for session.client("nimble").create_launch_profile
method.
boto3 documentation
# create_launch_profile method definition
await 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)
...
# create_launch_profile method usage example with argument unpacking
kwargs: CreateLaunchProfileRequestRequestTypeDef = { # (1)
"ec2SubnetIds": ...,
"launchProfileProtocolVersions": ...,
"name": ...,
"streamConfiguration": ...,
"studioComponentIds": ...,
"studioId": ...,
}
parent.create_launch_profile(**kwargs)
create_streaming_image#
Creates a streaming image resource in a studio.
Type annotations and code completion for session.client("nimble").create_streaming_image
method.
boto3 documentation
# create_streaming_image method definition
await def create_streaming_image(
self,
*,
ec2ImageId: str,
name: str,
studioId: str,
clientToken: str = ...,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateStreamingImageResponseTypeDef: # (1)
...
# create_streaming_image method usage example with argument unpacking
kwargs: CreateStreamingImageRequestRequestTypeDef = { # (1)
"ec2ImageId": ...,
"name": ...,
"studioId": ...,
}
parent.create_streaming_image(**kwargs)
create_streaming_session#
Creates a streaming session in a studio.
Type annotations and code completion for session.client("nimble").create_streaming_session
method.
boto3 documentation
# create_streaming_session method definition
await def create_streaming_session(
self,
*,
launchProfileId: str,
studioId: str,
clientToken: str = ...,
ec2InstanceType: StreamingInstanceTypeType = ..., # (1)
ownedBy: str = ...,
streamingImageId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateStreamingSessionResponseTypeDef: # (2)
...
# create_streaming_session method usage example with argument unpacking
kwargs: CreateStreamingSessionRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.create_streaming_session(**kwargs)
create_streaming_session_stream#
Creates a streaming session stream for a streaming session.
Type annotations and code completion for session.client("nimble").create_streaming_session_stream
method.
boto3 documentation
# create_streaming_session_stream method definition
await def create_streaming_session_stream(
self,
*,
sessionId: str,
studioId: str,
clientToken: str = ...,
expirationInSeconds: int = ...,
) -> CreateStreamingSessionStreamResponseTypeDef: # (1)
...
# create_streaming_session_stream method usage example with argument unpacking
kwargs: CreateStreamingSessionStreamRequestRequestTypeDef = { # (1)
"sessionId": ...,
"studioId": ...,
}
parent.create_streaming_session_stream(**kwargs)
create_studio#
Create a new studio.
Type annotations and code completion for session.client("nimble").create_studio
method.
boto3 documentation
# create_studio method definition
await def create_studio(
self,
*,
adminRoleArn: str,
displayName: str,
studioName: str,
userRoleArn: str,
clientToken: str = ...,
studioEncryptionConfiguration: StudioEncryptionConfigurationTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> CreateStudioResponseTypeDef: # (2)
...
# create_studio method usage example with argument unpacking
kwargs: CreateStudioRequestRequestTypeDef = { # (1)
"adminRoleArn": ...,
"displayName": ...,
"studioName": ...,
"userRoleArn": ...,
}
parent.create_studio(**kwargs)
create_studio_component#
Creates a studio component resource.
Type annotations and code completion for session.client("nimble").create_studio_component
method.
boto3 documentation
# create_studio_component method definition
await 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)
...
- See StudioComponentTypeType
- See StudioComponentConfigurationTypeDef
- See StudioComponentInitializationScriptTypeDef
- See ScriptParameterKeyValueTypeDef
- See StudioComponentSubtypeType
- See CreateStudioComponentResponseTypeDef
# create_studio_component method usage example with argument unpacking
kwargs: CreateStudioComponentRequestRequestTypeDef = { # (1)
"name": ...,
"studioId": ...,
"type": ...,
}
parent.create_studio_component(**kwargs)
delete_launch_profile#
Permanently delete a launch profile.
Type annotations and code completion for session.client("nimble").delete_launch_profile
method.
boto3 documentation
# delete_launch_profile method definition
await def delete_launch_profile(
self,
*,
launchProfileId: str,
studioId: str,
clientToken: str = ...,
) -> DeleteLaunchProfileResponseTypeDef: # (1)
...
# delete_launch_profile method usage example with argument unpacking
kwargs: DeleteLaunchProfileRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.delete_launch_profile(**kwargs)
delete_launch_profile_member#
Delete a user from launch profile membership.
Type annotations and code completion for session.client("nimble").delete_launch_profile_member
method.
boto3 documentation
# delete_launch_profile_member method definition
await 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)
delete_streaming_image#
Delete streaming image.
Type annotations and code completion for session.client("nimble").delete_streaming_image
method.
boto3 documentation
# delete_streaming_image method definition
await def delete_streaming_image(
self,
*,
streamingImageId: str,
studioId: str,
clientToken: str = ...,
) -> DeleteStreamingImageResponseTypeDef: # (1)
...
# delete_streaming_image method usage example with argument unpacking
kwargs: DeleteStreamingImageRequestRequestTypeDef = { # (1)
"streamingImageId": ...,
"studioId": ...,
}
parent.delete_streaming_image(**kwargs)
delete_streaming_session#
Deletes streaming session resource.
Type annotations and code completion for session.client("nimble").delete_streaming_session
method.
boto3 documentation
# delete_streaming_session method definition
await def delete_streaming_session(
self,
*,
sessionId: str,
studioId: str,
clientToken: str = ...,
) -> DeleteStreamingSessionResponseTypeDef: # (1)
...
# delete_streaming_session method usage example with argument unpacking
kwargs: DeleteStreamingSessionRequestRequestTypeDef = { # (1)
"sessionId": ...,
"studioId": ...,
}
parent.delete_streaming_session(**kwargs)
delete_studio#
Delete a studio resource.
Type annotations and code completion for session.client("nimble").delete_studio
method.
boto3 documentation
# delete_studio method definition
await def delete_studio(
self,
*,
studioId: str,
clientToken: str = ...,
) -> DeleteStudioResponseTypeDef: # (1)
...
# delete_studio method usage example with argument unpacking
kwargs: DeleteStudioRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.delete_studio(**kwargs)
delete_studio_component#
Deletes a studio component resource.
Type annotations and code completion for session.client("nimble").delete_studio_component
method.
boto3 documentation
# delete_studio_component method definition
await def delete_studio_component(
self,
*,
studioComponentId: str,
studioId: str,
clientToken: str = ...,
) -> DeleteStudioComponentResponseTypeDef: # (1)
...
# delete_studio_component method usage example with argument unpacking
kwargs: DeleteStudioComponentRequestRequestTypeDef = { # (1)
"studioComponentId": ...,
"studioId": ...,
}
parent.delete_studio_component(**kwargs)
delete_studio_member#
Delete a user from studio membership.
Type annotations and code completion for session.client("nimble").delete_studio_member
method.
boto3 documentation
# delete_studio_member method definition
await 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)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("nimble").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.client("nimble").get_eula
method.
boto3 documentation
# get_eula method definition
await def get_eula(
self,
*,
eulaId: str,
) -> GetEulaResponseTypeDef: # (1)
...
# get_eula method usage example with argument unpacking
kwargs: GetEulaRequestRequestTypeDef = { # (1)
"eulaId": ...,
}
parent.get_eula(**kwargs)
get_launch_profile#
Get a launch profile.
Type annotations and code completion for session.client("nimble").get_launch_profile
method.
boto3 documentation
# get_launch_profile method definition
await def get_launch_profile(
self,
*,
launchProfileId: str,
studioId: str,
) -> GetLaunchProfileResponseTypeDef: # (1)
...
# get_launch_profile method usage example with argument unpacking
kwargs: GetLaunchProfileRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.get_launch_profile(**kwargs)
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 session.client("nimble").get_launch_profile_details
method.
boto3 documentation
# get_launch_profile_details method definition
await def get_launch_profile_details(
self,
*,
launchProfileId: str,
studioId: str,
) -> GetLaunchProfileDetailsResponseTypeDef: # (1)
...
# get_launch_profile_details method usage example with argument unpacking
kwargs: GetLaunchProfileDetailsRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.get_launch_profile_details(**kwargs)
get_launch_profile_initialization#
Get a launch profile initialization.
Type annotations and code completion for session.client("nimble").get_launch_profile_initialization
method.
boto3 documentation
# get_launch_profile_initialization method definition
await def get_launch_profile_initialization(
self,
*,
launchProfileId: str,
launchProfileProtocolVersions: Sequence[str],
launchPurpose: str,
platform: str,
studioId: str,
) -> GetLaunchProfileInitializationResponseTypeDef: # (1)
...
# get_launch_profile_initialization method usage example with argument unpacking
kwargs: GetLaunchProfileInitializationRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"launchProfileProtocolVersions": ...,
"launchPurpose": ...,
"platform": ...,
"studioId": ...,
}
parent.get_launch_profile_initialization(**kwargs)
get_launch_profile_member#
Get a user persona in launch profile membership.
Type annotations and code completion for session.client("nimble").get_launch_profile_member
method.
boto3 documentation
# get_launch_profile_member method definition
await def get_launch_profile_member(
self,
*,
launchProfileId: str,
principalId: str,
studioId: str,
) -> GetLaunchProfileMemberResponseTypeDef: # (1)
...
# get_launch_profile_member method usage example with argument unpacking
kwargs: GetLaunchProfileMemberRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"principalId": ...,
"studioId": ...,
}
parent.get_launch_profile_member(**kwargs)
get_streaming_image#
Get streaming image.
Type annotations and code completion for session.client("nimble").get_streaming_image
method.
boto3 documentation
# get_streaming_image method definition
await def get_streaming_image(
self,
*,
streamingImageId: str,
studioId: str,
) -> GetStreamingImageResponseTypeDef: # (1)
...
# get_streaming_image method usage example with argument unpacking
kwargs: GetStreamingImageRequestRequestTypeDef = { # (1)
"streamingImageId": ...,
"studioId": ...,
}
parent.get_streaming_image(**kwargs)
get_streaming_session#
Gets StreamingSession resource.
Type annotations and code completion for session.client("nimble").get_streaming_session
method.
boto3 documentation
# get_streaming_session method definition
await def get_streaming_session(
self,
*,
sessionId: str,
studioId: str,
) -> GetStreamingSessionResponseTypeDef: # (1)
...
# get_streaming_session method usage example with argument unpacking
kwargs: GetStreamingSessionRequestRequestTypeDef = { # (1)
"sessionId": ...,
"studioId": ...,
}
parent.get_streaming_session(**kwargs)
get_streaming_session_backup#
Gets StreamingSessionBackup
resource.
Type annotations and code completion for session.client("nimble").get_streaming_session_backup
method.
boto3 documentation
# get_streaming_session_backup method definition
await def get_streaming_session_backup(
self,
*,
backupId: str,
studioId: str,
) -> GetStreamingSessionBackupResponseTypeDef: # (1)
...
# get_streaming_session_backup method usage example with argument unpacking
kwargs: GetStreamingSessionBackupRequestRequestTypeDef = { # (1)
"backupId": ...,
"studioId": ...,
}
parent.get_streaming_session_backup(**kwargs)
get_streaming_session_stream#
Gets a StreamingSessionStream for a streaming session.
Type annotations and code completion for session.client("nimble").get_streaming_session_stream
method.
boto3 documentation
# get_streaming_session_stream method definition
await def get_streaming_session_stream(
self,
*,
sessionId: str,
streamId: str,
studioId: str,
) -> GetStreamingSessionStreamResponseTypeDef: # (1)
...
# get_streaming_session_stream method usage example with argument unpacking
kwargs: GetStreamingSessionStreamRequestRequestTypeDef = { # (1)
"sessionId": ...,
"streamId": ...,
"studioId": ...,
}
parent.get_streaming_session_stream(**kwargs)
get_studio#
Get a studio resource.
Type annotations and code completion for session.client("nimble").get_studio
method.
boto3 documentation
# get_studio method definition
await def get_studio(
self,
*,
studioId: str,
) -> GetStudioResponseTypeDef: # (1)
...
# get_studio method usage example with argument unpacking
kwargs: GetStudioRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.get_studio(**kwargs)
get_studio_component#
Gets a studio component resource.
Type annotations and code completion for session.client("nimble").get_studio_component
method.
boto3 documentation
# get_studio_component method definition
await def get_studio_component(
self,
*,
studioComponentId: str,
studioId: str,
) -> GetStudioComponentResponseTypeDef: # (1)
...
# get_studio_component method usage example with argument unpacking
kwargs: GetStudioComponentRequestRequestTypeDef = { # (1)
"studioComponentId": ...,
"studioId": ...,
}
parent.get_studio_component(**kwargs)
get_studio_member#
Get a user's membership in a studio.
Type annotations and code completion for session.client("nimble").get_studio_member
method.
boto3 documentation
# get_studio_member method definition
await def get_studio_member(
self,
*,
principalId: str,
studioId: str,
) -> GetStudioMemberResponseTypeDef: # (1)
...
# get_studio_member method usage example with argument unpacking
kwargs: GetStudioMemberRequestRequestTypeDef = { # (1)
"principalId": ...,
"studioId": ...,
}
parent.get_studio_member(**kwargs)
list_eula_acceptances#
List EULA acceptances.
Type annotations and code completion for session.client("nimble").list_eula_acceptances
method.
boto3 documentation
# list_eula_acceptances method definition
await def list_eula_acceptances(
self,
*,
studioId: str,
eulaIds: Sequence[str] = ...,
nextToken: str = ...,
) -> ListEulaAcceptancesResponseTypeDef: # (1)
...
# list_eula_acceptances method usage example with argument unpacking
kwargs: ListEulaAcceptancesRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_eula_acceptances(**kwargs)
list_eulas#
List EULAs.
Type annotations and code completion for session.client("nimble").list_eulas
method.
boto3 documentation
# list_eulas method definition
await def list_eulas(
self,
*,
eulaIds: Sequence[str] = ...,
nextToken: str = ...,
) -> ListEulasResponseTypeDef: # (1)
...
# list_eulas method usage example with argument unpacking
kwargs: ListEulasRequestRequestTypeDef = { # (1)
"eulaIds": ...,
}
parent.list_eulas(**kwargs)
list_launch_profile_members#
Get all users in a given launch profile membership.
Type annotations and code completion for session.client("nimble").list_launch_profile_members
method.
boto3 documentation
# list_launch_profile_members method definition
await def list_launch_profile_members(
self,
*,
launchProfileId: str,
studioId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListLaunchProfileMembersResponseTypeDef: # (1)
...
# list_launch_profile_members method usage example with argument unpacking
kwargs: ListLaunchProfileMembersRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.list_launch_profile_members(**kwargs)
list_launch_profiles#
List all the launch profiles a studio.
Type annotations and code completion for session.client("nimble").list_launch_profiles
method.
boto3 documentation
# list_launch_profiles method definition
await def list_launch_profiles(
self,
*,
studioId: str,
maxResults: int = ...,
nextToken: str = ...,
principalId: str = ...,
states: Sequence[LaunchProfileStateType] = ..., # (1)
) -> ListLaunchProfilesResponseTypeDef: # (2)
...
# list_launch_profiles method usage example with argument unpacking
kwargs: ListLaunchProfilesRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_launch_profiles(**kwargs)
list_streaming_images#
List the streaming image resources available to this studio.
Type annotations and code completion for session.client("nimble").list_streaming_images
method.
boto3 documentation
# list_streaming_images method definition
await def list_streaming_images(
self,
*,
studioId: str,
nextToken: str = ...,
owner: str = ...,
) -> ListStreamingImagesResponseTypeDef: # (1)
...
# list_streaming_images method usage example with argument unpacking
kwargs: ListStreamingImagesRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_streaming_images(**kwargs)
list_streaming_session_backups#
Lists the backups of a streaming session in a studio.
Type annotations and code completion for session.client("nimble").list_streaming_session_backups
method.
boto3 documentation
# list_streaming_session_backups method definition
await def list_streaming_session_backups(
self,
*,
studioId: str,
nextToken: str = ...,
ownedBy: str = ...,
) -> ListStreamingSessionBackupsResponseTypeDef: # (1)
...
# list_streaming_session_backups method usage example with argument unpacking
kwargs: ListStreamingSessionBackupsRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_streaming_session_backups(**kwargs)
list_streaming_sessions#
Lists the streaming sessions in a studio.
Type annotations and code completion for session.client("nimble").list_streaming_sessions
method.
boto3 documentation
# list_streaming_sessions method definition
await def list_streaming_sessions(
self,
*,
studioId: str,
createdBy: str = ...,
nextToken: str = ...,
ownedBy: str = ...,
sessionIds: str = ...,
) -> ListStreamingSessionsResponseTypeDef: # (1)
...
# list_streaming_sessions method usage example with argument unpacking
kwargs: ListStreamingSessionsRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_streaming_sessions(**kwargs)
list_studio_components#
Lists the StudioComponents
in a studio.
Type annotations and code completion for session.client("nimble").list_studio_components
method.
boto3 documentation
# list_studio_components method definition
await def list_studio_components(
self,
*,
studioId: str,
maxResults: int = ...,
nextToken: str = ...,
states: Sequence[StudioComponentStateType] = ..., # (1)
types: Sequence[StudioComponentTypeType] = ..., # (2)
) -> ListStudioComponentsResponseTypeDef: # (3)
...
# list_studio_components method usage example with argument unpacking
kwargs: ListStudioComponentsRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_studio_components(**kwargs)
list_studio_members#
Get all users in a given studio membership.
Type annotations and code completion for session.client("nimble").list_studio_members
method.
boto3 documentation
# list_studio_members method definition
await def list_studio_members(
self,
*,
studioId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStudioMembersResponseTypeDef: # (1)
...
# list_studio_members method usage example with argument unpacking
kwargs: ListStudioMembersRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.list_studio_members(**kwargs)
list_studios#
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
Type annotations and code completion for session.client("nimble").list_studios
method.
boto3 documentation
# list_studios method definition
await def list_studios(
self,
*,
nextToken: str = ...,
) -> ListStudiosResponseTypeDef: # (1)
...
# list_studios method usage example with argument unpacking
kwargs: ListStudiosRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_studios(**kwargs)
list_tags_for_resource#
Gets the tags for a resource, given its Amazon Resource Names (ARN).
Type annotations and code completion for session.client("nimble").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_launch_profile_members#
Add/update users with given persona to launch profile membership.
Type annotations and code completion for session.client("nimble").put_launch_profile_members
method.
boto3 documentation
# put_launch_profile_members method definition
await def put_launch_profile_members(
self,
*,
identityStoreId: str,
launchProfileId: str,
members: Sequence[NewLaunchProfileMemberTypeDef], # (1)
studioId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# put_launch_profile_members method usage example with argument unpacking
kwargs: PutLaunchProfileMembersRequestRequestTypeDef = { # (1)
"identityStoreId": ...,
"launchProfileId": ...,
"members": ...,
"studioId": ...,
}
parent.put_launch_profile_members(**kwargs)
put_studio_members#
Add/update users with given persona to studio membership.
Type annotations and code completion for session.client("nimble").put_studio_members
method.
boto3 documentation
# put_studio_members method definition
await def put_studio_members(
self,
*,
identityStoreId: str,
members: Sequence[NewStudioMemberTypeDef], # (1)
studioId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# put_studio_members method usage example with argument unpacking
kwargs: PutStudioMembersRequestRequestTypeDef = { # (1)
"identityStoreId": ...,
"members": ...,
"studioId": ...,
}
parent.put_studio_members(**kwargs)
start_streaming_session#
Transitions sessions from the STOPPED
state into the READY
state.
Type annotations and code completion for session.client("nimble").start_streaming_session
method.
boto3 documentation
# start_streaming_session method definition
await def start_streaming_session(
self,
*,
sessionId: str,
studioId: str,
backupId: str = ...,
clientToken: str = ...,
) -> StartStreamingSessionResponseTypeDef: # (1)
...
# start_streaming_session method usage example with argument unpacking
kwargs: StartStreamingSessionRequestRequestTypeDef = { # (1)
"sessionId": ...,
"studioId": ...,
}
parent.start_streaming_session(**kwargs)
start_studio_sso_configuration_repair#
Repairs the IAM Identity Center configuration for a given studio.
Type annotations and code completion for session.client("nimble").start_studio_sso_configuration_repair
method.
boto3 documentation
# start_studio_sso_configuration_repair method definition
await def start_studio_sso_configuration_repair(
self,
*,
studioId: str,
clientToken: str = ...,
) -> StartStudioSSOConfigurationRepairResponseTypeDef: # (1)
...
# start_studio_sso_configuration_repair method usage example with argument unpacking
kwargs: StartStudioSSOConfigurationRepairRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.start_studio_sso_configuration_repair(**kwargs)
stop_streaming_session#
Transitions sessions from the READY
state into the STOPPED
state.
Type annotations and code completion for session.client("nimble").stop_streaming_session
method.
boto3 documentation
# stop_streaming_session method definition
await def stop_streaming_session(
self,
*,
sessionId: str,
studioId: str,
clientToken: str = ...,
volumeRetentionMode: VolumeRetentionModeType = ..., # (1)
) -> StopStreamingSessionResponseTypeDef: # (2)
...
# stop_streaming_session method usage example with argument unpacking
kwargs: StopStreamingSessionRequestRequestTypeDef = { # (1)
"sessionId": ...,
"studioId": ...,
}
parent.stop_streaming_session(**kwargs)
tag_resource#
Creates tags for a resource, given its ARN.
Type annotations and code completion for session.client("nimble").tag_resource
method.
boto3 documentation
# tag_resource method definition
await 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)
untag_resource#
Deletes the tags for a resource.
Type annotations and code completion for session.client("nimble").untag_resource
method.
boto3 documentation
# untag_resource method definition
await 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)
update_launch_profile#
Update a launch profile.
Type annotations and code completion for session.client("nimble").update_launch_profile
method.
boto3 documentation
# update_launch_profile method definition
await 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)
...
# update_launch_profile method usage example with argument unpacking
kwargs: UpdateLaunchProfileRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"studioId": ...,
}
parent.update_launch_profile(**kwargs)
update_launch_profile_member#
Update a user persona in launch profile membership.
Type annotations and code completion for session.client("nimble").update_launch_profile_member
method.
boto3 documentation
# update_launch_profile_member method definition
await def update_launch_profile_member(
self,
*,
launchProfileId: str,
persona: LaunchProfilePersonaType, # (1)
principalId: str,
studioId: str,
clientToken: str = ...,
) -> UpdateLaunchProfileMemberResponseTypeDef: # (2)
...
# update_launch_profile_member method usage example with argument unpacking
kwargs: UpdateLaunchProfileMemberRequestRequestTypeDef = { # (1)
"launchProfileId": ...,
"persona": ...,
"principalId": ...,
"studioId": ...,
}
parent.update_launch_profile_member(**kwargs)
update_streaming_image#
Update streaming image.
Type annotations and code completion for session.client("nimble").update_streaming_image
method.
boto3 documentation
# update_streaming_image method definition
await def update_streaming_image(
self,
*,
streamingImageId: str,
studioId: str,
clientToken: str = ...,
description: str = ...,
name: str = ...,
) -> UpdateStreamingImageResponseTypeDef: # (1)
...
# update_streaming_image method usage example with argument unpacking
kwargs: UpdateStreamingImageRequestRequestTypeDef = { # (1)
"streamingImageId": ...,
"studioId": ...,
}
parent.update_streaming_image(**kwargs)
update_studio#
Update a Studio resource.
Type annotations and code completion for session.client("nimble").update_studio
method.
boto3 documentation
# update_studio method definition
await def update_studio(
self,
*,
studioId: str,
adminRoleArn: str = ...,
clientToken: str = ...,
displayName: str = ...,
userRoleArn: str = ...,
) -> UpdateStudioResponseTypeDef: # (1)
...
# update_studio method usage example with argument unpacking
kwargs: UpdateStudioRequestRequestTypeDef = { # (1)
"studioId": ...,
}
parent.update_studio(**kwargs)
update_studio_component#
Updates a studio component resource.
Type annotations and code completion for session.client("nimble").update_studio_component
method.
boto3 documentation
# update_studio_component method definition
await 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)
...
- See StudioComponentConfigurationTypeDef
- See StudioComponentInitializationScriptTypeDef
- See ScriptParameterKeyValueTypeDef
- See StudioComponentSubtypeType
- See StudioComponentTypeType
- See UpdateStudioComponentResponseTypeDef
# update_studio_component method usage example with argument unpacking
kwargs: UpdateStudioComponentRequestRequestTypeDef = { # (1)
"studioComponentId": ...,
"studioId": ...,
}
parent.update_studio_component(**kwargs)
__aenter__#
Type annotations and code completion for session.client("nimble").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> NimbleStudioClient:
...
__aexit__#
Type annotations and code completion for session.client("nimble").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("nimble").get_paginator
method with overloads.
client.get_paginator("list_eula_acceptances")
-> ListEulaAcceptancesPaginatorclient.get_paginator("list_eulas")
-> ListEulasPaginatorclient.get_paginator("list_launch_profile_members")
-> ListLaunchProfileMembersPaginatorclient.get_paginator("list_launch_profiles")
-> ListLaunchProfilesPaginatorclient.get_paginator("list_streaming_images")
-> ListStreamingImagesPaginatorclient.get_paginator("list_streaming_session_backups")
-> ListStreamingSessionBackupsPaginatorclient.get_paginator("list_streaming_sessions")
-> ListStreamingSessionsPaginatorclient.get_paginator("list_studio_components")
-> ListStudioComponentsPaginatorclient.get_paginator("list_studio_members")
-> ListStudioMembersPaginatorclient.get_paginator("list_studios")
-> ListStudiosPaginator
get_waiter#
Type annotations and code completion for session.client("nimble").get_waiter
method with overloads.
client.get_waiter("launch_profile_deleted")
-> LaunchProfileDeletedWaiterclient.get_waiter("launch_profile_ready")
-> LaunchProfileReadyWaiterclient.get_waiter("streaming_image_deleted")
-> StreamingImageDeletedWaiterclient.get_waiter("streaming_image_ready")
-> StreamingImageReadyWaiterclient.get_waiter("streaming_session_deleted")
-> StreamingSessionDeletedWaiterclient.get_waiter("streaming_session_ready")
-> StreamingSessionReadyWaiterclient.get_waiter("streaming_session_stopped")
-> StreamingSessionStoppedWaiterclient.get_waiter("streaming_session_stream_ready")
-> StreamingSessionStreamReadyWaiterclient.get_waiter("studio_component_deleted")
-> StudioComponentDeletedWaiterclient.get_waiter("studio_component_ready")
-> StudioComponentReadyWaiterclient.get_waiter("studio_deleted")
-> StudioDeletedWaiterclient.get_waiter("studio_ready")
-> StudioReadyWaiter