amazonka-nimble-2.0: Amazon NimbleStudio SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Nimble.Lens

Contents

Description

 
Synopsis

Operations

AcceptEulas

acceptEulas_clientToken :: Lens' AcceptEulas (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

acceptEulas_eulaIds :: Lens' AcceptEulas (Maybe [Text]) Source #

The EULA ID.

acceptEulas_studioId :: Lens' AcceptEulas Text Source #

The studio ID.

acceptEulasResponse_eulaAcceptances :: Lens' AcceptEulasResponse (Maybe [EulaAcceptance]) Source #

A collection of EULA acceptances.

acceptEulasResponse_httpStatus :: Lens' AcceptEulasResponse Int Source #

The response's http status code.

CreateLaunchProfile

createLaunchProfile_clientToken :: Lens' CreateLaunchProfile (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createLaunchProfile_description :: Lens' CreateLaunchProfile (Maybe Text) Source #

The description.

createLaunchProfile_tags :: Lens' CreateLaunchProfile (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createLaunchProfile_ec2SubnetIds :: Lens' CreateLaunchProfile [Text] Source #

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

createLaunchProfile_launchProfileProtocolVersions :: Lens' CreateLaunchProfile [Text] Source #

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

createLaunchProfile_name :: Lens' CreateLaunchProfile Text Source #

The name for the launch profile.

createLaunchProfile_streamConfiguration :: Lens' CreateLaunchProfile StreamConfigurationCreate Source #

A configuration for a streaming session.

createLaunchProfile_studioComponentIds :: Lens' CreateLaunchProfile (NonEmpty Text) Source #

Unique identifiers for a collection of studio components that can be used with this launch profile.

createLaunchProfile_studioId :: Lens' CreateLaunchProfile Text Source #

The studio ID.

createLaunchProfileResponse_launchProfile :: Lens' CreateLaunchProfileResponse (Maybe LaunchProfile) Source #

The launch profile.

createLaunchProfileResponse_httpStatus :: Lens' CreateLaunchProfileResponse Int Source #

The response's http status code.

CreateStreamingImage

createStreamingImage_clientToken :: Lens' CreateStreamingImage (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStreamingImage_description :: Lens' CreateStreamingImage (Maybe Text) Source #

A human-readable description of the streaming image.

createStreamingImage_tags :: Lens' CreateStreamingImage (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStreamingImage_ec2ImageId :: Lens' CreateStreamingImage Text Source #

The ID of an EC2 machine image with which to create this streaming image.

createStreamingImage_name :: Lens' CreateStreamingImage Text Source #

A friendly name for a streaming image resource.

createStreamingImage_studioId :: Lens' CreateStreamingImage Text Source #

The studio ID.

createStreamingImageResponse_streamingImage :: Lens' CreateStreamingImageResponse (Maybe StreamingImage) Source #

The streaming image.

createStreamingImageResponse_httpStatus :: Lens' CreateStreamingImageResponse Int Source #

The response's http status code.

CreateStreamingSession

createStreamingSession_clientToken :: Lens' CreateStreamingSession (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStreamingSession_ec2InstanceType :: Lens' CreateStreamingSession (Maybe StreamingInstanceType) Source #

The EC2 Instance type used for the streaming session.

createStreamingSession_ownedBy :: Lens' CreateStreamingSession (Maybe Text) Source #

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

createStreamingSession_streamingImageId :: Lens' CreateStreamingSession (Maybe Text) Source #

The ID of the streaming image.

createStreamingSession_tags :: Lens' CreateStreamingSession (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStreamingSession_launchProfileId :: Lens' CreateStreamingSession Text Source #

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

createStreamingSession_studioId :: Lens' CreateStreamingSession Text Source #

The studio ID.

createStreamingSessionResponse_session :: Lens' CreateStreamingSessionResponse (Maybe StreamingSession) Source #

The session.

createStreamingSessionResponse_httpStatus :: Lens' CreateStreamingSessionResponse Int Source #

The response's http status code.

CreateStreamingSessionStream

createStreamingSessionStream_clientToken :: Lens' CreateStreamingSessionStream (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStreamingSessionStream_expirationInSeconds :: Lens' CreateStreamingSessionStream (Maybe Natural) Source #

The expiration time in seconds.

createStreamingSessionStream_sessionId :: Lens' CreateStreamingSessionStream Text Source #

The streaming session ID.

createStreamingSessionStream_studioId :: Lens' CreateStreamingSessionStream Text Source #

The studio ID.

createStreamingSessionStreamResponse_stream :: Lens' CreateStreamingSessionStreamResponse (Maybe StreamingSessionStream) Source #

The stream.

createStreamingSessionStreamResponse_httpStatus :: Lens' CreateStreamingSessionStreamResponse Int Source #

The response's http status code.

CreateStudio

createStudio_clientToken :: Lens' CreateStudio (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStudio_studioEncryptionConfiguration :: Lens' CreateStudio (Maybe StudioEncryptionConfiguration) Source #

The studio encryption configuration.

createStudio_tags :: Lens' CreateStudio (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStudio_adminRoleArn :: Lens' CreateStudio Text Source #

The IAM role that studio admins will assume when logging in to the Nimble Studio portal.

createStudio_displayName :: Lens' CreateStudio Text Source #

A friendly name for the studio.

createStudio_studioName :: Lens' CreateStudio Text Source #

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

createStudio_userRoleArn :: Lens' CreateStudio Text Source #

The IAM role that studio users will assume when logging in to the Nimble Studio portal.

createStudioResponse_studio :: Lens' CreateStudioResponse (Maybe Studio) Source #

Information about a studio.

createStudioResponse_httpStatus :: Lens' CreateStudioResponse Int Source #

The response's http status code.

CreateStudioComponent

createStudioComponent_clientToken :: Lens' CreateStudioComponent (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStudioComponent_configuration :: Lens' CreateStudioComponent (Maybe StudioComponentConfiguration) Source #

The configuration of the studio component, based on component type.

createStudioComponent_description :: Lens' CreateStudioComponent (Maybe Text) Source #

The description.

createStudioComponent_ec2SecurityGroupIds :: Lens' CreateStudioComponent (Maybe [Text]) Source #

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

createStudioComponent_initializationScripts :: Lens' CreateStudioComponent (Maybe [StudioComponentInitializationScript]) Source #

Initialization scripts for studio components.

createStudioComponent_runtimeRoleArn :: Lens' CreateStudioComponent (Maybe Text) Source #

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

createStudioComponent_scriptParameters :: Lens' CreateStudioComponent (Maybe [ScriptParameterKeyValue]) Source #

Parameters for the studio component scripts.

createStudioComponent_secureInitializationRoleArn :: Lens' CreateStudioComponent (Maybe Text) Source #

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

createStudioComponent_subtype :: Lens' CreateStudioComponent (Maybe StudioComponentSubtype) Source #

The specific subtype of a studio component.

createStudioComponent_tags :: Lens' CreateStudioComponent (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStudioComponent_name :: Lens' CreateStudioComponent Text Source #

The name for the studio component.

createStudioComponent_studioId :: Lens' CreateStudioComponent Text Source #

The studio ID.

createStudioComponent_type :: Lens' CreateStudioComponent StudioComponentType Source #

The type of the studio component.

createStudioComponentResponse_studioComponent :: Lens' CreateStudioComponentResponse (Maybe StudioComponent) Source #

Information about the studio component.

createStudioComponentResponse_httpStatus :: Lens' CreateStudioComponentResponse Int Source #

The response's http status code.

DeleteLaunchProfile

deleteLaunchProfile_clientToken :: Lens' DeleteLaunchProfile (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteLaunchProfile_launchProfileId :: Lens' DeleteLaunchProfile Text Source #

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

deleteLaunchProfile_studioId :: Lens' DeleteLaunchProfile Text Source #

The studio ID.

deleteLaunchProfileResponse_launchProfile :: Lens' DeleteLaunchProfileResponse (Maybe LaunchProfile) Source #

The launch profile.

deleteLaunchProfileResponse_httpStatus :: Lens' DeleteLaunchProfileResponse Int Source #

The response's http status code.

DeleteLaunchProfileMember

deleteLaunchProfileMember_clientToken :: Lens' DeleteLaunchProfileMember (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteLaunchProfileMember_launchProfileId :: Lens' DeleteLaunchProfileMember Text Source #

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

deleteLaunchProfileMember_principalId :: Lens' DeleteLaunchProfileMember Text Source #

The principal ID. This currently supports a IAM Identity Center UserId.

deleteLaunchProfileMember_studioId :: Lens' DeleteLaunchProfileMember Text Source #

The studio ID.

deleteLaunchProfileMemberResponse_httpStatus :: Lens' DeleteLaunchProfileMemberResponse Int Source #

The response's http status code.

DeleteStreamingImage

deleteStreamingImage_clientToken :: Lens' DeleteStreamingImage (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteStreamingImage_streamingImageId :: Lens' DeleteStreamingImage Text Source #

The streaming image ID.

deleteStreamingImage_studioId :: Lens' DeleteStreamingImage Text Source #

The studio ID.

deleteStreamingImageResponse_streamingImage :: Lens' DeleteStreamingImageResponse (Maybe StreamingImage) Source #

The streaming image.

deleteStreamingImageResponse_httpStatus :: Lens' DeleteStreamingImageResponse Int Source #

The response's http status code.

DeleteStreamingSession

deleteStreamingSession_clientToken :: Lens' DeleteStreamingSession (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteStreamingSession_sessionId :: Lens' DeleteStreamingSession Text Source #

The streaming session ID.

deleteStreamingSession_studioId :: Lens' DeleteStreamingSession Text Source #

The studio ID.

deleteStreamingSessionResponse_session :: Lens' DeleteStreamingSessionResponse (Maybe StreamingSession) Source #

The session.

deleteStreamingSessionResponse_httpStatus :: Lens' DeleteStreamingSessionResponse Int Source #

The response's http status code.

DeleteStudio

deleteStudio_clientToken :: Lens' DeleteStudio (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteStudio_studioId :: Lens' DeleteStudio Text Source #

The studio ID.

deleteStudioResponse_httpStatus :: Lens' DeleteStudioResponse Int Source #

The response's http status code.

deleteStudioResponse_studio :: Lens' DeleteStudioResponse Studio Source #

Information about a studio.

DeleteStudioComponent

deleteStudioComponent_clientToken :: Lens' DeleteStudioComponent (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteStudioComponent_studioComponentId :: Lens' DeleteStudioComponent Text Source #

The studio component ID.

deleteStudioComponent_studioId :: Lens' DeleteStudioComponent Text Source #

The studio ID.

deleteStudioComponentResponse_studioComponent :: Lens' DeleteStudioComponentResponse (Maybe StudioComponent) Source #

Information about the studio component.

deleteStudioComponentResponse_httpStatus :: Lens' DeleteStudioComponentResponse Int Source #

The response's http status code.

DeleteStudioMember

deleteStudioMember_clientToken :: Lens' DeleteStudioMember (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

deleteStudioMember_principalId :: Lens' DeleteStudioMember Text Source #

The principal ID. This currently supports a IAM Identity Center UserId.

deleteStudioMember_studioId :: Lens' DeleteStudioMember Text Source #

The studio ID.

deleteStudioMemberResponse_httpStatus :: Lens' DeleteStudioMemberResponse Int Source #

The response's http status code.

GetEula

getEula_eulaId :: Lens' GetEula Text Source #

The EULA ID.

getEulaResponse_eula :: Lens' GetEulaResponse (Maybe Eula) Source #

The EULA.

getEulaResponse_httpStatus :: Lens' GetEulaResponse Int Source #

The response's http status code.

GetLaunchProfile

getLaunchProfile_launchProfileId :: Lens' GetLaunchProfile Text Source #

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

getLaunchProfile_studioId :: Lens' GetLaunchProfile Text Source #

The studio ID.

getLaunchProfileResponse_launchProfile :: Lens' GetLaunchProfileResponse (Maybe LaunchProfile) Source #

The launch profile.

getLaunchProfileResponse_httpStatus :: Lens' GetLaunchProfileResponse Int Source #

The response's http status code.

GetLaunchProfileDetails

getLaunchProfileDetails_launchProfileId :: Lens' GetLaunchProfileDetails Text Source #

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

getLaunchProfileDetails_studioId :: Lens' GetLaunchProfileDetails Text Source #

The studio ID.

getLaunchProfileDetailsResponse_launchProfile :: Lens' GetLaunchProfileDetailsResponse (Maybe LaunchProfile) Source #

The launch profile.

getLaunchProfileDetailsResponse_streamingImages :: Lens' GetLaunchProfileDetailsResponse (Maybe [StreamingImage]) Source #

A collection of streaming images.

getLaunchProfileDetailsResponse_studioComponentSummaries :: Lens' GetLaunchProfileDetailsResponse (Maybe [StudioComponentSummary]) Source #

A collection of studio component summaries.

getLaunchProfileDetailsResponse_httpStatus :: Lens' GetLaunchProfileDetailsResponse Int Source #

The response's http status code.

GetLaunchProfileInitialization

getLaunchProfileInitialization_launchProfileId :: Lens' GetLaunchProfileInitialization Text Source #

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

getLaunchProfileInitialization_launchProfileProtocolVersions :: Lens' GetLaunchProfileInitialization [Text] Source #

The launch profile protocol versions supported by the client.

getLaunchProfileInitialization_launchPurpose :: Lens' GetLaunchProfileInitialization Text Source #

The launch purpose.

getLaunchProfileInitialization_platform :: Lens' GetLaunchProfileInitialization Text Source #

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

getLaunchProfileInitialization_studioId :: Lens' GetLaunchProfileInitialization Text Source #

The studio ID.

getLaunchProfileInitializationResponse_launchProfileInitialization :: Lens' GetLaunchProfileInitializationResponse (Maybe LaunchProfileInitialization) Source #

The launch profile initialization.

getLaunchProfileInitializationResponse_httpStatus :: Lens' GetLaunchProfileInitializationResponse Int Source #

The response's http status code.

GetLaunchProfileMember

getLaunchProfileMember_launchProfileId :: Lens' GetLaunchProfileMember Text Source #

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

getLaunchProfileMember_principalId :: Lens' GetLaunchProfileMember Text Source #

The principal ID. This currently supports a IAM Identity Center UserId.

getLaunchProfileMember_studioId :: Lens' GetLaunchProfileMember Text Source #

The studio ID.

getLaunchProfileMemberResponse_member :: Lens' GetLaunchProfileMemberResponse (Maybe LaunchProfileMembership) Source #

The member.

getLaunchProfileMemberResponse_httpStatus :: Lens' GetLaunchProfileMemberResponse Int Source #

The response's http status code.

GetStreamingImage

getStreamingImage_streamingImageId :: Lens' GetStreamingImage Text Source #

The streaming image ID.

getStreamingImage_studioId :: Lens' GetStreamingImage Text Source #

The studio ID.

getStreamingImageResponse_streamingImage :: Lens' GetStreamingImageResponse (Maybe StreamingImage) Source #

The streaming image.

getStreamingImageResponse_httpStatus :: Lens' GetStreamingImageResponse Int Source #

The response's http status code.

GetStreamingSession

getStreamingSession_sessionId :: Lens' GetStreamingSession Text Source #

The streaming session ID.

getStreamingSession_studioId :: Lens' GetStreamingSession Text Source #

The studio ID.

getStreamingSessionResponse_session :: Lens' GetStreamingSessionResponse (Maybe StreamingSession) Source #

The session.

getStreamingSessionResponse_httpStatus :: Lens' GetStreamingSessionResponse Int Source #

The response's http status code.

GetStreamingSessionBackup

getStreamingSessionBackup_backupId :: Lens' GetStreamingSessionBackup Text Source #

The ID of the backup.

getStreamingSessionBackup_studioId :: Lens' GetStreamingSessionBackup Text Source #

The studio ID.

