The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::NimbleStudio

NAME

Paws::NimbleStudio - Perl Interface to AWS AmazonNimbleStudio

SYNOPSIS

  use Paws;

  my $obj = Paws->service('NimbleStudio');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01

METHODS

AcceptEulas

StudioId => Str
[ClientToken => Str]
[EulaIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NimbleStudio::AcceptEulas

Returns: a Paws::NimbleStudio::AcceptEulasResponse instance

Accept EULAs.

CreateLaunchProfile

Ec2SubnetIds => ArrayRef[Str|Undef]
LaunchProfileProtocolVersions => ArrayRef[Str|Undef]
Name => Str
StreamConfiguration => Paws::NimbleStudio::StreamConfigurationCreate
StudioComponentIds => ArrayRef[Str|Undef]
StudioId => Str
[ClientToken => Str]
[Description => Str]
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::CreateLaunchProfile

Returns: a Paws::NimbleStudio::CreateLaunchProfileResponse instance

Create a launch profile.

CreateStreamingImage

Ec2ImageId => Str
Name => Str
StudioId => Str
[ClientToken => Str]
[Description => Str]
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::CreateStreamingImage

Returns: a Paws::NimbleStudio::CreateStreamingImageResponse instance

Creates a streaming image resource in a studio.

CreateStreamingSession

StudioId => Str
[ClientToken => Str]
[Ec2InstanceType => Str]
[LaunchProfileId => Str]
[StreamingImageId => Str]
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::CreateStreamingSession

Returns: a Paws::NimbleStudio::CreateStreamingSessionResponse instance

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

CreateStreamingSessionStream

SessionId => Str
StudioId => Str
[ClientToken => Str]
[ExpirationInSeconds => Int]

Each argument is described in detail in: Paws::NimbleStudio::CreateStreamingSessionStream

Returns: a Paws::NimbleStudio::CreateStreamingSessionStreamResponse instance

Creates a streaming session stream for a streaming session.

After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.

CreateStudio

AdminRoleArn => Str
DisplayName => Str
StudioName => Str
UserRoleArn => Str
[ClientToken => Str]
[StudioEncryptionConfiguration => Paws::NimbleStudio::StudioEncryptionConfiguration]
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::CreateStudio

Returns: a Paws::NimbleStudio::CreateStudioResponse instance

Create a new Studio.

When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an AWS KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

CreateStudioComponent

Name => Str
StudioId => Str
Type => Str
[ClientToken => Str]
[Configuration => Paws::NimbleStudio::StudioComponentConfiguration]
[Description => Str]
[Ec2SecurityGroupIds => ArrayRef[Str|Undef]]
[InitializationScripts => ArrayRef[Paws::NimbleStudio::StudioComponentInitializationScript]]
[ScriptParameters => ArrayRef[Paws::NimbleStudio::ScriptParameterKeyValue]]
[Subtype => Str]
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::CreateStudioComponent

Returns: a Paws::NimbleStudio::CreateStudioComponentResponse instance

Creates a studio component resource.

DeleteLaunchProfile

LaunchProfileId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteLaunchProfile

Returns: a Paws::NimbleStudio::DeleteLaunchProfileResponse instance

Permanently delete a launch profile.

DeleteLaunchProfileMember

LaunchProfileId => Str
PrincipalId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteLaunchProfileMember

Returns: a Paws::NimbleStudio::DeleteLaunchProfileMemberResponse instance

Delete a user from launch profile membership.

DeleteStreamingImage

StreamingImageId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteStreamingImage

Returns: a Paws::NimbleStudio::DeleteStreamingImageResponse instance

Delete streaming image.

DeleteStreamingSession

SessionId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteStreamingSession

Returns: a Paws::NimbleStudio::DeleteStreamingSessionResponse instance

Deletes streaming session resource.

After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.

A streaming session will count against your streaming session quota until it is marked DELETED.

DeleteStudio

StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteStudio

Returns: a Paws::NimbleStudio::DeleteStudioResponse instance

Delete a studio resource.

DeleteStudioComponent

StudioComponentId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteStudioComponent

Returns: a Paws::NimbleStudio::DeleteStudioComponentResponse instance

Deletes a studio component resource.

DeleteStudioMember

PrincipalId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::DeleteStudioMember

Returns: a Paws::NimbleStudio::DeleteStudioMemberResponse instance

Delete a user from studio membership.

GetEula

EulaId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetEula

Returns: a Paws::NimbleStudio::GetEulaResponse instance

Get Eula.

GetLaunchProfile

LaunchProfileId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetLaunchProfile

Returns: a Paws::NimbleStudio::GetLaunchProfileResponse instance

Get a launch profile.

GetLaunchProfileDetails

LaunchProfileId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetLaunchProfileDetails

Returns: a Paws::NimbleStudio::GetLaunchProfileDetailsResponse instance

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

GetLaunchProfileInitialization

LaunchProfileId => Str
LaunchProfileProtocolVersions => ArrayRef[Str|Undef]
LaunchPurpose => Str
Platform => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetLaunchProfileInitialization

Returns: a Paws::NimbleStudio::GetLaunchProfileInitializationResponse instance

Get a launch profile initialization.

GetLaunchProfileMember

LaunchProfileId => Str
PrincipalId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetLaunchProfileMember

Returns: a Paws::NimbleStudio::GetLaunchProfileMemberResponse instance

Get a user persona in launch profile membership.

GetStreamingImage

StreamingImageId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStreamingImage

Returns: a Paws::NimbleStudio::GetStreamingImageResponse instance

Get streaming image.

GetStreamingSession

SessionId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStreamingSession

Returns: a Paws::NimbleStudio::GetStreamingSessionResponse instance

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

GetStreamingSessionStream

SessionId => Str
StreamId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStreamingSessionStream

Returns: a Paws::NimbleStudio::GetStreamingSessionStreamResponse instance

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

GetStudio

StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStudio

Returns: a Paws::NimbleStudio::GetStudioResponse instance

Get a Studio resource.

GetStudioComponent

StudioComponentId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStudioComponent

Returns: a Paws::NimbleStudio::GetStudioComponentResponse instance

Gets a studio component resource.

GetStudioMember

PrincipalId => Str
StudioId => Str

Each argument is described in detail in: Paws::NimbleStudio::GetStudioMember

Returns: a Paws::NimbleStudio::GetStudioMemberResponse instance

Get a user's membership in a studio.

ListEulaAcceptances

StudioId => Str
[EulaIds => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListEulaAcceptances

Returns: a Paws::NimbleStudio::ListEulaAcceptancesResponse instance

List Eula Acceptances.

ListEulas

[EulaIds => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListEulas

Returns: a Paws::NimbleStudio::ListEulasResponse instance

List Eulas.

ListLaunchProfileMembers

LaunchProfileId => Str
StudioId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListLaunchProfileMembers

Returns: a Paws::NimbleStudio::ListLaunchProfileMembersResponse instance

Get all users in a given launch profile membership.

ListLaunchProfiles

StudioId => Str
[MaxResults => Int]
[NextToken => Str]
[PrincipalId => Str]
[States => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NimbleStudio::ListLaunchProfiles

Returns: a Paws::NimbleStudio::ListLaunchProfilesResponse instance

List all the launch profiles a studio.

ListStreamingImages

StudioId => Str
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListStreamingImages

Returns: a Paws::NimbleStudio::ListStreamingImagesResponse instance

List the streaming image resources available to this studio.

This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.

ListStreamingSessions

StudioId => Str
[CreatedBy => Str]
[NextToken => Str]
[SessionIds => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListStreamingSessions

Returns: a Paws::NimbleStudio::ListStreamingSessionsResponse instance

Lists the streaming image resources in a studio.

ListStudioComponents

StudioId => Str
[MaxResults => Int]
[NextToken => Str]
[States => ArrayRef[Str|Undef]]
[Types => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NimbleStudio::ListStudioComponents

Returns: a Paws::NimbleStudio::ListStudioComponentsResponse instance

Lists the StudioComponents in a studio.

ListStudioMembers

StudioId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListStudioMembers

Returns: a Paws::NimbleStudio::ListStudioMembersResponse instance

Get all users in a given studio membership.

ListStudios

[NextToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::ListStudios

Returns: a Paws::NimbleStudio::ListStudiosResponse instance

List studios in your AWS account in the requested AWS Region.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::NimbleStudio::ListTagsForResource

Returns: a Paws::NimbleStudio::ListTagsForResourceResponse instance

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

This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.

PutLaunchProfileMembers

IdentityStoreId => Str
LaunchProfileId => Str
Members => ArrayRef[Paws::NimbleStudio::NewLaunchProfileMember]
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::PutLaunchProfileMembers

Returns: a Paws::NimbleStudio::PutLaunchProfileMembersResponse instance

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

PutStudioMembers

IdentityStoreId => Str
Members => ArrayRef[Paws::NimbleStudio::NewStudioMember]
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::PutStudioMembers

Returns: a Paws::NimbleStudio::PutStudioMembersResponse instance

Add/update users with given persona to studio membership.

StartStudioSSOConfigurationRepair

StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::StartStudioSSOConfigurationRepair

Returns: a Paws::NimbleStudio::StartStudioSSOConfigurationRepairResponse instance

Repairs the SSO configuration for a given studio.

If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.

After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

TagResource

ResourceArn => Str
[Tags => Paws::NimbleStudio::Tags]

Each argument is described in detail in: Paws::NimbleStudio::TagResource

Returns: a Paws::NimbleStudio::TagResourceResponse instance

Creates tags for a resource, given its ARN.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::NimbleStudio::UntagResource

Returns: a Paws::NimbleStudio::UntagResourceResponse instance

Deletes the tags for a resource.

UpdateLaunchProfile

LaunchProfileId => Str
StudioId => Str
[ClientToken => Str]
[Description => Str]
[LaunchProfileProtocolVersions => ArrayRef[Str|Undef]]
[Name => Str]
[StreamConfiguration => Paws::NimbleStudio::StreamConfigurationCreate]
[StudioComponentIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NimbleStudio::UpdateLaunchProfile

Returns: a Paws::NimbleStudio::UpdateLaunchProfileResponse instance

Update a launch profile.

UpdateLaunchProfileMember

LaunchProfileId => Str
Persona => Str
PrincipalId => Str
StudioId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::NimbleStudio::UpdateLaunchProfileMember

Returns: a Paws::NimbleStudio::UpdateLaunchProfileMemberResponse instance

Update a user persona in launch profile membership.

UpdateStreamingImage

StreamingImageId => Str
StudioId => Str
[ClientToken => Str]
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::NimbleStudio::UpdateStreamingImage

Returns: a Paws::NimbleStudio::UpdateStreamingImageResponse instance

Update streaming image.

UpdateStudio

StudioId => Str
[AdminRoleArn => Str]
[ClientToken => Str]
[DisplayName => Str]
[UserRoleArn => Str]

Each argument is described in detail in: Paws::NimbleStudio::UpdateStudio

Returns: a Paws::NimbleStudio::UpdateStudioResponse instance

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

UpdateStudioComponent

StudioComponentId => Str
StudioId => Str
[ClientToken => Str]
[Configuration => Paws::NimbleStudio::StudioComponentConfiguration]
[Description => Str]
[Ec2SecurityGroupIds => ArrayRef[Str|Undef]]
[InitializationScripts => ArrayRef[Paws::NimbleStudio::StudioComponentInitializationScript]]
[Name => Str]
[ScriptParameters => ArrayRef[Paws::NimbleStudio::ScriptParameterKeyValue]]
[Subtype => Str]
[Type => Str]

Each argument is described in detail in: Paws::NimbleStudio::UpdateStudioComponent

Returns: a Paws::NimbleStudio::UpdateStudioComponentResponse instance

Updates a studio component resource.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllEulaAcceptances(sub { },StudioId => Str, [EulaIds => ArrayRef[Str|Undef], NextToken => Str])

ListAllEulaAcceptances(StudioId => Str, [EulaIds => ArrayRef[Str|Undef], NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - eulaAcceptances, passing the object as the first parameter, and the string 'eulaAcceptances' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListEulaAcceptancesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEulas(sub { },[EulaIds => ArrayRef[Str|Undef], NextToken => Str])

ListAllEulas([EulaIds => ArrayRef[Str|Undef], NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - eulas, passing the object as the first parameter, and the string 'eulas' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListEulasResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLaunchProfileMembers(sub { },LaunchProfileId => Str, StudioId => Str, [MaxResults => Int, NextToken => Str])

ListAllLaunchProfileMembers(LaunchProfileId => Str, StudioId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - members, passing the object as the first parameter, and the string 'members' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListLaunchProfileMembersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLaunchProfiles(sub { },StudioId => Str, [MaxResults => Int, NextToken => Str, PrincipalId => Str, States => ArrayRef[Str|Undef]])

ListAllLaunchProfiles(StudioId => Str, [MaxResults => Int, NextToken => Str, PrincipalId => Str, States => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - launchProfiles, passing the object as the first parameter, and the string 'launchProfiles' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListLaunchProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllStreamingImages(sub { },StudioId => Str, [NextToken => Str, Owner => Str])

ListAllStreamingImages(StudioId => Str, [NextToken => Str, Owner => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - streamingImages, passing the object as the first parameter, and the string 'streamingImages' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListStreamingImagesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllStreamingSessions(sub { },StudioId => Str, [CreatedBy => Str, NextToken => Str, SessionIds => Str])

ListAllStreamingSessions(StudioId => Str, [CreatedBy => Str, NextToken => Str, SessionIds => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - sessions, passing the object as the first parameter, and the string 'sessions' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListStreamingSessionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllStudioComponents(sub { },StudioId => Str, [MaxResults => Int, NextToken => Str, States => ArrayRef[Str|Undef], Types => ArrayRef[Str|Undef]])

ListAllStudioComponents(StudioId => Str, [MaxResults => Int, NextToken => Str, States => ArrayRef[Str|Undef], Types => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - studioComponents, passing the object as the first parameter, and the string 'studioComponents' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListStudioComponentsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllStudioMembers(sub { },StudioId => Str, [MaxResults => Int, NextToken => Str])

ListAllStudioMembers(StudioId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - members, passing the object as the first parameter, and the string 'members' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListStudioMembersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllStudios(sub { },[NextToken => Str])

ListAllStudios([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - studios, passing the object as the first parameter, and the string 'studios' as the second parameter

If not, it will return a a Paws::NimbleStudio::ListStudiosResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues