AmazonNimbleStudio 2020-08-01

AcceptEulas

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details