getStreamingSessionBackupResponse_streamingSessionBackup :: Lens' GetStreamingSessionBackupResponse (Maybe StreamingSessionBackup) Source #

Information about the streaming session backup.

getStreamingSessionBackupResponse_httpStatus :: Lens' GetStreamingSessionBackupResponse Int Source #

The response's http status code.

GetStreamingSessionStream

getStreamingSessionStream_sessionId :: Lens' GetStreamingSessionStream Text Source #

The streaming session ID.

getStreamingSessionStream_streamId :: Lens' GetStreamingSessionStream Text Source #

The streaming session stream ID.

getStreamingSessionStream_studioId :: Lens' GetStreamingSessionStream Text Source #

The studio ID.

getStreamingSessionStreamResponse_stream :: Lens' GetStreamingSessionStreamResponse (Maybe StreamingSessionStream) Source #

The stream.

getStreamingSessionStreamResponse_httpStatus :: Lens' GetStreamingSessionStreamResponse Int Source #

The response's http status code.

GetStudio

getStudio_studioId :: Lens' GetStudio Text Source #

The studio ID.

getStudioResponse_httpStatus :: Lens' GetStudioResponse Int Source #

The response's http status code.

getStudioResponse_studio :: Lens' GetStudioResponse Studio Source #

Information about a studio.

GetStudioComponent

getStudioComponent_studioComponentId :: Lens' GetStudioComponent Text Source #

The studio component ID.

getStudioComponent_studioId :: Lens' GetStudioComponent Text Source #

The studio ID.

getStudioComponentResponse_studioComponent :: Lens' GetStudioComponentResponse (Maybe StudioComponent) Source #

Information about the studio component.

getStudioComponentResponse_httpStatus :: Lens' GetStudioComponentResponse Int Source #

The response's http status code.

GetStudioMember

getStudioMember_principalId :: Lens' GetStudioMember Text Source #

The principal ID. This currently supports a IAM Identity Center UserId.

getStudioMember_studioId :: Lens' GetStudioMember Text Source #

The studio ID.

getStudioMemberResponse_member :: Lens' GetStudioMemberResponse (Maybe StudioMembership) Source #

The member.

getStudioMemberResponse_httpStatus :: Lens' GetStudioMemberResponse Int Source #

The response's http status code.

ListEulaAcceptances

listEulaAcceptances_eulaIds :: Lens' ListEulaAcceptances (Maybe [Text]) Source #

The list of EULA IDs that have been previously accepted.

listEulaAcceptances_nextToken :: Lens' ListEulaAcceptances (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listEulaAcceptances_studioId :: Lens' ListEulaAcceptances Text Source #

The studio ID.

listEulaAcceptancesResponse_eulaAcceptances :: Lens' ListEulaAcceptancesResponse (Maybe [EulaAcceptance]) Source #

A collection of EULA acceptances.

listEulaAcceptancesResponse_nextToken :: Lens' ListEulaAcceptancesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listEulaAcceptancesResponse_httpStatus :: Lens' ListEulaAcceptancesResponse Int Source #

The response's http status code.

ListEulas

listEulas_eulaIds :: Lens' ListEulas (Maybe [Text]) Source #

The list of EULA IDs that should be returned

listEulas_nextToken :: Lens' ListEulas (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listEulasResponse_eulas :: Lens' ListEulasResponse (Maybe [Eula]) Source #

A collection of EULA resources.

listEulasResponse_nextToken :: Lens' ListEulasResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listEulasResponse_httpStatus :: Lens' ListEulasResponse Int Source #

The response's http status code.

ListLaunchProfileMembers

listLaunchProfileMembers_maxResults :: Lens' ListLaunchProfileMembers (Maybe Natural) Source #

The max number of results to return in the response.

listLaunchProfileMembers_nextToken :: Lens' ListLaunchProfileMembers (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listLaunchProfileMembers_launchProfileId :: Lens' ListLaunchProfileMembers Text Source #

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

listLaunchProfileMembers_studioId :: Lens' ListLaunchProfileMembers Text Source #

The studio ID.

listLaunchProfileMembersResponse_members :: Lens' ListLaunchProfileMembersResponse (Maybe [LaunchProfileMembership]) Source #

A list of members.

listLaunchProfileMembersResponse_nextToken :: Lens' ListLaunchProfileMembersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listLaunchProfileMembersResponse_httpStatus :: Lens' ListLaunchProfileMembersResponse Int Source #

The response's http status code.

ListLaunchProfiles

listLaunchProfiles_maxResults :: Lens' ListLaunchProfiles (Maybe Natural) Source #

The max number of results to return in the response.

listLaunchProfiles_nextToken :: Lens' ListLaunchProfiles (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listLaunchProfiles_principalId :: Lens' ListLaunchProfiles (Maybe Text) Source #

The principal ID. This currently supports a IAM Identity Center UserId.

listLaunchProfiles_states :: Lens' ListLaunchProfiles (Maybe [LaunchProfileState]) Source #

Filter this request to launch profiles in any of the given states.

listLaunchProfiles_studioId :: Lens' ListLaunchProfiles Text Source #

The studio ID.

listLaunchProfilesResponse_launchProfiles :: Lens' ListLaunchProfilesResponse (Maybe [LaunchProfile]) Source #

A collection of launch profiles.

listLaunchProfilesResponse_nextToken :: Lens' ListLaunchProfilesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listLaunchProfilesResponse_httpStatus :: Lens' ListLaunchProfilesResponse Int Source #

The response's http status code.

ListStreamingImages

listStreamingImages_nextToken :: Lens' ListStreamingImages (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingImages_owner :: Lens' ListStreamingImages (Maybe Text) Source #

Filter this request to streaming images with the given owner

listStreamingImages_studioId :: Lens' ListStreamingImages Text Source #

The studio ID.

listStreamingImagesResponse_nextToken :: Lens' ListStreamingImagesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingImagesResponse_streamingImages :: Lens' ListStreamingImagesResponse (Maybe [StreamingImage]) Source #

A collection of streaming images.

listStreamingImagesResponse_httpStatus :: Lens' ListStreamingImagesResponse Int Source #

The response's http status code.

ListStreamingSessionBackups

listStreamingSessionBackups_nextToken :: Lens' ListStreamingSessionBackups (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingSessionBackups_ownedBy :: Lens' ListStreamingSessionBackups (Maybe Text) Source #

The user ID of the user that owns the streaming session.

listStreamingSessionBackups_studioId :: Lens' ListStreamingSessionBackups Text Source #

The studio ID.

listStreamingSessionBackupsResponse_nextToken :: Lens' ListStreamingSessionBackupsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingSessionBackupsResponse_streamingSessionBackups :: Lens' ListStreamingSessionBackupsResponse (Maybe [StreamingSessionBackup]) Source #

Information about the streaming session backups.

listStreamingSessionBackupsResponse_httpStatus :: Lens' ListStreamingSessionBackupsResponse Int Source #

The response's http status code.

ListStreamingSessions

listStreamingSessions_createdBy :: Lens' ListStreamingSessions (Maybe Text) Source #

Filters the request to streaming sessions created by the given user.

listStreamingSessions_nextToken :: Lens' ListStreamingSessions (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingSessions_ownedBy :: Lens' ListStreamingSessions (Maybe Text) Source #

Filters the request to streaming session owned by the given user

listStreamingSessions_sessionIds :: Lens' ListStreamingSessions (Maybe Text) Source #

Filters the request to only the provided session IDs.

listStreamingSessions_studioId :: Lens' ListStreamingSessions Text Source #

The studio ID.

listStreamingSessionsResponse_nextToken :: Lens' ListStreamingSessionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStreamingSessionsResponse_sessions :: Lens' ListStreamingSessionsResponse (Maybe [StreamingSession]) Source #

A collection of streaming sessions.

listStreamingSessionsResponse_httpStatus :: Lens' ListStreamingSessionsResponse Int Source #

The response's http status code.

ListStudioComponents

listStudioComponents_maxResults :: Lens' ListStudioComponents (Maybe Natural) Source #

The max number of results to return in the response.

