AcceptEulas

$result = $client->acceptEulas([/* ... */]);
$promise = $client->acceptEulasAsync([/* ... */]);

Accept EULAs.

Parameter Syntax

$result = $client->acceptEulas([
    'clientToken' => '<string>',
    'eulaIds' => ['<string>', ...],
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eulaAcceptances' => [
        [
            'acceptedAt' => <DateTime>,
            'acceptedBy' => '<string>',
            'accepteeId' => '<string>',
            'eulaAcceptanceId' => '<string>',
            'eulaId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateLaunchProfile

$result = $client->createLaunchProfile([/* ... */]);
$promise = $client->createLaunchProfileAsync([/* ... */]);

Create a launch profile.

Parameter Syntax

$result = $client->createLaunchProfile([
    'clientToken' => '<string>',
    'description' => '<string>',
    'ec2SubnetIds' => ['<string>', ...], // REQUIRED
    'launchProfileProtocolVersions' => ['<string>', ...], // REQUIRED
    'name' => '<string>', // REQUIRED
    'streamConfiguration' => [ // REQUIRED
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'clipboardMode' => 'ENABLED|DISABLED', // REQUIRED
        'ec2InstanceTypes' => ['<string>', ...], // REQUIRED
        'maxSessionLengthInMinutes' => <integer>,
        'maxStoppedSessionLengthInMinutes' => <integer>,
        'sessionBackup' => [
            'maxBackupsToRetain' => <integer>,
            'mode' => 'AUTOMATIC|DEACTIVATED',
        ],
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'sessionStorage' => [
            'mode' => ['<string>', ...], // REQUIRED
            'root' => [
                'linux' => '<string>',
                'windows' => '<string>',
            ],
        ],
        'streamingImageIds' => ['<string>', ...], // REQUIRED
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
    ],
    'studioComponentIds' => ['<string>', ...], // REQUIRED
    'studioId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'launchProfile' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SubnetIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersions' => ['<string>', ...],
        'name' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
        'statusMessage' => '<string>',
        'streamConfiguration' => [
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'clipboardMode' => 'ENABLED|DISABLED',
            'ec2InstanceTypes' => ['<string>', ...],
            'maxSessionLengthInMinutes' => <integer>,
            'maxStoppedSessionLengthInMinutes' => <integer>,
            'sessionBackup' => [
                'maxBackupsToRetain' => <integer>,
                'mode' => 'AUTOMATIC|DEACTIVATED',
            ],
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'sessionStorage' => [
                'mode' => ['<string>', ...],
                'root' => [
                    'linux' => '<string>',
                    'windows' => '<string>',
                ],
            ],
            'streamingImageIds' => ['<string>', ...],
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
        ],
        'studioComponentIds' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'validationResults' => [
            [
                'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage' => '<string>',
                'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateStreamingImage

$result = $client->createStreamingImage([/* ... */]);
$promise = $client->createStreamingImageAsync([/* ... */]);

Creates a streaming image resource in a studio.

Parameter Syntax

$result = $client->createStreamingImage([
    'clientToken' => '<string>',
    'description' => '<string>',
    'ec2ImageId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'streamingImage' => [
        'arn' => '<string>',
        'description' => '<string>',
        'ec2ImageId' => '<string>',
        'encryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'CUSTOMER_MANAGED_KEY',
        ],
        'eulaIds' => ['<string>', ...],
        'name' => '<string>',
        'owner' => '<string>',
        'platform' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
        'statusMessage' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateStreamingSession

$result = $client->createStreamingSession([/* ... */]);
$promise = $client->createStreamingSessionAsync([/* ... */]);

Creates a streaming session in a studio.

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

Parameter Syntax

$result = $client->createStreamingSession([
    'clientToken' => '<string>',
    'ec2InstanceType' => 'g4dn.xlarge|g4dn.2xlarge|g4dn.4xlarge|g4dn.8xlarge|g4dn.12xlarge|g4dn.16xlarge|g3.4xlarge|g3s.xlarge|g5.xlarge|g5.2xlarge|g5.4xlarge|g5.8xlarge|g5.16xlarge',
    'launchProfileId' => '<string>', // REQUIRED
    'ownedBy' => '<string>',
    'streamingImageId' => '<string>',
    'studioId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'session' => [
        'arn' => '<string>',
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'backupMode' => 'AUTOMATIC|DEACTIVATED',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'ec2InstanceType' => '<string>',
        'launchProfileId' => '<string>',
        'maxBackupsToRetain' => <integer>,
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'startedFromBackupId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'stopAt' => <DateTime>,
        'stoppedAt' => <DateTime>,
        'stoppedBy' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateAt' => <DateTime>,
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
        'volumeRetentionMode' => 'RETAIN|DELETE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateStreamingSessionStream

$result = $client->createStreamingSessionStream([/* ... */]);
$promise = $client->createStreamingSessionStreamAsync([/* ... */]);

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 the READY state.

Parameter Syntax

$result = $client->createStreamingSessionStream([
    'clientToken' => '<string>',
    'expirationInSeconds' => <integer>,
    'sessionId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'stream' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'expiresAt' => <DateTime>,
        'ownedBy' => '<string>',
        'state' => 'READY|CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAM_CREATE_IN_PROGRESS|STREAM_READY|STREAM_DELETE_IN_PROGRESS|STREAM_DELETED|INTERNAL_ERROR|NETWORK_CONNECTION_ERROR',
        'streamId' => '<string>',
        'url' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateStudio

$result = $client->createStudio([/* ... */]);
$promise = $client->createStudioAsync([/* ... */]);

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 KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an 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.

Parameter Syntax

$result = $client->createStudio([
    'adminRoleArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'studioEncryptionConfiguration' => [
        'keyArn' => '<string>',
        'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY', // REQUIRED
    ],
    'studioName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'userRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studio' => [
        'adminRoleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'homeRegion' => '<string>',
        'ssoClientId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
        'statusMessage' => '<string>',
        'studioEncryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        ],
        'studioId' => '<string>',
        'studioName' => '<string>',
        'studioUrl' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'userRoleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

CreateStudioComponent

$result = $client->createStudioComponent([/* ... */]);
$promise = $client->createStudioComponentAsync([/* ... */]);

Creates a studio component resource.

Parameter Syntax

$result = $client->createStudioComponent([
    'clientToken' => '<string>',
    'configuration' => [
        'activeDirectoryConfiguration' => [
            'computerAttributes' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'directoryId' => '<string>',
            'organizationalUnitDistinguishedName' => '<string>',
        ],
        'computeFarmConfiguration' => [
            'activeDirectoryUser' => '<string>',
            'endpoint' => '<string>',
        ],
        'licenseServiceConfiguration' => [
            'endpoint' => '<string>',
        ],
        'sharedFileSystemConfiguration' => [
            'endpoint' => '<string>',
            'fileSystemId' => '<string>',
            'linuxMountPoint' => '<string>',
            'shareName' => '<string>',
            'windowsMountDrive' => '<string>',
        ],
    ],
    'description' => '<string>',
    'ec2SecurityGroupIds' => ['<string>', ...],
    'initializationScripts' => [
        [
            'launchProfileProtocolVersion' => '<string>',
            'platform' => 'LINUX|WINDOWS',
            'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
            'script' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'runtimeRoleArn' => '<string>',
    'scriptParameters' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'secureInitializationRoleArn' => '<string>',
    'studioId' => '<string>', // REQUIRED
    'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
    'tags' => ['<string>', ...],
    'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studioComponent' => [
        'arn' => '<string>',
        'configuration' => [
            'activeDirectoryConfiguration' => [
                'computerAttributes' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'directoryId' => '<string>',
                'organizationalUnitDistinguishedName' => '<string>',
            ],
            'computeFarmConfiguration' => [
                'activeDirectoryUser' => '<string>',
                'endpoint' => '<string>',
            ],
            'licenseServiceConfiguration' => [
                'endpoint' => '<string>',
            ],
            'sharedFileSystemConfiguration' => [
                'endpoint' => '<string>',
                'fileSystemId' => '<string>',
                'linuxMountPoint' => '<string>',
                'shareName' => '<string>',
                'windowsMountDrive' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SecurityGroupIds' => ['<string>', ...],
        'initializationScripts' => [
            [
                'launchProfileProtocolVersion' => '<string>',
                'platform' => 'LINUX|WINDOWS',
                'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
                'script' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>',
        'runtimeRoleArn' => '<string>',
        'scriptParameters' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'secureInitializationRoleArn' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'ACTIVE_DIRECTORY_ALREADY_EXISTS|STUDIO_COMPONENT_CREATED|STUDIO_COMPONENT_UPDATED|STUDIO_COMPONENT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|STUDIO_COMPONENT_CREATE_IN_PROGRESS|STUDIO_COMPONENT_UPDATE_IN_PROGRESS|STUDIO_COMPONENT_DELETE_IN_PROGRESS|INTERNAL_ERROR',
        'statusMessage' => '<string>',
        'studioComponentId' => '<string>',
        'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
        'tags' => ['<string>', ...],
        'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteLaunchProfile

$result = $client->deleteLaunchProfile([/* ... */]);
$promise = $client->deleteLaunchProfileAsync([/* ... */]);

Permanently delete a launch profile.

Parameter Syntax

$result = $client->deleteLaunchProfile([
    'clientToken' => '<string>',
    'launchProfileId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfile' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SubnetIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersions' => ['<string>', ...],
        'name' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
        'statusMessage' => '<string>',
        'streamConfiguration' => [
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'clipboardMode' => 'ENABLED|DISABLED',
            'ec2InstanceTypes' => ['<string>', ...],
            'maxSessionLengthInMinutes' => <integer>,
            'maxStoppedSessionLengthInMinutes' => <integer>,
            'sessionBackup' => [
                'maxBackupsToRetain' => <integer>,
                'mode' => 'AUTOMATIC|DEACTIVATED',
            ],
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'sessionStorage' => [
                'mode' => ['<string>', ...],
                'root' => [
                    'linux' => '<string>',
                    'windows' => '<string>',
                ],
            ],
            'streamingImageIds' => ['<string>', ...],
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
        ],
        'studioComponentIds' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'validationResults' => [
            [
                'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage' => '<string>',
                'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteLaunchProfileMember

$result = $client->deleteLaunchProfileMember([/* ... */]);
$promise = $client->deleteLaunchProfileMemberAsync([/* ... */]);

Delete a user from launch profile membership.

Parameter Syntax

$result = $client->deleteLaunchProfileMember([
    'clientToken' => '<string>',
    'launchProfileId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteStreamingImage

$result = $client->deleteStreamingImage([/* ... */]);
$promise = $client->deleteStreamingImageAsync([/* ... */]);

Delete streaming image.

Parameter Syntax

$result = $client->deleteStreamingImage([
    'clientToken' => '<string>',
    'streamingImageId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'streamingImage' => [
        'arn' => '<string>',
        'description' => '<string>',
        'ec2ImageId' => '<string>',
        'encryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'CUSTOMER_MANAGED_KEY',
        ],
        'eulaIds' => ['<string>', ...],
        'name' => '<string>',
        'owner' => '<string>',
        'platform' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
        'statusMessage' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteStreamingSession

$result = $client->deleteStreamingSession([/* ... */]);
$promise = $client->deleteStreamingSessionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteStreamingSession([
    'clientToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'session' => [
        'arn' => '<string>',
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'backupMode' => 'AUTOMATIC|DEACTIVATED',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'ec2InstanceType' => '<string>',
        'launchProfileId' => '<string>',
        'maxBackupsToRetain' => <integer>,
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'startedFromBackupId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'stopAt' => <DateTime>,
        'stoppedAt' => <DateTime>,
        'stoppedBy' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateAt' => <DateTime>,
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
        'volumeRetentionMode' => 'RETAIN|DELETE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteStudio

$result = $client->deleteStudio([/* ... */]);
$promise = $client->deleteStudioAsync([/* ... */]);

Delete a studio resource.

Parameter Syntax

$result = $client->deleteStudio([
    'clientToken' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studio' => [
        'adminRoleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'homeRegion' => '<string>',
        'ssoClientId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
        'statusMessage' => '<string>',
        'studioEncryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        ],
        'studioId' => '<string>',
        'studioName' => '<string>',
        'studioUrl' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'userRoleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteStudioComponent

$result = $client->deleteStudioComponent([/* ... */]);
$promise = $client->deleteStudioComponentAsync([/* ... */]);

Deletes a studio component resource.

Parameter Syntax

$result = $client->deleteStudioComponent([
    'clientToken' => '<string>',
    'studioComponentId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studioComponent' => [
        'arn' => '<string>',
        'configuration' => [
            'activeDirectoryConfiguration' => [
                'computerAttributes' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'directoryId' => '<string>',
                'organizationalUnitDistinguishedName' => '<string>',
            ],
            'computeFarmConfiguration' => [
                'activeDirectoryUser' => '<string>',
                'endpoint' => '<string>',
            ],
            'licenseServiceConfiguration' => [
                'endpoint' => '<string>',
            ],
            'sharedFileSystemConfiguration' => [
                'endpoint' => '<string>',
                'fileSystemId' => '<string>',
                'linuxMountPoint' => '<string>',
                'shareName' => '<string>',
                'windowsMountDrive' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SecurityGroupIds' => ['<string>', ...],
        'initializationScripts' => [
            [
                'launchProfileProtocolVersion' => '<string>',
                'platform' => 'LINUX|WINDOWS',
                'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
                'script' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>',
        'runtimeRoleArn' => '<string>',
        'scriptParameters' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'secureInitializationRoleArn' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'ACTIVE_DIRECTORY_ALREADY_EXISTS|STUDIO_COMPONENT_CREATED|STUDIO_COMPONENT_UPDATED|STUDIO_COMPONENT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|STUDIO_COMPONENT_CREATE_IN_PROGRESS|STUDIO_COMPONENT_UPDATE_IN_PROGRESS|STUDIO_COMPONENT_DELETE_IN_PROGRESS|INTERNAL_ERROR',
        'statusMessage' => '<string>',
        'studioComponentId' => '<string>',
        'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
        'tags' => ['<string>', ...],
        'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

DeleteStudioMember

$result = $client->deleteStudioMember([/* ... */]);
$promise = $client->deleteStudioMemberAsync([/* ... */]);

Delete a user from studio membership.

Parameter Syntax

$result = $client->deleteStudioMember([
    'clientToken' => '<string>',
    'principalId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetEula

$result = $client->getEula([/* ... */]);
$promise = $client->getEulaAsync([/* ... */]);

Get EULA.

Parameter Syntax

$result = $client->getEula([
    'eulaId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eula' => [
        'content' => '<string>',
        'createdAt' => <DateTime>,
        'eulaId' => '<string>',
        'name' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetLaunchProfile

$result = $client->getLaunchProfile([/* ... */]);
$promise = $client->getLaunchProfileAsync([/* ... */]);

Get a launch profile.

Parameter Syntax

$result = $client->getLaunchProfile([
    'launchProfileId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfile' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SubnetIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersions' => ['<string>', ...],
        'name' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
        'statusMessage' => '<string>',
        'streamConfiguration' => [
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'clipboardMode' => 'ENABLED|DISABLED',
            'ec2InstanceTypes' => ['<string>', ...],
            'maxSessionLengthInMinutes' => <integer>,
            'maxStoppedSessionLengthInMinutes' => <integer>,
            'sessionBackup' => [
                'maxBackupsToRetain' => <integer>,
                'mode' => 'AUTOMATIC|DEACTIVATED',
            ],
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'sessionStorage' => [
                'mode' => ['<string>', ...],
                'root' => [
                    'linux' => '<string>',
                    'windows' => '<string>',
                ],
            ],
            'streamingImageIds' => ['<string>', ...],
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
        ],
        'studioComponentIds' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'validationResults' => [
            [
                'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage' => '<string>',
                'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetLaunchProfileDetails

$result = $client->getLaunchProfileDetails([/* ... */]);
$promise = $client->getLaunchProfileDetailsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getLaunchProfileDetails([
    'launchProfileId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfile' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SubnetIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersions' => ['<string>', ...],
        'name' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
        'statusMessage' => '<string>',
        'streamConfiguration' => [
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'clipboardMode' => 'ENABLED|DISABLED',
            'ec2InstanceTypes' => ['<string>', ...],
            'maxSessionLengthInMinutes' => <integer>,
            'maxStoppedSessionLengthInMinutes' => <integer>,
            'sessionBackup' => [
                'maxBackupsToRetain' => <integer>,
                'mode' => 'AUTOMATIC|DEACTIVATED',
            ],
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'sessionStorage' => [
                'mode' => ['<string>', ...],
                'root' => [
                    'linux' => '<string>',
                    'windows' => '<string>',
                ],
            ],
            'streamingImageIds' => ['<string>', ...],
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
        ],
        'studioComponentIds' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'validationResults' => [
            [
                'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage' => '<string>',
                'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
            ],
            // ...
        ],
    ],
    'streamingImages' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'ec2ImageId' => '<string>',
            'encryptionConfiguration' => [
                'keyArn' => '<string>',
                'keyType' => 'CUSTOMER_MANAGED_KEY',
            ],
            'eulaIds' => ['<string>', ...],
            'name' => '<string>',
            'owner' => '<string>',
            'platform' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
            'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
            'statusMessage' => '<string>',
            'streamingImageId' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'studioComponentSummaries' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'studioComponentId' => '<string>',
            'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
            'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetLaunchProfileInitialization

$result = $client->getLaunchProfileInitialization([/* ... */]);
$promise = $client->getLaunchProfileInitializationAsync([/* ... */]);

Get a launch profile initialization.

Parameter Syntax

$result = $client->getLaunchProfileInitialization([
    'launchProfileId' => '<string>', // REQUIRED
    'launchProfileProtocolVersions' => ['<string>', ...], // REQUIRED
    'launchPurpose' => '<string>', // REQUIRED
    'platform' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfileInitialization' => [
        'activeDirectory' => [
            'computerAttributes' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'directoryId' => '<string>',
            'directoryName' => '<string>',
            'dnsIpAddresses' => ['<string>', ...],
            'organizationalUnitDistinguishedName' => '<string>',
            'studioComponentId' => '<string>',
            'studioComponentName' => '<string>',
        ],
        'ec2SecurityGroupIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersion' => '<string>',
        'launchPurpose' => '<string>',
        'name' => '<string>',
        'platform' => 'LINUX|WINDOWS',
        'systemInitializationScripts' => [
            [
                'runtimeRoleArn' => '<string>',
                'script' => '<string>',
                'secureInitializationRoleArn' => '<string>',
                'studioComponentId' => '<string>',
                'studioComponentName' => '<string>',
            ],
            // ...
        ],
        'userInitializationScripts' => [
            [
                'runtimeRoleArn' => '<string>',
                'script' => '<string>',
                'secureInitializationRoleArn' => '<string>',
                'studioComponentId' => '<string>',
                'studioComponentName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetLaunchProfileMember

$result = $client->getLaunchProfileMember([/* ... */]);
$promise = $client->getLaunchProfileMemberAsync([/* ... */]);

Get a user persona in launch profile membership.

Parameter Syntax

$result = $client->getLaunchProfileMember([
    'launchProfileId' => '<string>', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'member' => [
        'identityStoreId' => '<string>',
        'persona' => 'USER',
        'principalId' => '<string>',
        'sid' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStreamingImage

$result = $client->getStreamingImage([/* ... */]);
$promise = $client->getStreamingImageAsync([/* ... */]);

Get streaming image.

Parameter Syntax

$result = $client->getStreamingImage([
    'streamingImageId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'streamingImage' => [
        'arn' => '<string>',
        'description' => '<string>',
        'ec2ImageId' => '<string>',
        'encryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'CUSTOMER_MANAGED_KEY',
        ],
        'eulaIds' => ['<string>', ...],
        'name' => '<string>',
        'owner' => '<string>',
        'platform' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
        'statusMessage' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStreamingSession

$result = $client->getStreamingSession([/* ... */]);
$promise = $client->getStreamingSessionAsync([/* ... */]);

Gets StreamingSession resource.

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

Parameter Syntax

$result = $client->getStreamingSession([
    'sessionId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'session' => [
        'arn' => '<string>',
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'backupMode' => 'AUTOMATIC|DEACTIVATED',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'ec2InstanceType' => '<string>',
        'launchProfileId' => '<string>',
        'maxBackupsToRetain' => <integer>,
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'startedFromBackupId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'stopAt' => <DateTime>,
        'stoppedAt' => <DateTime>,
        'stoppedBy' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateAt' => <DateTime>,
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
        'volumeRetentionMode' => 'RETAIN|DELETE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStreamingSessionBackup

$result = $client->getStreamingSessionBackup([/* ... */]);
$promise = $client->getStreamingSessionBackupAsync([/* ... */]);

Gets StreamingSessionBackup resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

Parameter Syntax

$result = $client->getStreamingSessionBackup([
    'backupId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'streamingSessionBackup' => [
        'arn' => '<string>',
        'backupId' => '<string>',
        'createdAt' => <DateTime>,
        'launchProfileId' => '<string>',
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

GetStreamingSessionStream

$result = $client->getStreamingSessionStream([/* ... */]);
$promise = $client->getStreamingSessionStreamAsync([/* ... */]);

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

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

Parameter Syntax

$result = $client->getStreamingSessionStream([
    'sessionId' => '<string>', // REQUIRED
    'streamId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'stream' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'expiresAt' => <DateTime>,
        'ownedBy' => '<string>',
        'state' => 'READY|CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAM_CREATE_IN_PROGRESS|STREAM_READY|STREAM_DELETE_IN_PROGRESS|STREAM_DELETED|INTERNAL_ERROR|NETWORK_CONNECTION_ERROR',
        'streamId' => '<string>',
        'url' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStudio

$result = $client->getStudio([/* ... */]);
$promise = $client->getStudioAsync([/* ... */]);

Get a studio resource.

Parameter Syntax

$result = $client->getStudio([
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studio' => [
        'adminRoleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'homeRegion' => '<string>',
        'ssoClientId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
        'statusMessage' => '<string>',
        'studioEncryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        ],
        'studioId' => '<string>',
        'studioName' => '<string>',
        'studioUrl' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'userRoleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStudioComponent

$result = $client->getStudioComponent([/* ... */]);
$promise = $client->getStudioComponentAsync([/* ... */]);

Gets a studio component resource.

Parameter Syntax

$result = $client->getStudioComponent([
    'studioComponentId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studioComponent' => [
        'arn' => '<string>',
        'configuration' => [
            'activeDirectoryConfiguration' => [
                'computerAttributes' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'directoryId' => '<string>',
                'organizationalUnitDistinguishedName' => '<string>',
            ],
            'computeFarmConfiguration' => [
                'activeDirectoryUser' => '<string>',
                'endpoint' => '<string>',
            ],
            'licenseServiceConfiguration' => [
                'endpoint' => '<string>',
            ],
            'sharedFileSystemConfiguration' => [
                'endpoint' => '<string>',
                'fileSystemId' => '<string>',
                'linuxMountPoint' => '<string>',
                'shareName' => '<string>',
                'windowsMountDrive' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SecurityGroupIds' => ['<string>', ...],
        'initializationScripts' => [
            [
                'launchProfileProtocolVersion' => '<string>',
                'platform' => 'LINUX|WINDOWS',
                'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
                'script' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>',
        'runtimeRoleArn' => '<string>',
        'scriptParameters' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'secureInitializationRoleArn' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'ACTIVE_DIRECTORY_ALREADY_EXISTS|STUDIO_COMPONENT_CREATED|STUDIO_COMPONENT_UPDATED|STUDIO_COMPONENT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|STUDIO_COMPONENT_CREATE_IN_PROGRESS|STUDIO_COMPONENT_UPDATE_IN_PROGRESS|STUDIO_COMPONENT_DELETE_IN_PROGRESS|INTERNAL_ERROR',
        'statusMessage' => '<string>',
        'studioComponentId' => '<string>',
        'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
        'tags' => ['<string>', ...],
        'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

GetStudioMember

$result = $client->getStudioMember([/* ... */]);
$promise = $client->getStudioMemberAsync([/* ... */]);

Get a user's membership in a studio.

Parameter Syntax

$result = $client->getStudioMember([
    'principalId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'member' => [
        'identityStoreId' => '<string>',
        'persona' => 'ADMINISTRATOR',
        'principalId' => '<string>',
        'sid' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListEulaAcceptances

$result = $client->listEulaAcceptances([/* ... */]);
$promise = $client->listEulaAcceptancesAsync([/* ... */]);

List EULA acceptances.

Parameter Syntax

$result = $client->listEulaAcceptances([
    'eulaIds' => ['<string>', ...],
    'nextToken' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eulaAcceptances' => [
        [
            'acceptedAt' => <DateTime>,
            'acceptedBy' => '<string>',
            'accepteeId' => '<string>',
            'eulaAcceptanceId' => '<string>',
            'eulaId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListEulas

$result = $client->listEulas([/* ... */]);
$promise = $client->listEulasAsync([/* ... */]);

List EULAs.

Parameter Syntax

$result = $client->listEulas([
    'eulaIds' => ['<string>', ...],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'eulas' => [
        [
            'content' => '<string>',
            'createdAt' => <DateTime>,
            'eulaId' => '<string>',
            'name' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListLaunchProfileMembers

$result = $client->listLaunchProfileMembers([/* ... */]);
$promise = $client->listLaunchProfileMembersAsync([/* ... */]);

Get all users in a given launch profile membership.

Parameter Syntax

$result = $client->listLaunchProfileMembers([
    'launchProfileId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'members' => [
        [
            'identityStoreId' => '<string>',
            'persona' => 'USER',
            'principalId' => '<string>',
            'sid' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListLaunchProfiles

$result = $client->listLaunchProfiles([/* ... */]);
$promise = $client->listLaunchProfilesAsync([/* ... */]);

List all the launch profiles a studio.

Parameter Syntax

$result = $client->listLaunchProfiles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalId' => '<string>',
    'states' => ['<string>', ...],
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfiles' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'ec2SubnetIds' => ['<string>', ...],
            'launchProfileId' => '<string>',
            'launchProfileProtocolVersions' => ['<string>', ...],
            'name' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
            'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
            'statusMessage' => '<string>',
            'streamConfiguration' => [
                'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
                'clipboardMode' => 'ENABLED|DISABLED',
                'ec2InstanceTypes' => ['<string>', ...],
                'maxSessionLengthInMinutes' => <integer>,
                'maxStoppedSessionLengthInMinutes' => <integer>,
                'sessionBackup' => [
                    'maxBackupsToRetain' => <integer>,
                    'mode' => 'AUTOMATIC|DEACTIVATED',
                ],
                'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
                'sessionStorage' => [
                    'mode' => ['<string>', ...],
                    'root' => [
                        'linux' => '<string>',
                        'windows' => '<string>',
                    ],
                ],
                'streamingImageIds' => ['<string>', ...],
                'volumeConfiguration' => [
                    'iops' => <integer>,
                    'size' => <integer>,
                    'throughput' => <integer>,
                ],
            ],
            'studioComponentIds' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'validationResults' => [
                [
                    'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusMessage' => '<string>',
                    'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListStreamingImages

$result = $client->listStreamingImages([/* ... */]);
$promise = $client->listStreamingImagesAsync([/* ... */]);

List the streaming image resources available to this studio.

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

Parameter Syntax

$result = $client->listStreamingImages([
    'nextToken' => '<string>',
    'owner' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'streamingImages' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'ec2ImageId' => '<string>',
            'encryptionConfiguration' => [
                'keyArn' => '<string>',
                'keyType' => 'CUSTOMER_MANAGED_KEY',
            ],
            'eulaIds' => ['<string>', ...],
            'name' => '<string>',
            'owner' => '<string>',
            'platform' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
            'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
            'statusMessage' => '<string>',
            'streamingImageId' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListStreamingSessionBackups

$result = $client->listStreamingSessionBackups([/* ... */]);
$promise = $client->listStreamingSessionBackupsAsync([/* ... */]);

Lists the backups of a streaming session in a studio.

Parameter Syntax

$result = $client->listStreamingSessionBackups([
    'nextToken' => '<string>',
    'ownedBy' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'streamingSessionBackups' => [
        [
            'arn' => '<string>',
            'backupId' => '<string>',
            'createdAt' => <DateTime>,
            'launchProfileId' => '<string>',
            'ownedBy' => '<string>',
            'sessionId' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
            'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
            'statusMessage' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ListStreamingSessions

$result = $client->listStreamingSessions([/* ... */]);
$promise = $client->listStreamingSessionsAsync([/* ... */]);

Lists the streaming sessions in a studio.

Parameter Syntax

$result = $client->listStreamingSessions([
    'createdBy' => '<string>',
    'nextToken' => '<string>',
    'ownedBy' => '<string>',
    'sessionIds' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sessions' => [
        [
            'arn' => '<string>',
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'backupMode' => 'AUTOMATIC|DEACTIVATED',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'ec2InstanceType' => '<string>',
            'launchProfileId' => '<string>',
            'maxBackupsToRetain' => <integer>,
            'ownedBy' => '<string>',
            'sessionId' => '<string>',
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'startedAt' => <DateTime>,
            'startedBy' => '<string>',
            'startedFromBackupId' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
            'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
            'statusMessage' => '<string>',
            'stopAt' => <DateTime>,
            'stoppedAt' => <DateTime>,
            'stoppedBy' => '<string>',
            'streamingImageId' => '<string>',
            'tags' => ['<string>', ...],
            'terminateAt' => <DateTime>,
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
            'volumeRetentionMode' => 'RETAIN|DELETE',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListStudioComponents

$result = $client->listStudioComponents([/* ... */]);
$promise = $client->listStudioComponentsAsync([/* ... */]);

Lists the StudioComponents in a studio.

Parameter Syntax

$result = $client->listStudioComponents([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'states' => ['<string>', ...],
    'studioId' => '<string>', // REQUIRED
    'types' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'studioComponents' => [
        [
            'arn' => '<string>',
            'configuration' => [
                'activeDirectoryConfiguration' => [
                    'computerAttributes' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'directoryId' => '<string>',
                    'organizationalUnitDistinguishedName' => '<string>',
                ],
                'computeFarmConfiguration' => [
                    'activeDirectoryUser' => '<string>',
                    'endpoint' => '<string>',
                ],
                'licenseServiceConfiguration' => [
                    'endpoint' => '<string>',
                ],
                'sharedFileSystemConfiguration' => [
                    'endpoint' => '<string>',
                    'fileSystemId' => '<string>',
                    'linuxMountPoint' => '<string>',
                    'shareName' => '<string>',
                    'windowsMountDrive' => '<string>',
                ],
            ],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'ec2SecurityGroupIds' => ['<string>', ...],
            'initializationScripts' => [
                [
                    'launchProfileProtocolVersion' => '<string>',
                    'platform' => 'LINUX|WINDOWS',
                    'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
                    'script' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'runtimeRoleArn' => '<string>',
            'scriptParameters' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'secureInitializationRoleArn' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
            'statusCode' => 'ACTIVE_DIRECTORY_ALREADY_EXISTS|STUDIO_COMPONENT_CREATED|STUDIO_COMPONENT_UPDATED|STUDIO_COMPONENT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|STUDIO_COMPONENT_CREATE_IN_PROGRESS|STUDIO_COMPONENT_UPDATE_IN_PROGRESS|STUDIO_COMPONENT_DELETE_IN_PROGRESS|INTERNAL_ERROR',
            'statusMessage' => '<string>',
            'studioComponentId' => '<string>',
            'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
            'tags' => ['<string>', ...],
            'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListStudioMembers

$result = $client->listStudioMembers([/* ... */]);
$promise = $client->listStudioMembersAsync([/* ... */]);

Get all users in a given studio membership.

Parameter Syntax

$result = $client->listStudioMembers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'members' => [
        [
            'identityStoreId' => '<string>',
            'persona' => 'ADMINISTRATOR',
            'principalId' => '<string>',
            'sid' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListStudios

$result = $client->listStudios([/* ... */]);
$promise = $client->listStudiosAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listStudios([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'studios' => [
        [
            'adminRoleArn' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'displayName' => '<string>',
            'homeRegion' => '<string>',
            'ssoClientId' => '<string>',
            'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
            'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
            'statusMessage' => '<string>',
            'studioEncryptionConfiguration' => [
                'keyArn' => '<string>',
                'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
            ],
            'studioId' => '<string>',
            'studioName' => '<string>',
            'studioUrl' => '<string>',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
            'userRoleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

PutLaunchProfileMembers

$result = $client->putLaunchProfileMembers([/* ... */]);
$promise = $client->putLaunchProfileMembersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putLaunchProfileMembers([
    'clientToken' => '<string>',
    'identityStoreId' => '<string>', // REQUIRED
    'launchProfileId' => '<string>', // REQUIRED
    'members' => [ // REQUIRED
        [
            'persona' => 'USER', // REQUIRED
            'principalId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

PutStudioMembers

$result = $client->putStudioMembers([/* ... */]);
$promise = $client->putStudioMembersAsync([/* ... */]);

Add/update users with given persona to studio membership.

Parameter Syntax

$result = $client->putStudioMembers([
    'clientToken' => '<string>',
    'identityStoreId' => '<string>', // REQUIRED
    'members' => [ // REQUIRED
        [
            'persona' => 'ADMINISTRATOR', // REQUIRED
            'principalId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

StartStreamingSession

$result = $client->startStreamingSession([/* ... */]);
$promise = $client->startStreamingSessionAsync([/* ... */]);

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

Parameter Syntax

$result = $client->startStreamingSession([
    'backupId' => '<string>',
    'clientToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'session' => [
        'arn' => '<string>',
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'backupMode' => 'AUTOMATIC|DEACTIVATED',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'ec2InstanceType' => '<string>',
        'launchProfileId' => '<string>',
        'maxBackupsToRetain' => <integer>,
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'startedFromBackupId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'stopAt' => <DateTime>,
        'stoppedAt' => <DateTime>,
        'stoppedBy' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateAt' => <DateTime>,
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
        'volumeRetentionMode' => 'RETAIN|DELETE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

StartStudioSSOConfigurationRepair

$result = $client->startStudioSSOConfigurationRepair([/* ... */]);
$promise = $client->startStudioSSOConfigurationRepairAsync([/* ... */]);

Repairs the IAM Identity Center configuration for a given studio.

If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.

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

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

Parameter Syntax

$result = $client->startStudioSSOConfigurationRepair([
    'clientToken' => '<string>',
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'studio' => [
        'adminRoleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'homeRegion' => '<string>',
        'ssoClientId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
        'statusMessage' => '<string>',
        'studioEncryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        ],
        'studioId' => '<string>',
        'studioName' => '<string>',
        'studioUrl' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'userRoleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

StopStreamingSession

$result = $client->stopStreamingSession([/* ... */]);
$promise = $client->stopStreamingSessionAsync([/* ... */]);

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

Parameter Syntax

$result = $client->stopStreamingSession([
    'clientToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
    'volumeRetentionMode' => 'RETAIN|DELETE',
]);

Parameter Details

Result Syntax

[
    'session' => [
        'arn' => '<string>',
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'backupMode' => 'AUTOMATIC|DEACTIVATED',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'ec2InstanceType' => '<string>',
        'launchProfileId' => '<string>',
        'maxBackupsToRetain' => <integer>,
        'ownedBy' => '<string>',
        'sessionId' => '<string>',
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'startedFromBackupId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|READY|DELETED|CREATE_FAILED|DELETE_FAILED|STOP_IN_PROGRESS|START_IN_PROGRESS|STOPPED|STOP_FAILED|START_FAILED',
        'statusCode' => 'STREAMING_SESSION_READY|STREAMING_SESSION_DELETED|STREAMING_SESSION_CREATE_IN_PROGRESS|STREAMING_SESSION_DELETE_IN_PROGRESS|INTERNAL_ERROR|INSUFFICIENT_CAPACITY|ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR|NETWORK_CONNECTION_ERROR|INITIALIZATION_SCRIPT_ERROR|DECRYPT_STREAMING_IMAGE_ERROR|NETWORK_INTERFACE_ERROR|STREAMING_SESSION_STOPPED|STREAMING_SESSION_STARTED|STREAMING_SESSION_STOP_IN_PROGRESS|STREAMING_SESSION_START_IN_PROGRESS|AMI_VALIDATION_ERROR',
        'statusMessage' => '<string>',
        'stopAt' => <DateTime>,
        'stoppedAt' => <DateTime>,
        'stoppedBy' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateAt' => <DateTime>,
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
        'volumeRetentionMode' => 'RETAIN|DELETE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Creates tags for a resource, given its ARN.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes the tags for a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UpdateLaunchProfile

$result = $client->updateLaunchProfile([/* ... */]);
$promise = $client->updateLaunchProfileAsync([/* ... */]);

Update a launch profile.

Parameter Syntax

$result = $client->updateLaunchProfile([
    'clientToken' => '<string>',
    'description' => '<string>',
    'launchProfileId' => '<string>', // REQUIRED
    'launchProfileProtocolVersions' => ['<string>', ...],
    'name' => '<string>',
    'streamConfiguration' => [
        'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
        'clipboardMode' => 'ENABLED|DISABLED', // REQUIRED
        'ec2InstanceTypes' => ['<string>', ...], // REQUIRED
        'maxSessionLengthInMinutes' => <integer>,
        'maxStoppedSessionLengthInMinutes' => <integer>,
        'sessionBackup' => [
            'maxBackupsToRetain' => <integer>,
            'mode' => 'AUTOMATIC|DEACTIVATED',
        ],
        'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
        'sessionStorage' => [
            'mode' => ['<string>', ...], // REQUIRED
            'root' => [
                'linux' => '<string>',
                'windows' => '<string>',
            ],
        ],
        'streamingImageIds' => ['<string>', ...], // REQUIRED
        'volumeConfiguration' => [
            'iops' => <integer>,
            'size' => <integer>,
            'throughput' => <integer>,
        ],
    ],
    'studioComponentIds' => ['<string>', ...],
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'launchProfile' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SubnetIds' => ['<string>', ...],
        'launchProfileId' => '<string>',
        'launchProfileProtocolVersions' => ['<string>', ...],
        'name' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'LAUNCH_PROFILE_CREATED|LAUNCH_PROFILE_UPDATED|LAUNCH_PROFILE_DELETED|LAUNCH_PROFILE_CREATE_IN_PROGRESS|LAUNCH_PROFILE_UPDATE_IN_PROGRESS|LAUNCH_PROFILE_DELETE_IN_PROGRESS|INTERNAL_ERROR|STREAMING_IMAGE_NOT_FOUND|STREAMING_IMAGE_NOT_READY|LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|INVALID_SUBNETS_PROVIDED|INVALID_INSTANCE_TYPES_PROVIDED|INVALID_SUBNETS_COMBINATION',
        'statusMessage' => '<string>',
        'streamConfiguration' => [
            'automaticTerminationMode' => 'DEACTIVATED|ACTIVATED',
            'clipboardMode' => 'ENABLED|DISABLED',
            'ec2InstanceTypes' => ['<string>', ...],
            'maxSessionLengthInMinutes' => <integer>,
            'maxStoppedSessionLengthInMinutes' => <integer>,
            'sessionBackup' => [
                'maxBackupsToRetain' => <integer>,
                'mode' => 'AUTOMATIC|DEACTIVATED',
            ],
            'sessionPersistenceMode' => 'DEACTIVATED|ACTIVATED',
            'sessionStorage' => [
                'mode' => ['<string>', ...],
                'root' => [
                    'linux' => '<string>',
                    'windows' => '<string>',
                ],
            ],
            'streamingImageIds' => ['<string>', ...],
            'volumeConfiguration' => [
                'iops' => <integer>,
                'size' => <integer>,
                'throughput' => <integer>,
            ],
        ],
        'studioComponentIds' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
        'validationResults' => [
            [
                'state' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode' => 'VALIDATION_NOT_STARTED|VALIDATION_IN_PROGRESS|VALIDATION_SUCCESS|VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION|VALIDATION_FAILED_SUBNET_NOT_FOUND|VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION|VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY|VALIDATION_FAILED_UNAUTHORIZED|VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage' => '<string>',
                'type' => 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT|VALIDATE_SUBNET_ASSOCIATION|VALIDATE_NETWORK_ACL_ASSOCIATION|VALIDATE_SECURITY_GROUP_ASSOCIATION',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UpdateLaunchProfileMember

$result = $client->updateLaunchProfileMember([/* ... */]);
$promise = $client->updateLaunchProfileMemberAsync([/* ... */]);

Update a user persona in launch profile membership.

Parameter Syntax

$result = $client->updateLaunchProfileMember([
    'clientToken' => '<string>',
    'launchProfileId' => '<string>', // REQUIRED
    'persona' => 'USER', // REQUIRED
    'principalId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'member' => [
        'identityStoreId' => '<string>',
        'persona' => 'USER',
        'principalId' => '<string>',
        'sid' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UpdateStreamingImage

$result = $client->updateStreamingImage([/* ... */]);
$promise = $client->updateStreamingImageAsync([/* ... */]);

Update streaming image.

Parameter Syntax

$result = $client->updateStreamingImage([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'streamingImageId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'streamingImage' => [
        'arn' => '<string>',
        'description' => '<string>',
        'ec2ImageId' => '<string>',
        'encryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'CUSTOMER_MANAGED_KEY',
        ],
        'eulaIds' => ['<string>', ...],
        'name' => '<string>',
        'owner' => '<string>',
        'platform' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|DELETE_IN_PROGRESS|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED|CREATE_FAILED|DELETE_FAILED',
        'statusCode' => 'STREAMING_IMAGE_CREATE_IN_PROGRESS|STREAMING_IMAGE_READY|STREAMING_IMAGE_DELETE_IN_PROGRESS|STREAMING_IMAGE_DELETED|STREAMING_IMAGE_UPDATE_IN_PROGRESS|INTERNAL_ERROR|ACCESS_DENIED',
        'statusMessage' => '<string>',
        'streamingImageId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UpdateStudio

$result = $client->updateStudio([/* ... */]);
$promise = $client->updateStudioAsync([/* ... */]);

Update a Studio resource.

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

Parameter Syntax

$result = $client->updateStudio([
    'adminRoleArn' => '<string>',
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'studioId' => '<string>', // REQUIRED
    'userRoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'studio' => [
        'adminRoleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'homeRegion' => '<string>',
        'ssoClientId' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'STUDIO_CREATED|STUDIO_DELETED|STUDIO_UPDATED|STUDIO_CREATE_IN_PROGRESS|STUDIO_UPDATE_IN_PROGRESS|STUDIO_DELETE_IN_PROGRESS|STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED|STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED|STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED|AWS_SSO_NOT_ENABLED|AWS_SSO_ACCESS_DENIED|ROLE_NOT_OWNED_BY_STUDIO_OWNER|ROLE_COULD_NOT_BE_ASSUMED|INTERNAL_ERROR|ENCRYPTION_KEY_NOT_FOUND|ENCRYPTION_KEY_ACCESS_DENIED|AWS_SSO_CONFIGURATION_REPAIRED|AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS|AWS_STS_REGION_DISABLED',
        'statusMessage' => '<string>',
        'studioEncryptionConfiguration' => [
            'keyArn' => '<string>',
            'keyType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        ],
        'studioId' => '<string>',
        'studioName' => '<string>',
        'studioUrl' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'userRoleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

UpdateStudioComponent

$result = $client->updateStudioComponent([/* ... */]);
$promise = $client->updateStudioComponentAsync([/* ... */]);

Updates a studio component resource.

Parameter Syntax

$result = $client->updateStudioComponent([
    'clientToken' => '<string>',
    'configuration' => [
        'activeDirectoryConfiguration' => [
            'computerAttributes' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'directoryId' => '<string>',
            'organizationalUnitDistinguishedName' => '<string>',
        ],
        'computeFarmConfiguration' => [
            'activeDirectoryUser' => '<string>',
            'endpoint' => '<string>',
        ],
        'licenseServiceConfiguration' => [
            'endpoint' => '<string>',
        ],
        'sharedFileSystemConfiguration' => [
            'endpoint' => '<string>',
            'fileSystemId' => '<string>',
            'linuxMountPoint' => '<string>',
            'shareName' => '<string>',
            'windowsMountDrive' => '<string>',
        ],
    ],
    'description' => '<string>',
    'ec2SecurityGroupIds' => ['<string>', ...],
    'initializationScripts' => [
        [
            'launchProfileProtocolVersion' => '<string>',
            'platform' => 'LINUX|WINDOWS',
            'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
            'script' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'runtimeRoleArn' => '<string>',
    'scriptParameters' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'secureInitializationRoleArn' => '<string>',
    'studioComponentId' => '<string>', // REQUIRED
    'studioId' => '<string>', // REQUIRED
    'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
    'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
]);

Parameter Details

Result Syntax

[
    'studioComponent' => [
        'arn' => '<string>',
        'configuration' => [
            'activeDirectoryConfiguration' => [
                'computerAttributes' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'directoryId' => '<string>',
                'organizationalUnitDistinguishedName' => '<string>',
            ],
            'computeFarmConfiguration' => [
                'activeDirectoryUser' => '<string>',
                'endpoint' => '<string>',
            ],
            'licenseServiceConfiguration' => [
                'endpoint' => '<string>',
            ],
            'sharedFileSystemConfiguration' => [
                'endpoint' => '<string>',
                'fileSystemId' => '<string>',
                'linuxMountPoint' => '<string>',
                'shareName' => '<string>',
                'windowsMountDrive' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'ec2SecurityGroupIds' => ['<string>', ...],
        'initializationScripts' => [
            [
                'launchProfileProtocolVersion' => '<string>',
                'platform' => 'LINUX|WINDOWS',
                'runContext' => 'SYSTEM_INITIALIZATION|USER_INITIALIZATION',
                'script' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>',
        'runtimeRoleArn' => '<string>',
        'scriptParameters' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'secureInitializationRoleArn' => '<string>',
        'state' => 'CREATE_IN_PROGRESS|READY|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|DELETED|DELETE_FAILED|CREATE_FAILED|UPDATE_FAILED',
        'statusCode' => 'ACTIVE_DIRECTORY_ALREADY_EXISTS|STUDIO_COMPONENT_CREATED|STUDIO_COMPONENT_UPDATED|STUDIO_COMPONENT_DELETED|ENCRYPTION_KEY_ACCESS_DENIED|ENCRYPTION_KEY_NOT_FOUND|STUDIO_COMPONENT_CREATE_IN_PROGRESS|STUDIO_COMPONENT_UPDATE_IN_PROGRESS|STUDIO_COMPONENT_DELETE_IN_PROGRESS|INTERNAL_ERROR',
        'statusMessage' => '<string>',
        'studioComponentId' => '<string>',
        'subtype' => 'AWS_MANAGED_MICROSOFT_AD|AMAZON_FSX_FOR_WINDOWS|AMAZON_FSX_FOR_LUSTRE|CUSTOM',
        'tags' => ['<string>', ...],
        'type' => 'ACTIVE_DIRECTORY|SHARED_FILE_SYSTEM|COMPUTE_FARM|LICENSE_SERVICE|CUSTOM',
        'updatedAt' => <DateTime>,
        'updatedBy' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

Another operation is in progress.

ThrottlingException:

The request throughput limit was exceeded.

ValidationException:

One of the parameters in the request is invalid.

AccessDeniedException:

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InternalServerErrorException:

An internal error has occurred. Please retry your request.

ServiceQuotaExceededException:

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.