listStudioComponents_nextToken :: Lens' ListStudioComponents (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioComponents_states :: Lens' ListStudioComponents (Maybe [StudioComponentState]) Source #

Filters the request to studio components that are in one of the given states.

listStudioComponents_types :: Lens' ListStudioComponents (Maybe [StudioComponentType]) Source #

Filters the request to studio components that are of one of the given types.

listStudioComponents_studioId :: Lens' ListStudioComponents Text Source #

The studio ID.

listStudioComponentsResponse_nextToken :: Lens' ListStudioComponentsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioComponentsResponse_studioComponents :: Lens' ListStudioComponentsResponse (Maybe [StudioComponent]) Source #

A collection of studio components.

listStudioComponentsResponse_httpStatus :: Lens' ListStudioComponentsResponse Int Source #

The response's http status code.

ListStudioMembers

listStudioMembers_maxResults :: Lens' ListStudioMembers (Maybe Natural) Source #

The max number of results to return in the response.

listStudioMembers_nextToken :: Lens' ListStudioMembers (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioMembers_studioId :: Lens' ListStudioMembers Text Source #

The studio ID.

listStudioMembersResponse_members :: Lens' ListStudioMembersResponse (Maybe [StudioMembership]) Source #

A list of admin members.

listStudioMembersResponse_nextToken :: Lens' ListStudioMembersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioMembersResponse_httpStatus :: Lens' ListStudioMembersResponse Int Source #

The response's http status code.

ListStudios

listStudios_nextToken :: Lens' ListStudios (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudiosResponse_nextToken :: Lens' ListStudiosResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudiosResponse_httpStatus :: Lens' ListStudiosResponse Int Source #

The response's http status code.

listStudiosResponse_studios :: Lens' ListStudiosResponse [Studio] Source #

A collection of studios.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

PutLaunchProfileMembers

putLaunchProfileMembers_clientToken :: Lens' PutLaunchProfileMembers (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

putLaunchProfileMembers_identityStoreId :: Lens' PutLaunchProfileMembers Text Source #

The ID of the identity store.

putLaunchProfileMembers_launchProfileId :: Lens' PutLaunchProfileMembers Text Source #

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

putLaunchProfileMembers_members :: Lens' PutLaunchProfileMembers (NonEmpty NewLaunchProfileMember) Source #

A list of members.

putLaunchProfileMembers_studioId :: Lens' PutLaunchProfileMembers Text Source #

The studio ID.

putLaunchProfileMembersResponse_httpStatus :: Lens' PutLaunchProfileMembersResponse Int Source #

The response's http status code.

PutStudioMembers

putStudioMembers_clientToken :: Lens' PutStudioMembers (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

putStudioMembers_identityStoreId :: Lens' PutStudioMembers Text Source #

The ID of the identity store.

putStudioMembers_members :: Lens' PutStudioMembers (NonEmpty NewStudioMember) Source #

A list of members.

putStudioMembers_studioId :: Lens' PutStudioMembers Text Source #

The studio ID.

putStudioMembersResponse_httpStatus :: Lens' PutStudioMembersResponse Int Source #

The response's http status code.

StartStreamingSession

startStreamingSession_backupId :: Lens' StartStreamingSession (Maybe Text) Source #

The ID of the backup.

startStreamingSession_clientToken :: Lens' StartStreamingSession (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

startStreamingSession_sessionId :: Lens' StartStreamingSession Text Source #

The streaming session ID for the StartStreamingSessionRequest.

startStreamingSession_studioId :: Lens' StartStreamingSession Text Source #

The studio ID for the StartStreamingSessionRequest.

startStreamingSessionResponse_session :: Lens' StartStreamingSessionResponse (Maybe StreamingSession) Source #

Undocumented member.

startStreamingSessionResponse_httpStatus :: Lens' StartStreamingSessionResponse Int Source #

The response's http status code.

StartStudioSSOConfigurationRepair

startStudioSSOConfigurationRepair_clientToken :: Lens' StartStudioSSOConfigurationRepair (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

startStudioSSOConfigurationRepair_studioId :: Lens' StartStudioSSOConfigurationRepair Text Source #

The studio ID.

startStudioSSOConfigurationRepairResponse_httpStatus :: Lens' StartStudioSSOConfigurationRepairResponse Int Source #

The response's http status code.

startStudioSSOConfigurationRepairResponse_studio :: Lens' StartStudioSSOConfigurationRepairResponse Studio Source #

Information about a studio.

StopStreamingSession

stopStreamingSession_clientToken :: Lens' StopStreamingSession (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

stopStreamingSession_volumeRetentionMode :: Lens' StopStreamingSession (Maybe VolumeRetentionMode) Source #

Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

stopStreamingSession_sessionId :: Lens' StopStreamingSession Text Source #

The streaming session ID for the StopStreamingSessionRequest.

stopStreamingSession_studioId :: Lens' StopStreamingSession Text Source #

The studioId for the StopStreamingSessionRequest.

stopStreamingSessionResponse_session :: Lens' StopStreamingSessionResponse (Maybe StreamingSession) Source #

Undocumented member.

stopStreamingSessionResponse_httpStatus :: Lens' StopStreamingSessionResponse Int Source #

The response's http status code.

TagResource

tagResource_tags :: Lens' TagResource (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource you want to add tags to.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

Identifies the Amazon Resource Name(ARN) key from which you are removing tags.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

One or more tag keys. Specify only the tag keys, not the tag values.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateLaunchProfile

updateLaunchProfile_clientToken :: Lens' UpdateLaunchProfile (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

updateLaunchProfile_description :: Lens' UpdateLaunchProfile (Maybe Text) Source #

The description.

updateLaunchProfile_launchProfileProtocolVersions :: Lens' UpdateLaunchProfile (Maybe [Text]) Source #

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

updateLaunchProfile_name :: Lens' UpdateLaunchProfile (Maybe Text) Source #

The name for the launch profile.

updateLaunchProfile_streamConfiguration :: Lens' UpdateLaunchProfile (Maybe StreamConfigurationCreate) Source #

A configuration for a streaming session.

updateLaunchProfile_studioComponentIds :: Lens' UpdateLaunchProfile (Maybe (NonEmpty Text)) Source #

Unique identifiers for a collection of studio components that can be used with this launch profile.

updateLaunchProfile_launchProfileId :: Lens' UpdateLaunchProfile Text Source #

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

updateLaunchProfile_studioId :: Lens' UpdateLaunchProfile Text Source #

The studio ID.

updateLaunchProfileResponse_launchProfile :: Lens' UpdateLaunchProfileResponse (Maybe LaunchProfile) Source #

The launch profile.

updateLaunchProfileResponse_httpStatus :: Lens' UpdateLaunchProfileResponse Int Source #

The response's http status code.

UpdateLaunchProfileMember

updateLaunchProfileMember_clientToken :: Lens' UpdateLaunchProfileMember (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

updateLaunchProfileMember_launchProfileId :: Lens' UpdateLaunchProfileMember Text Source #

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

updateLaunchProfileMember_persona :: Lens' UpdateLaunchProfileMember LaunchProfilePersona Source #

The persona.

updateLaunchProfileMember_principalId :: Lens' UpdateLaunchProfileMember Text Source #

The principal ID. This currently supports a IAM Identity Center UserId.

updateLaunchProfileMember_studioId :: Lens' UpdateLaunchProfileMember Text Source #

The studio ID.

updateLaunchProfileMemberResponse_member :: Lens' UpdateLaunchProfileMemberResponse (Maybe LaunchProfileMembership) Source #

The updated member.

updateLaunchProfileMemberResponse_httpStatus :: Lens' UpdateLaunchProfileMemberResponse Int Source #

The response's http status code.

UpdateStreamingImage

updateStreamingImage_clientToken :: Lens' UpdateStreamingImage (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

updateStreamingImage_description :: Lens' UpdateStreamingImage (Maybe Text) Source #

The description.

updateStreamingImage_name :: Lens' UpdateStreamingImage (Maybe Text) Source #

The name for the streaming image.

updateStreamingImage_streamingImageId :: Lens' UpdateStreamingImage Text Source #

The streaming image ID.

updateStreamingImage_studioId :: Lens' UpdateStreamingImage Text Source #

The studio ID.

updateStreamingImageResponse_streamingImage :: Lens' UpdateStreamingImageResponse (Maybe StreamingImage) Source #

Undocumented member.

updateStreamingImageResponse_httpStatus :: Lens' UpdateStreamingImageResponse Int Source #

The response's http status code.

UpdateStudio

updateStudio_adminRoleArn :: Lens' UpdateStudio (Maybe Text) Source #

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

updateStudio_clientToken :: Lens' UpdateStudio (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

updateStudio_displayName :: Lens' UpdateStudio (Maybe Text) Source #

A friendly name for the studio.

updateStudio_userRoleArn :: Lens' UpdateStudio (Maybe Text) Source #

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

updateStudio_studioId :: Lens' UpdateStudio Text Source #

The studio ID.

updateStudioResponse_httpStatus :: Lens' UpdateStudioResponse Int Source #

The response's http status code.

updateStudioResponse_studio :: Lens' UpdateStudioResponse Studio Source #

Information about a studio.

UpdateStudioComponent

updateStudioComponent_clientToken :: Lens' UpdateStudioComponent (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

updateStudioComponent_configuration :: Lens' UpdateStudioComponent (Maybe StudioComponentConfiguration) Source #

The configuration of the studio component, based on component type.

updateStudioComponent_description :: Lens' UpdateStudioComponent (Maybe Text) Source #

The description.

updateStudioComponent_ec2SecurityGroupIds :: Lens' UpdateStudioComponent (Maybe [Text]) Source #

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

updateStudioComponent_initializationScripts :: Lens' UpdateStudioComponent (Maybe [StudioComponentInitializationScript]) Source #

Initialization scripts for studio components.

updateStudioComponent_name :: Lens' UpdateStudioComponent (Maybe Text) Source #

The name for the studio component.

updateStudioComponent_runtimeRoleArn :: Lens' UpdateStudioComponent (Maybe Text) Source #

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

updateStudioComponent_scriptParameters :: Lens' UpdateStudioComponent (Maybe [ScriptParameterKeyValue]) Source #

Parameters for the studio component scripts.

updateStudioComponent_secureInitializationRoleArn :: Lens' UpdateStudioComponent (Maybe Text) Source #

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

updateStudioComponent_subtype :: Lens' UpdateStudioComponent (Maybe StudioComponentSubtype) Source #

The specific subtype of a studio component.

updateStudioComponent_type :: Lens' UpdateStudioComponent (Maybe StudioComponentType) Source #

The type of the studio component.

updateStudioComponent_studioComponentId :: Lens' UpdateStudioComponent Text Source #

The studio component ID.

updateStudioComponent_studioId :: Lens' UpdateStudioComponent Text Source #

The studio ID.

updateStudioComponentResponse_studioComponent :: Lens' UpdateStudioComponentResponse (Maybe StudioComponent) Source #

Information about the studio component.

updateStudioComponentResponse_httpStatus :: Lens' UpdateStudioComponentResponse Int Source #

The response's http status code.

Types

ActiveDirectoryComputerAttribute

activeDirectoryComputerAttribute_name :: Lens' ActiveDirectoryComputerAttribute (Maybe Text) Source #

The name for the LDAP attribute.

activeDirectoryComputerAttribute_value :: Lens' ActiveDirectoryComputerAttribute (Maybe Text) Source #

The value for the LDAP attribute.

ActiveDirectoryConfiguration

activeDirectoryConfiguration_computerAttributes :: Lens' ActiveDirectoryConfiguration (Maybe [ActiveDirectoryComputerAttribute]) Source #

A collection of custom attributes for an Active Directory computer.

activeDirectoryConfiguration_directoryId :: Lens' ActiveDirectoryConfiguration (Maybe Text) Source #

The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.

activeDirectoryConfiguration_organizationalUnitDistinguishedName :: Lens' ActiveDirectoryConfiguration (Maybe Text) Source #

The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

ComputeFarmConfiguration

computeFarmConfiguration_activeDirectoryUser :: Lens' ComputeFarmConfiguration (Maybe Text) Source #

The name of an Active Directory user that is used on ComputeFarm worker instances.

computeFarmConfiguration_endpoint :: Lens' ComputeFarmConfiguration (Maybe Text) Source #

The endpoint of the ComputeFarm that is accessed by the studio component resource.

Eula

eula_content :: Lens' Eula (Maybe Text) Source #

The EULA content.

eula_createdAt :: Lens' Eula (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

eula_eulaId :: Lens' Eula (Maybe Text) Source #

The EULA ID.

eula_name :: Lens' Eula (Maybe Text) Source #

The name for the EULA.

eula_updatedAt :: Lens' Eula (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

EulaAcceptance

eulaAcceptance_acceptedAt :: Lens' EulaAcceptance (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the EULA was accepted.

eulaAcceptance_acceptedBy :: Lens' EulaAcceptance (Maybe Text) Source #

The ID of the person who accepted the EULA.

eulaAcceptance_accepteeId :: Lens' EulaAcceptance (Maybe Text) Source #

The ID of the acceptee.

eulaAcceptance_eulaAcceptanceId :: Lens' EulaAcceptance (Maybe Text) Source #

The EULA acceptance ID.

eulaAcceptance_eulaId :: Lens' EulaAcceptance (Maybe Text) Source #

The EULA ID.

LaunchProfile

launchProfile_arn :: Lens' LaunchProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

launchProfile_createdAt :: Lens' LaunchProfile (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

launchProfile_createdBy :: Lens' LaunchProfile (Maybe Text) Source #

The user ID of the user that created the launch profile.

launchProfile_description :: Lens' LaunchProfile (Maybe Text) Source #

A human-readable description of the launch profile.

launchProfile_ec2SubnetIds :: Lens' LaunchProfile (Maybe [Text]) Source #

Unique identifiers for a collection of EC2 subnets.

launchProfile_launchProfileId :: Lens' LaunchProfile (Maybe Text) Source #

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

launchProfile_launchProfileProtocolVersions :: Lens' LaunchProfile (Maybe [Text]) Source #

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

launchProfile_name :: Lens' LaunchProfile (Maybe Text) Source #

A friendly name for the launch profile.

launchProfile_state :: Lens' LaunchProfile (Maybe LaunchProfileState) Source #

The current state.

launchProfile_statusCode :: Lens' LaunchProfile (Maybe LaunchProfileStatusCode) Source #

The status code.

launchProfile_statusMessage :: Lens' LaunchProfile (Maybe Text) Source #

The status message for the launch profile.

launchProfile_streamConfiguration :: Lens' LaunchProfile (Maybe StreamConfiguration) Source #

A configuration for a streaming session.

launchProfile_studioComponentIds :: Lens' LaunchProfile (Maybe (NonEmpty Text)) Source #

Unique identifiers for a collection of studio components that can be used with this launch profile.

launchProfile_tags :: Lens' LaunchProfile (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

launchProfile_updatedAt :: Lens' LaunchProfile (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

launchProfile_updatedBy :: Lens' LaunchProfile (Maybe Text) Source #

The user ID of the user that most recently updated the resource.

launchProfile_validationResults :: Lens' LaunchProfile (Maybe [ValidationResult]) Source #

The list of the latest validation results.

LaunchProfileInitialization

launchProfileInitialization_activeDirectory :: Lens' LaunchProfileInitialization (Maybe LaunchProfileInitializationActiveDirectory) Source #

A LaunchProfileInitializationActiveDirectory resource.

launchProfileInitialization_ec2SecurityGroupIds :: Lens' LaunchProfileInitialization (Maybe (NonEmpty Text)) Source #

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

launchProfileInitialization_launchProfileId :: Lens' LaunchProfileInitialization (Maybe Text) Source #

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

launchProfileInitialization_launchProfileProtocolVersion :: Lens' LaunchProfileInitialization (Maybe Text) Source #

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

launchProfileInitialization_launchPurpose :: Lens' LaunchProfileInitialization (Maybe Text) Source #

The launch purpose.

launchProfileInitialization_name :: Lens' LaunchProfileInitialization (Maybe Text) Source #

The name for the launch profile.

launchProfileInitialization_platform :: Lens' LaunchProfileInitialization (Maybe LaunchProfilePlatform) Source #

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

launchProfileInitialization_systemInitializationScripts :: Lens' LaunchProfileInitialization (Maybe [LaunchProfileInitializationScript]) Source #

The system initializtion scripts.

launchProfileInitialization_userInitializationScripts :: Lens' LaunchProfileInitialization (Maybe [LaunchProfileInitializationScript]) Source #

The user initializtion scripts.

LaunchProfileInitializationActiveDirectory

launchProfileInitializationActiveDirectory_computerAttributes :: Lens' LaunchProfileInitializationActiveDirectory (Maybe [ActiveDirectoryComputerAttribute]) Source #

A collection of custom attributes for an Active Directory computer.

launchProfileInitializationActiveDirectory_directoryId :: Lens' LaunchProfileInitializationActiveDirectory (Maybe Text) Source #

The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.

launchProfileInitializationActiveDirectory_directoryName :: Lens' LaunchProfileInitializationActiveDirectory (Maybe Text) Source #

The directory name.

launchProfileInitializationActiveDirectory_dnsIpAddresses :: Lens' LaunchProfileInitializationActiveDirectory (Maybe [Text]) Source #

The DNS IP address.

launchProfileInitializationActiveDirectory_organizationalUnitDistinguishedName :: Lens' LaunchProfileInitializationActiveDirectory (Maybe Text) Source #

The name for the organizational unit distinguished name.

launchProfileInitializationActiveDirectory_studioComponentId :: Lens' LaunchProfileInitializationActiveDirectory (Maybe Text) Source #

The unique identifier for a studio component resource.

launchProfileInitializationActiveDirectory_studioComponentName :: Lens' LaunchProfileInitializationActiveDirectory (Maybe Text) Source #

The name for the studio component.

LaunchProfileInitializationScript

launchProfileInitializationScript_runtimeRoleArn :: Lens' LaunchProfileInitializationScript (Maybe Text) Source #

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

launchProfileInitializationScript_script :: Lens' LaunchProfileInitializationScript (Maybe Text) Source #

The initialization script.

launchProfileInitializationScript_secureInitializationRoleArn :: Lens' LaunchProfileInitializationScript (Maybe Text) Source #

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

launchProfileInitializationScript_studioComponentId :: Lens' LaunchProfileInitializationScript (Maybe Text) Source #

The unique identifier for a studio component resource.

launchProfileInitializationScript_studioComponentName :: Lens' LaunchProfileInitializationScript (Maybe Text) Source #

The name for the studio component.

LaunchProfileMembership

launchProfileMembership_identityStoreId :: Lens' LaunchProfileMembership (Maybe Text) Source #

The ID of the identity store.

launchProfileMembership_persona :: Lens' LaunchProfileMembership (Maybe LaunchProfilePersona) Source #

The persona.

launchProfileMembership_principalId :: Lens' LaunchProfileMembership (Maybe Text) Source #

The principal ID.

launchProfileMembership_sid :: Lens' LaunchProfileMembership (Maybe Text) Source #

The Active Directory Security Identifier for this user, if available.

LicenseServiceConfiguration

licenseServiceConfiguration_endpoint :: Lens' LicenseServiceConfiguration (Maybe Text) Source #

The endpoint of the license service that is accessed by the studio component resource.

NewLaunchProfileMember

newLaunchProfileMember_persona :: Lens' NewLaunchProfileMember LaunchProfilePersona Source #

The persona.

newLaunchProfileMember_principalId :: Lens' NewLaunchProfileMember Text Source #

The principal ID.

NewStudioMember

newStudioMember_persona :: Lens' NewStudioMember StudioPersona Source #

The persona.

newStudioMember_principalId :: Lens' NewStudioMember Text Source #

The principal ID.

ScriptParameterKeyValue

scriptParameterKeyValue_key :: Lens' ScriptParameterKeyValue (Maybe Text) Source #

A script parameter key.

scriptParameterKeyValue_value :: Lens' ScriptParameterKeyValue (Maybe Text) Source #

A script parameter value.

SharedFileSystemConfiguration

sharedFileSystemConfiguration_endpoint :: Lens' SharedFileSystemConfiguration (Maybe Text) Source #

The endpoint of the shared file system that is accessed by the studio component resource.

sharedFileSystemConfiguration_fileSystemId :: Lens' SharedFileSystemConfiguration (Maybe Text) Source #

The unique identifier for a file system.

sharedFileSystemConfiguration_linuxMountPoint :: Lens' SharedFileSystemConfiguration (Maybe Text) Source #

The mount location for a shared file system on a Linux virtual workstation.

sharedFileSystemConfiguration_shareName :: Lens' SharedFileSystemConfiguration (Maybe Text) Source #

The name of the file share.

sharedFileSystemConfiguration_windowsMountDrive :: Lens' SharedFileSystemConfiguration (Maybe Text) Source #

The mount location for a shared file system on a Windows virtual workstation.

StreamConfiguration

streamConfiguration_automaticTerminationMode :: Lens' StreamConfiguration (Maybe AutomaticTerminationMode) Source #

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
  • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

streamConfiguration_maxSessionLengthInMinutes :: Lens' StreamConfiguration (Maybe Natural) Source #

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

streamConfiguration_maxStoppedSessionLengthInMinutes :: Lens' StreamConfiguration (Maybe Natural) Source #

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

streamConfiguration_sessionBackup :: Lens' StreamConfiguration (Maybe StreamConfigurationSessionBackup) Source #

Information about the streaming session backup.

streamConfiguration_sessionPersistenceMode :: Lens' StreamConfiguration (Maybe SessionPersistenceMode) Source #

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

streamConfiguration_sessionStorage :: Lens' StreamConfiguration (Maybe StreamConfigurationSessionStorage) Source #

The upload storage for a streaming session.

streamConfiguration_volumeConfiguration :: Lens' StreamConfiguration (Maybe VolumeConfiguration) Source #

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

streamConfiguration_clipboardMode :: Lens' StreamConfiguration StreamingClipboardMode Source #

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

streamConfiguration_ec2InstanceTypes :: Lens' StreamConfiguration (NonEmpty StreamingInstanceType) Source #

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

streamConfiguration_streamingImageIds :: Lens' StreamConfiguration (NonEmpty Text) Source #

The streaming images that users can select from when launching a streaming session with this launch profile.

StreamConfigurationCreate

streamConfigurationCreate_automaticTerminationMode :: Lens' StreamConfigurationCreate (Maybe AutomaticTerminationMode) Source #

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
  • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

streamConfigurationCreate_maxSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural) Source #

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

streamConfigurationCreate_maxStoppedSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural) Source #

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

streamConfigurationCreate_sessionBackup :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionBackup) Source #

Configures how streaming sessions are backed up when launched from this launch profile.

streamConfigurationCreate_sessionPersistenceMode :: Lens' StreamConfigurationCreate (Maybe SessionPersistenceMode) Source #

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

streamConfigurationCreate_sessionStorage :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionStorage) Source #

The upload storage for a streaming workstation that is created using this launch profile.

streamConfigurationCreate_volumeConfiguration :: Lens' StreamConfigurationCreate (Maybe VolumeConfiguration) Source #

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

streamConfigurationCreate_clipboardMode :: Lens' StreamConfigurationCreate StreamingClipboardMode Source #

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

streamConfigurationCreate_ec2InstanceTypes :: Lens' StreamConfigurationCreate (NonEmpty StreamingInstanceType) Source #

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

streamConfigurationCreate_streamingImageIds :: Lens' StreamConfigurationCreate (NonEmpty Text) Source #

The streaming images that users can select from when launching a streaming session with this launch profile.

StreamConfigurationSessionBackup

streamConfigurationSessionBackup_maxBackupsToRetain :: Lens' StreamConfigurationSessionBackup (Maybe Natural) Source #

The maximum number of backups that each streaming session created from this launch profile can have.

streamConfigurationSessionBackup_mode :: Lens' StreamConfigurationSessionBackup (Maybe SessionBackupMode) Source #

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

StreamConfigurationSessionStorage

streamConfigurationSessionStorage_root :: Lens' StreamConfigurationSessionStorage (Maybe StreamingSessionStorageRoot) Source #

The configuration for the upload storage root of the streaming session.

streamConfigurationSessionStorage_mode :: Lens' StreamConfigurationSessionStorage (NonEmpty StreamingSessionStorageMode) Source #

Allows artists to upload files to their workstations. The only valid option is UPLOAD.

StreamingImage

streamingImage_arn :: Lens' StreamingImage (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

streamingImage_description :: Lens' StreamingImage (Maybe Text) Source #

A human-readable description of the streaming image.

streamingImage_ec2ImageId :: Lens' StreamingImage (Maybe Text) Source #

The ID of an EC2 machine image with which to create the streaming image.

streamingImage_encryptionConfiguration :: Lens' StreamingImage (Maybe StreamingImageEncryptionConfiguration) Source #

The encryption configuration.

streamingImage_eulaIds :: Lens' StreamingImage (Maybe [Text]) Source #

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

streamingImage_name :: Lens' StreamingImage (Maybe Text) Source #

A friendly name for a streaming image resource.

streamingImage_owner :: Lens' StreamingImage (Maybe Text) Source #

The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.

streamingImage_platform :: Lens' StreamingImage (Maybe Text) Source #

The platform of the streaming image, either Windows or Linux.

streamingImage_state :: Lens' StreamingImage (Maybe StreamingImageState) Source #

The current state.

streamingImage_statusCode :: Lens' StreamingImage (Maybe StreamingImageStatusCode) Source #

The status code.

streamingImage_statusMessage :: Lens' StreamingImage (Maybe Text) Source #

The status message for the streaming image.

streamingImage_streamingImageId :: Lens' StreamingImage (Maybe Text) Source #

The ID of the streaming image.

streamingImage_tags :: Lens' StreamingImage (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

StreamingImageEncryptionConfiguration

streamingImageEncryptionConfiguration_keyArn :: Lens' StreamingImageEncryptionConfiguration (Maybe Text) Source #

The ARN for a KMS key that is used to encrypt studio data.

streamingImageEncryptionConfiguration_keyType :: Lens' StreamingImageEncryptionConfiguration StreamingImageEncryptionConfigurationKeyType Source #

The type of KMS key that is used to encrypt studio data.

StreamingSession

streamingSession_arn :: Lens' StreamingSession (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

streamingSession_automaticTerminationMode :: Lens' StreamingSession (Maybe AutomaticTerminationMode) Source #

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
  • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

streamingSession_backupMode :: Lens' StreamingSession (Maybe SessionBackupMode) Source #

Shows the current backup setting of the session.

streamingSession_createdAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

streamingSession_createdBy :: Lens' StreamingSession (Maybe Text) Source #

The user ID of the user that created the streaming session.

streamingSession_ec2InstanceType :: Lens' StreamingSession (Maybe Text) Source #

The EC2 Instance type used for the streaming session.

streamingSession_launchProfileId :: Lens' StreamingSession (Maybe Text) Source #

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

streamingSession_maxBackupsToRetain :: Lens' StreamingSession (Maybe Natural) Source #

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

streamingSession_ownedBy :: Lens' StreamingSession (Maybe Text) Source #

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

streamingSession_sessionId :: Lens' StreamingSession (Maybe Text) Source #

The session ID.

streamingSession_sessionPersistenceMode :: Lens' StreamingSession (Maybe SessionPersistenceMode) Source #

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

streamingSession_startedAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The time the session entered START_IN_PROGRESS state.

streamingSession_startedBy :: Lens' StreamingSession (Maybe Text) Source #

The user ID of the user that started the streaming session.

streamingSession_startedFromBackupId :: Lens' StreamingSession (Maybe Text) Source #

The backup ID used to restore a streaming session.

streamingSession_state :: Lens' StreamingSession (Maybe StreamingSessionState) Source #

The current state.

streamingSession_statusCode :: Lens' StreamingSession (Maybe StreamingSessionStatusCode) Source #

The status code.

streamingSession_statusMessage :: Lens' StreamingSession (Maybe Text) Source #

The status message for the streaming session.

streamingSession_stopAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

streamingSession_stoppedAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The time the session entered STOP_IN_PROGRESS state.

streamingSession_stoppedBy :: Lens' StreamingSession (Maybe Text) Source #

The user ID of the user that stopped the streaming session.

streamingSession_streamingImageId :: Lens' StreamingSession (Maybe Text) Source #

The ID of the streaming image.

streamingSession_tags :: Lens' StreamingSession (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

streamingSession_terminateAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The time the streaming session will automatically terminate if not terminated by the user.

streamingSession_updatedAt :: Lens' StreamingSession (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

streamingSession_updatedBy :: Lens' StreamingSession (Maybe Text) Source #

The user ID of the user that most recently updated the resource.

streamingSession_volumeConfiguration :: Lens' StreamingSession (Maybe VolumeConfiguration) Source #

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

streamingSession_volumeRetentionMode :: Lens' StreamingSession (Maybe VolumeRetentionMode) Source #

Determine if an EBS volume created from this streaming session will be backed up.

StreamingSessionBackup

streamingSessionBackup_arn :: Lens' StreamingSessionBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

streamingSessionBackup_backupId :: Lens' StreamingSessionBackup (Maybe Text) Source #

The ID of the backup.

streamingSessionBackup_createdAt :: Lens' StreamingSessionBackup (Maybe UTCTime) Source #

The ISO timestamp in for when the resource was created.

streamingSessionBackup_launchProfileId :: Lens' StreamingSessionBackup (Maybe Text) Source #

The ID of the launch profile which allowed the backups for the streaming session.

streamingSessionBackup_ownedBy :: Lens' StreamingSessionBackup (Maybe Text) Source #

The user ID of the user that owns the streaming session.

streamingSessionBackup_sessionId :: Lens' StreamingSessionBackup (Maybe Text) Source #

The streaming session ID for the StreamingSessionBackup.

streamingSessionBackup_state :: Lens' StreamingSessionBackup (Maybe StreamingSessionState) Source #

Undocumented member.

streamingSessionBackup_statusCode :: Lens' StreamingSessionBackup (Maybe StreamingSessionStatusCode) Source #

The status code.

streamingSessionBackup_statusMessage :: Lens' StreamingSessionBackup (Maybe Text) Source #

The status message for the streaming session backup.

streamingSessionBackup_tags :: Lens' StreamingSessionBackup (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

StreamingSessionStorageRoot

streamingSessionStorageRoot_linux :: Lens' StreamingSessionStorageRoot (Maybe Text) Source #

The folder path in Linux workstations where files are uploaded.

streamingSessionStorageRoot_windows :: Lens' StreamingSessionStorageRoot (Maybe Text) Source #

The folder path in Windows workstations where files are uploaded.

StreamingSessionStream

streamingSessionStream_createdAt :: Lens' StreamingSessionStream (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

streamingSessionStream_createdBy :: Lens' StreamingSessionStream (Maybe Text) Source #

The user ID of the user that created the streaming session stream.

streamingSessionStream_expiresAt :: Lens' StreamingSessionStream (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource expires.

streamingSessionStream_ownedBy :: Lens' StreamingSessionStream (Maybe Text) Source #

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

streamingSessionStream_state :: Lens' StreamingSessionStream (Maybe StreamingSessionStreamState) Source #

The current state.

streamingSessionStream_statusCode :: Lens' StreamingSessionStream (Maybe StreamingSessionStreamStatusCode) Source #

The streaming session stream status code.

streamingSessionStream_streamId :: Lens' StreamingSessionStream (Maybe Text) Source #

The stream ID.

streamingSessionStream_url :: Lens' StreamingSessionStream (Maybe Text) Source #

The URL to connect to this stream using the DCV client.

Studio

studio_adminRoleArn :: Lens' Studio (Maybe Text) Source #

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

studio_arn :: Lens' Studio (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

studio_createdAt :: Lens' Studio (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

studio_displayName :: Lens' Studio (Maybe Text) Source #

A friendly name for the studio.

studio_homeRegion :: Lens' Studio (Maybe Text) Source #

The Amazon Web Services Region where the studio resource is located.

studio_ssoClientId :: Lens' Studio (Maybe Text) Source #

The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.

studio_state :: Lens' Studio (Maybe StudioState) Source #

The current state of the studio resource.

studio_statusCode :: Lens' Studio (Maybe StudioStatusCode) Source #

Status codes that provide additional detail on the studio state.

studio_statusMessage :: Lens' Studio (Maybe Text) Source #

Additional detail on the studio state.

studio_studioEncryptionConfiguration :: Lens' Studio (Maybe StudioEncryptionConfiguration) Source #

Configuration of the encryption method that is used for the studio.

studio_studioId :: Lens' Studio (Maybe Text) Source #

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

studio_studioName :: Lens' Studio (Maybe Text) Source #

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

studio_studioUrl :: Lens' Studio (Maybe Text) Source #

The address of the web page for the studio.

studio_tags :: Lens' Studio (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

studio_updatedAt :: Lens' Studio (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

studio_userRoleArn :: Lens' Studio (Maybe Text) Source #

The IAM role that studio users assume when logging in to the Nimble Studio portal.

StudioComponent

studioComponent_arn :: Lens' StudioComponent (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

studioComponent_configuration :: Lens' StudioComponent (Maybe StudioComponentConfiguration) Source #

The configuration of the studio component, based on component type.

studioComponent_createdAt :: Lens' StudioComponent (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

studioComponent_createdBy :: Lens' StudioComponent (Maybe Text) Source #

The user ID of the user that created the studio component.

studioComponent_description :: Lens' StudioComponent (Maybe Text) Source #

A human-readable description for the studio component resource.

studioComponent_ec2SecurityGroupIds :: Lens' StudioComponent (Maybe [Text]) Source #

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

studioComponent_initializationScripts :: Lens' StudioComponent (Maybe [StudioComponentInitializationScript]) Source #

Initialization scripts for studio components.

studioComponent_name :: Lens' StudioComponent (Maybe Text) Source #

A friendly name for the studio component resource.

studioComponent_runtimeRoleArn :: Lens' StudioComponent (Maybe Text) Source #

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

studioComponent_scriptParameters :: Lens' StudioComponent (Maybe [ScriptParameterKeyValue]) Source #

Parameters for the studio component scripts.

studioComponent_secureInitializationRoleArn :: Lens' StudioComponent (Maybe Text) Source #

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

studioComponent_state :: Lens' StudioComponent (Maybe StudioComponentState) Source #

The current state.

studioComponent_statusCode :: Lens' StudioComponent (Maybe StudioComponentStatusCode) Source #

The status code.

studioComponent_statusMessage :: Lens' StudioComponent (Maybe Text) Source #

The status message for the studio component.

studioComponent_studioComponentId :: Lens' StudioComponent (Maybe Text) Source #

The unique identifier for a studio component resource.

studioComponent_subtype :: Lens' StudioComponent (Maybe StudioComponentSubtype) Source #

The specific subtype of a studio component.

studioComponent_tags :: Lens' StudioComponent (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

studioComponent_type :: Lens' StudioComponent (Maybe StudioComponentType) Source #

The type of the studio component.

studioComponent_updatedAt :: Lens' StudioComponent (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

studioComponent_updatedBy :: Lens' StudioComponent (Maybe Text) Source #

The user ID of the user that most recently updated the resource.

StudioComponentConfiguration

studioComponentConfiguration_activeDirectoryConfiguration :: Lens' StudioComponentConfiguration (Maybe ActiveDirectoryConfiguration) Source #

The configuration for a Directory Service for Microsoft Active Directory studio resource.

studioComponentConfiguration_computeFarmConfiguration :: Lens' StudioComponentConfiguration (Maybe ComputeFarmConfiguration) Source #

The configuration for a render farm that is associated with a studio resource.

studioComponentConfiguration_licenseServiceConfiguration :: Lens' StudioComponentConfiguration (Maybe LicenseServiceConfiguration) Source #

The configuration for a license service that is associated with a studio resource.

studioComponentConfiguration_sharedFileSystemConfiguration :: Lens' StudioComponentConfiguration (Maybe SharedFileSystemConfiguration) Source #

The configuration for a shared file storage system that is associated with a studio resource.

StudioComponentInitializationScript

studioComponentInitializationScript_launchProfileProtocolVersion :: Lens' StudioComponentInitializationScript (Maybe Text) Source #

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

studioComponentInitializationScript_platform :: Lens' StudioComponentInitializationScript (Maybe LaunchProfilePlatform) Source #

The platform of the initialization script, either Windows or Linux.

studioComponentInitializationScript_runContext :: Lens' StudioComponentInitializationScript (Maybe StudioComponentInitializationScriptRunContext) Source #

The method to use when running the initialization script.

studioComponentInitializationScript_script :: Lens' StudioComponentInitializationScript (Maybe Text) Source #

The initialization script.

StudioComponentSummary

studioComponentSummary_createdAt :: Lens' StudioComponentSummary (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

studioComponentSummary_createdBy :: Lens' StudioComponentSummary (Maybe Text) Source #

The user ID of the user that created the studio component.

studioComponentSummary_description :: Lens' StudioComponentSummary (Maybe Text) Source #

The description.

studioComponentSummary_name :: Lens' StudioComponentSummary (Maybe Text) Source #

The name for the studio component.

studioComponentSummary_studioComponentId :: Lens' StudioComponentSummary (Maybe Text) Source #

The unique identifier for a studio component resource.

studioComponentSummary_subtype :: Lens' StudioComponentSummary (Maybe StudioComponentSubtype) Source #

The specific subtype of a studio component.

studioComponentSummary_type :: Lens' StudioComponentSummary (Maybe StudioComponentType) Source #

The type of the studio component.

studioComponentSummary_updatedAt :: Lens' StudioComponentSummary (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

studioComponentSummary_updatedBy :: Lens' StudioComponentSummary (Maybe Text) Source #

The user ID of the user that most recently updated the resource.

StudioEncryptionConfiguration

studioEncryptionConfiguration_keyArn :: Lens' StudioEncryptionConfiguration (Maybe Text) Source #

The ARN for a KMS key that is used to encrypt studio data.

studioEncryptionConfiguration_keyType :: Lens' StudioEncryptionConfiguration StudioEncryptionConfigurationKeyType Source #

The type of KMS key that is used to encrypt studio data.

StudioMembership

studioMembership_identityStoreId :: Lens' StudioMembership (Maybe Text) Source #

The ID of the identity store.

studioMembership_persona :: Lens' StudioMembership (Maybe StudioPersona) Source #

The persona.

studioMembership_principalId :: Lens' StudioMembership (Maybe Text) Source #

The principal ID.

studioMembership_sid :: Lens' StudioMembership (Maybe Text) Source #

The Active Directory Security Identifier for this user, if available.

ValidationResult

validationResult_state :: Lens' ValidationResult LaunchProfileValidationState Source #

The current state.

validationResult_statusCode :: Lens' ValidationResult LaunchProfileValidationStatusCode Source #

The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

validationResult_statusMessage :: Lens' ValidationResult Text Source #

The status message for the validation result.

validationResult_type :: Lens' ValidationResult LaunchProfileValidationType Source #

The type of the validation result.

VolumeConfiguration

volumeConfiguration_iops :: Lens' VolumeConfiguration (Maybe Natural) Source #

The number of I/O operations per second for the root volume that is attached to streaming session.

volumeConfiguration_size :: Lens' VolumeConfiguration (Maybe Natural) Source #

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

volumeConfiguration_throughput :: Lens' VolumeConfiguration (Maybe Natural) Source #

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.