AssociateAppBlockBuilderAppBlock

$result = $client->associateAppBlockBuilderAppBlock([/* ... */]);
$promise = $client->associateAppBlockBuilderAppBlockAsync([/* ... */]);

Associates the specified app block builder with the specified app block.

Parameter Syntax

$result = $client->associateAppBlockBuilderAppBlock([
    'AppBlockArn' => '<string>', // REQUIRED
    'AppBlockBuilderName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AppBlockBuilderAppBlockAssociation' => [
        'AppBlockArn' => '<string>',
        'AppBlockBuilderName' => '<string>',
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

ResourceNotFoundException:

The specified resource was not found.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

AssociateApplicationFleet

$result = $client->associateApplicationFleet([/* ... */]);
$promise = $client->associateApplicationFleetAsync([/* ... */]);

Associates the specified application with the specified fleet. This is only supported for Elastic fleets.

Parameter Syntax

$result = $client->associateApplicationFleet([
    'ApplicationArn' => '<string>', // REQUIRED
    'FleetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationFleetAssociation' => [
        'ApplicationArn' => '<string>',
        'FleetName' => '<string>',
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

ResourceNotFoundException:

The specified resource was not found.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

AssociateApplicationToEntitlement

$result = $client->associateApplicationToEntitlement([/* ... */]);
$promise = $client->associateApplicationToEntitlementAsync([/* ... */]);

Associates an application to entitle.

Parameter Syntax

$result = $client->associateApplicationToEntitlement([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EntitlementName' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

EntitlementNotFoundException:

The entitlement can't be found.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

OperationNotPermittedException:

The attempted operation is not permitted.

AssociateFleet

$result = $client->associateFleet([/* ... */]);
$promise = $client->associateFleetAsync([/* ... */]);

Associates the specified fleet with the specified stack.

Parameter Syntax

$result = $client->associateFleet([
    'FleetName' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

OperationNotPermittedException:

The attempted operation is not permitted.

BatchAssociateUserStack

$result = $client->batchAssociateUserStack([/* ... */]);
$promise = $client->batchAssociateUserStackAsync([/* ... */]);

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

Parameter Syntax

$result = $client->batchAssociateUserStack([
    'UserStackAssociations' => [ // REQUIRED
        [
            'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
            'SendEmailNotification' => true || false,
            'StackName' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'ErrorCode' => 'STACK_NOT_FOUND|USER_NAME_NOT_FOUND|DIRECTORY_NOT_FOUND|INTERNAL_ERROR',
            'ErrorMessage' => '<string>',
            'UserStackAssociation' => [
                'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
                'SendEmailNotification' => true || false,
                'StackName' => '<string>',
                'UserName' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

BatchDisassociateUserStack

$result = $client->batchDisassociateUserStack([/* ... */]);
$promise = $client->batchDisassociateUserStackAsync([/* ... */]);

Disassociates the specified users from the specified stacks.

Parameter Syntax

$result = $client->batchDisassociateUserStack([
    'UserStackAssociations' => [ // REQUIRED
        [
            'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
            'SendEmailNotification' => true || false,
            'StackName' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'ErrorCode' => 'STACK_NOT_FOUND|USER_NAME_NOT_FOUND|DIRECTORY_NOT_FOUND|INTERNAL_ERROR',
            'ErrorMessage' => '<string>',
            'UserStackAssociation' => [
                'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
                'SendEmailNotification' => true || false,
                'StackName' => '<string>',
                'UserName' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

CopyImage

$result = $client->copyImage([/* ... */]);
$promise = $client->copyImageAsync([/* ... */]);

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

Parameter Syntax

$result = $client->copyImage([
    'DestinationImageDescription' => '<string>',
    'DestinationImageName' => '<string>', // REQUIRED
    'DestinationRegion' => '<string>', // REQUIRED
    'SourceImageName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DestinationImageName' => '<string>',
]

Result Details

Errors

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The specified resource was not found.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

CreateAppBlock

$result = $client->createAppBlock([/* ... */]);
$promise = $client->createAppBlockAsync([/* ... */]);

Creates an app block.

App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.

This is only supported for Elastic fleets.

Parameter Syntax

$result = $client->createAppBlock([
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'Name' => '<string>', // REQUIRED
    'PackagingType' => 'CUSTOM|APPSTREAM2',
    'PostSetupScriptDetails' => [
        'ExecutableParameters' => '<string>',
        'ExecutablePath' => '<string>', // REQUIRED
        'ScriptS3Location' => [ // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
            'S3Key' => '<string>',
        ],
        'TimeoutInSeconds' => <integer>, // REQUIRED
    ],
    'SetupScriptDetails' => [
        'ExecutableParameters' => '<string>',
        'ExecutablePath' => '<string>', // REQUIRED
        'ScriptS3Location' => [ // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
            'S3Key' => '<string>',
        ],
        'TimeoutInSeconds' => <integer>, // REQUIRED
    ],
    'SourceS3Location' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AppBlock' => [
        'AppBlockErrors' => [
            [
                'ErrorCode' => '<string>',
                'ErrorMessage' => '<string>',
            ],
            // ...
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Name' => '<string>',
        'PackagingType' => 'CUSTOM|APPSTREAM2',
        'PostSetupScriptDetails' => [
            'ExecutableParameters' => '<string>',
            'ExecutablePath' => '<string>',
            'ScriptS3Location' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'TimeoutInSeconds' => <integer>,
        ],
        'SetupScriptDetails' => [
            'ExecutableParameters' => '<string>',
            'ExecutablePath' => '<string>',
            'ScriptS3Location' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'TimeoutInSeconds' => <integer>,
        ],
        'SourceS3Location' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'State' => 'INACTIVE|ACTIVE',
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceAlreadyExistsException:

The specified resource already exists.

CreateAppBlockBuilder

$result = $client->createAppBlockBuilder([/* ... */]);
$promise = $client->createAppBlockBuilderAsync([/* ... */]);

Creates an app block builder.

Parameter Syntax

$result = $client->createAppBlockBuilder([
    'AccessEndpoints' => [
        [
            'EndpointType' => 'STREAMING', // REQUIRED
            'VpceId' => '<string>',
        ],
        // ...
    ],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'EnableDefaultInternetAccess' => true || false,
    'IamRoleArn' => '<string>',
    'InstanceType' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Platform' => 'WINDOWS_SERVER_2019', // REQUIRED
    'Tags' => ['<string>', ...],
    'VpcConfig' => [ // REQUIRED
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'AppBlockBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppBlockBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'InstanceType' => '<string>',
        'Name' => '<string>',
        'Platform' => 'WINDOWS_SERVER_2019',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

InvalidRoleException:

The specified role is invalid.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

CreateAppBlockBuilderStreamingURL

$result = $client->createAppBlockBuilderStreamingURL([/* ... */]);
$promise = $client->createAppBlockBuilderStreamingURLAsync([/* ... */]);

Creates a URL to start a create app block builder streaming session.

Parameter Syntax

$result = $client->createAppBlockBuilderStreamingURL([
    'AppBlockBuilderName' => '<string>', // REQUIRED
    'Validity' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Expires' => <DateTime>,
    'StreamingURL' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an application.

Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.

This is only supported for Elastic fleets.

Parameter Syntax

$result = $client->createApplication([
    'AppBlockArn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'IconS3Location' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'InstanceFamilies' => ['<string>', ...], // REQUIRED
    'LaunchParameters' => '<string>',
    'LaunchPath' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Platforms' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
    'WorkingDirectory' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Application' => [
        'AppBlockArn' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Enabled' => true || false,
        'IconS3Location' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'IconURL' => '<string>',
        'InstanceFamilies' => ['<string>', ...],
        'LaunchParameters' => '<string>',
        'LaunchPath' => '<string>',
        'Metadata' => ['<string>', ...],
        'Name' => '<string>',
        'Platforms' => ['<string>', ...],
        'WorkingDirectory' => '<string>',
    ],
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceNotFoundException:

The specified resource was not found.

CreateDirectoryConfig

$result = $client->createDirectoryConfig([/* ... */]);
$promise = $client->createDirectoryConfigAsync([/* ... */]);

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Parameter Syntax

$result = $client->createDirectoryConfig([
    'CertificateBasedAuthProperties' => [
        'CertificateAuthorityArn' => '<string>',
        'Status' => 'DISABLED|ENABLED|ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
    ],
    'DirectoryName' => '<string>', // REQUIRED
    'OrganizationalUnitDistinguishedNames' => ['<string>', ...], // REQUIRED
    'ServiceAccountCredentials' => [
        'AccountName' => '<string>', // REQUIRED
        'AccountPassword' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryConfig' => [
        'CertificateBasedAuthProperties' => [
            'CertificateAuthorityArn' => '<string>',
            'Status' => 'DISABLED|ENABLED|ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
        ],
        'CreatedTime' => <DateTime>,
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
        'ServiceAccountCredentials' => [
            'AccountName' => '<string>',
            'AccountPassword' => '<string>',
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

OperationNotPermittedException:

The attempted operation is not permitted.

InvalidRoleException:

The specified role is invalid.

CreateEntitlement

$result = $client->createEntitlement([/* ... */]);
$promise = $client->createEntitlementAsync([/* ... */]);

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Parameter Syntax

$result = $client->createEntitlement([
    'AppVisibility' => 'ALL|ASSOCIATED', // REQUIRED
    'Attributes' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Entitlement' => [
        'AppVisibility' => 'ALL|ASSOCIATED',
        'Attributes' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'StackName' => '<string>',
    ],
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

EntitlementAlreadyExistsException:

The entitlement already exists.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

Parameter Syntax

$result = $client->createFleet([
    'ComputeCapacity' => [
        'DesiredInstances' => <integer>,
        'DesiredSessions' => <integer>,
    ],
    'Description' => '<string>',
    'DisconnectTimeoutInSeconds' => <integer>,
    'DisplayName' => '<string>',
    'DomainJoinInfo' => [
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedName' => '<string>',
    ],
    'EnableDefaultInternetAccess' => true || false,
    'FleetType' => 'ALWAYS_ON|ON_DEMAND|ELASTIC',
    'IamRoleArn' => '<string>',
    'IdleDisconnectTimeoutInSeconds' => <integer>,
    'ImageArn' => '<string>',
    'ImageName' => '<string>',
    'InstanceType' => '<string>', // REQUIRED
    'MaxConcurrentSessions' => <integer>,
    'MaxSessionsPerInstance' => <integer>,
    'MaxUserDurationInSeconds' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
    'SessionScriptS3Location' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'StreamView' => 'APP|DESKTOP',
    'Tags' => ['<string>', ...],
    'UsbDeviceFilterStrings' => ['<string>', ...],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'Fleet' => [
        'Arn' => '<string>',
        'ComputeCapacityStatus' => [
            'ActiveUserSessions' => <integer>,
            'ActualUserSessions' => <integer>,
            'Available' => <integer>,
            'AvailableUserSessions' => <integer>,
            'Desired' => <integer>,
            'DesiredUserSessions' => <integer>,
            'InUse' => <integer>,
            'Running' => <integer>,
        ],
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisconnectTimeoutInSeconds' => <integer>,
        'DisplayName' => '<string>',
        'DomainJoinInfo' => [
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
        ],
        'EnableDefaultInternetAccess' => true || false,
        'FleetErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
            ],
            // ...
        ],
        'FleetType' => 'ALWAYS_ON|ON_DEMAND|ELASTIC',
        'IamRoleArn' => '<string>',
        'IdleDisconnectTimeoutInSeconds' => <integer>,
        'ImageArn' => '<string>',
        'ImageName' => '<string>',
        'InstanceType' => '<string>',
        'MaxConcurrentSessions' => <integer>,
        'MaxSessionsPerInstance' => <integer>,
        'MaxUserDurationInSeconds' => <integer>,
        'Name' => '<string>',
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'SessionScriptS3Location' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'StreamView' => 'APP|DESKTOP',
        'UsbDeviceFilterStrings' => ['<string>', ...],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

InvalidRoleException:

The specified role is invalid.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

OperationNotPermittedException:

The attempted operation is not permitted.

CreateImageBuilder

$result = $client->createImageBuilder([/* ... */]);
$promise = $client->createImageBuilderAsync([/* ... */]);

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Parameter Syntax

$result = $client->createImageBuilder([
    'AccessEndpoints' => [
        [
            'EndpointType' => 'STREAMING', // REQUIRED
            'VpceId' => '<string>',
        ],
        // ...
    ],
    'AppstreamAgentVersion' => '<string>',
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'DomainJoinInfo' => [
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedName' => '<string>',
    ],
    'EnableDefaultInternetAccess' => true || false,
    'IamRoleArn' => '<string>',
    'ImageArn' => '<string>',
    'ImageName' => '<string>',
    'InstanceType' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'ImageBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DomainJoinInfo' => [
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
        ],
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'ImageArn' => '<string>',
        'ImageBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'InstanceType' => '<string>',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED|UPDATING|PENDING_QUALIFICATION',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_UNAVAILABLE',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

InvalidRoleException:

The specified role is invalid.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

OperationNotPermittedException:

The attempted operation is not permitted.

CreateImageBuilderStreamingURL

$result = $client->createImageBuilderStreamingURL([/* ... */]);
$promise = $client->createImageBuilderStreamingURLAsync([/* ... */]);

Creates a URL to start an image builder streaming session.

Parameter Syntax

$result = $client->createImageBuilderStreamingURL([
    'Name' => '<string>', // REQUIRED
    'Validity' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Expires' => <DateTime>,
    'StreamingURL' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

CreateStack

$result = $client->createStack([/* ... */]);
$promise = $client->createStackAsync([/* ... */]);

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Parameter Syntax

$result = $client->createStack([
    'AccessEndpoints' => [
        [
            'EndpointType' => 'STREAMING', // REQUIRED
            'VpceId' => '<string>',
        ],
        // ...
    ],
    'ApplicationSettings' => [
        'Enabled' => true || false, // REQUIRED
        'SettingsGroup' => '<string>',
    ],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'EmbedHostDomains' => ['<string>', ...],
    'FeedbackURL' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RedirectURL' => '<string>',
    'StorageConnectors' => [
        [
            'ConnectorType' => 'HOMEFOLDERS|GOOGLE_DRIVE|ONE_DRIVE', // REQUIRED
            'Domains' => ['<string>', ...],
            'ResourceIdentifier' => '<string>',
        ],
        // ...
    ],
    'StreamingExperienceSettings' => [
        'PreferredProtocol' => 'TCP|UDP',
    ],
    'Tags' => ['<string>', ...],
    'UserSettings' => [
        [
            'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE|DOMAIN_PASSWORD_SIGNIN|DOMAIN_SMART_CARD_SIGNIN|AUTO_TIME_ZONE_REDIRECTION', // REQUIRED
            'MaximumLength' => <integer>,
            'Permission' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Stack' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'ApplicationSettings' => [
            'Enabled' => true || false,
            'S3BucketName' => '<string>',
            'SettingsGroup' => '<string>',
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'EmbedHostDomains' => ['<string>', ...],
        'FeedbackURL' => '<string>',
        'Name' => '<string>',
        'RedirectURL' => '<string>',
        'StackErrors' => [
            [
                'ErrorCode' => 'STORAGE_CONNECTOR_ERROR|INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
            ],
            // ...
        ],
        'StorageConnectors' => [
            [
                'ConnectorType' => 'HOMEFOLDERS|GOOGLE_DRIVE|ONE_DRIVE',
                'Domains' => ['<string>', ...],
                'ResourceIdentifier' => '<string>',
            ],
            // ...
        ],
        'StreamingExperienceSettings' => [
            'PreferredProtocol' => 'TCP|UDP',
        ],
        'UserSettings' => [
            [
                'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE|DOMAIN_PASSWORD_SIGNIN|DOMAIN_SMART_CARD_SIGNIN|AUTO_TIME_ZONE_REDIRECTION',
                'MaximumLength' => <integer>,
                'Permission' => 'ENABLED|DISABLED',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ResourceAlreadyExistsException:

The specified resource already exists.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidRoleException:

The specified role is invalid.

ResourceNotFoundException:

The specified resource was not found.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

CreateStreamingURL

$result = $client->createStreamingURL([/* ... */]);
$promise = $client->createStreamingURLAsync([/* ... */]);

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

Parameter Syntax

$result = $client->createStreamingURL([
    'ApplicationId' => '<string>',
    'FleetName' => '<string>', // REQUIRED
    'SessionContext' => '<string>',
    'StackName' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
    'Validity' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Expires' => <DateTime>,
    'StreamingURL' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

OperationNotPermittedException:

The attempted operation is not permitted.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

CreateThemeForStack

$result = $client->createThemeForStack([/* ... */]);
$promise = $client->createThemeForStackAsync([/* ... */]);

Creates custom branding that customizes the appearance of the streaming application catalog page.

Parameter Syntax

$result = $client->createThemeForStack([
    'FaviconS3Location' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'FooterLinks' => [
        [
            'DisplayName' => '<string>',
            'FooterLinkURL' => '<string>',
        ],
        // ...
    ],
    'OrganizationLogoS3Location' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'StackName' => '<string>', // REQUIRED
    'ThemeStyling' => 'LIGHT_BLUE|BLUE|PINK|RED', // REQUIRED
    'TitleText' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Theme' => [
        'CreatedTime' => <DateTime>,
        'StackName' => '<string>',
        'State' => 'ENABLED|DISABLED',
        'ThemeFaviconURL' => '<string>',
        'ThemeFooterLinks' => [
            [
                'DisplayName' => '<string>',
                'FooterLinkURL' => '<string>',
            ],
            // ...
        ],
        'ThemeOrganizationLogoURL' => '<string>',
        'ThemeStyling' => 'LIGHT_BLUE|BLUE|PINK|RED',
        'ThemeTitleText' => '<string>',
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceNotFoundException:

The specified resource was not found.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

OperationNotPermittedException:

The attempted operation is not permitted.

CreateUpdatedImage

$result = $client->createUpdatedImage([/* ... */]);
$promise = $client->createUpdatedImageAsync([/* ... */]);

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.

Parameter Syntax

$result = $client->createUpdatedImage([
    'dryRun' => true || false,
    'existingImageName' => '<string>', // REQUIRED
    'newImageDescription' => '<string>',
    'newImageDisplayName' => '<string>',
    'newImageName' => '<string>', // REQUIRED
    'newImageTags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'canUpdateImage' => true || false,
    'image' => [
        'Applications' => [
            [
                'AppBlockArn' => '<string>',
                'Arn' => '<string>',
                'CreatedTime' => <DateTime>,
                'Description' => '<string>',
                'DisplayName' => '<string>',
                'Enabled' => true || false,
                'IconS3Location' => [
                    'S3Bucket' => '<string>',
                    'S3Key' => '<string>',
                ],
                'IconURL' => '<string>',
                'InstanceFamilies' => ['<string>', ...],
                'LaunchParameters' => '<string>',
                'LaunchPath' => '<string>',
                'Metadata' => ['<string>', ...],
                'Name' => '<string>',
                'Platforms' => ['<string>', ...],
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'BaseImageArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DynamicAppProvidersEnabled' => 'ENABLED|DISABLED',
        'ImageBuilderName' => '<string>',
        'ImageBuilderSupported' => true || false,
        'ImageErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'ImagePermissions' => [
            'allowFleet' => true || false,
            'allowImageBuilder' => true || false,
        ],
        'ImageSharedWithOthers' => 'TRUE|FALSE',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'PublicBaseImageReleasedDate' => <DateTime>,
        'State' => 'PENDING|AVAILABLE|FAILED|COPYING|DELETING|CREATING|IMPORTING',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_BUILDER_NOT_AVAILABLE|IMAGE_COPY_FAILURE',
            'Message' => '<string>',
        ],
        'SupportedInstanceFamilies' => ['<string>', ...],
        'Visibility' => 'PUBLIC|PRIVATE|SHARED',
    ],
]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

CreateUsageReportSubscription

$result = $client->createUsageReportSubscription([/* ... */]);
$promise = $client->createUsageReportSubscriptionAsync([/* ... */]);

Creates a usage report subscription. Usage reports are generated daily.

Parameter Syntax

$result = $client->createUsageReportSubscription([
]);

Parameter Details

Result Syntax

[
    'S3BucketName' => '<string>',
    'Schedule' => 'DAILY',
]

Result Details

Errors

InvalidRoleException:

The specified role is invalid.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a new user in the user pool.

Parameter Syntax

$result = $client->createUser([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
    'FirstName' => '<string>',
    'LastName' => '<string>',
    'MessageAction' => 'SUPPRESS|RESEND',
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceAlreadyExistsException:

The specified resource already exists.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

OperationNotPermittedException:

The attempted operation is not permitted.

DeleteAppBlock

$result = $client->deleteAppBlock([/* ... */]);
$promise = $client->deleteAppBlockAsync([/* ... */]);

Deletes an app block.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

DeleteAppBlockBuilder

$result = $client->deleteAppBlockBuilder([/* ... */]);
$promise = $client->deleteAppBlockBuilderAsync([/* ... */]);

Deletes an app block builder.

An app block builder can only be deleted when it has no association with an app block.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteDirectoryConfig

$result = $client->deleteDirectoryConfig([/* ... */]);
$promise = $client->deleteDirectoryConfigAsync([/* ... */]);

Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

DeleteEntitlement

$result = $client->deleteEntitlement([/* ... */]);
$promise = $client->deleteEntitlementAsync([/* ... */]);

Deletes the specified entitlement.

Parameter Syntax

$result = $client->deleteEntitlement([
    'Name' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

EntitlementNotFoundException:

The entitlement can't be found.

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

Deletes the specified fleet.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteImage

$result = $client->deleteImage([/* ... */]);
$promise = $client->deleteImageAsync([/* ... */]);

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Image' => [
        'Applications' => [
            [
                'AppBlockArn' => '<string>',
                'Arn' => '<string>',
                'CreatedTime' => <DateTime>,
                'Description' => '<string>',
                'DisplayName' => '<string>',
                'Enabled' => true || false,
                'IconS3Location' => [
                    'S3Bucket' => '<string>',
                    'S3Key' => '<string>',
                ],
                'IconURL' => '<string>',
                'InstanceFamilies' => ['<string>', ...],
                'LaunchParameters' => '<string>',
                'LaunchPath' => '<string>',
                'Metadata' => ['<string>', ...],
                'Name' => '<string>',
                'Platforms' => ['<string>', ...],
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'BaseImageArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DynamicAppProvidersEnabled' => 'ENABLED|DISABLED',
        'ImageBuilderName' => '<string>',
        'ImageBuilderSupported' => true || false,
        'ImageErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'ImagePermissions' => [
            'allowFleet' => true || false,
            'allowImageBuilder' => true || false,
        ],
        'ImageSharedWithOthers' => 'TRUE|FALSE',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'PublicBaseImageReleasedDate' => <DateTime>,
        'State' => 'PENDING|AVAILABLE|FAILED|COPYING|DELETING|CREATING|IMPORTING',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_BUILDER_NOT_AVAILABLE|IMAGE_COPY_FAILURE',
            'Message' => '<string>',
        ],
        'SupportedInstanceFamilies' => ['<string>', ...],
        'Visibility' => 'PUBLIC|PRIVATE|SHARED',
    ],
]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteImageBuilder

$result = $client->deleteImageBuilder([/* ... */]);
$promise = $client->deleteImageBuilderAsync([/* ... */]);

Deletes the specified image builder and releases the capacity.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ImageBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DomainJoinInfo' => [
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
        ],
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'ImageArn' => '<string>',
        'ImageBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'InstanceType' => '<string>',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED|UPDATING|PENDING_QUALIFICATION',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_UNAVAILABLE',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteImagePermissions

$result = $client->deleteImagePermissions([/* ... */]);
$promise = $client->deleteImagePermissionsAsync([/* ... */]);

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

Parameter Syntax

$result = $client->deleteImagePermissions([
    'Name' => '<string>', // REQUIRED
    'SharedAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

DeleteStack

$result = $client->deleteStack([/* ... */]);
$promise = $client->deleteStackAsync([/* ... */]);

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

DeleteThemeForStack

$result = $client->deleteThemeForStack([/* ... */]);
$promise = $client->deleteThemeForStackAsync([/* ... */]);

Deletes custom branding that customizes the appearance of the streaming application catalog page.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

DeleteUsageReportSubscription

$result = $client->deleteUsageReportSubscription([/* ... */]);
$promise = $client->deleteUsageReportSubscriptionAsync([/* ... */]);

Disables usage report generation.

Parameter Syntax

$result = $client->deleteUsageReportSubscription([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ResourceNotFoundException:

The specified resource was not found.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user from the user pool.

Parameter Syntax

$result = $client->deleteUser([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeAppBlockBuilderAppBlockAssociations

$result = $client->describeAppBlockBuilderAppBlockAssociations([/* ... */]);
$promise = $client->describeAppBlockBuilderAppBlockAssociationsAsync([/* ... */]);

Retrieves a list that describes one or more app block builder associations.

Parameter Syntax

$result = $client->describeAppBlockBuilderAppBlockAssociations([
    'AppBlockArn' => '<string>',
    'AppBlockBuilderName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AppBlockBuilderAppBlockAssociations' => [
        [
            'AppBlockArn' => '<string>',
            'AppBlockBuilderName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

DescribeAppBlockBuilders

$result = $client->describeAppBlockBuilders([/* ... */]);
$promise = $client->describeAppBlockBuildersAsync([/* ... */]);

Retrieves a list that describes one or more app block builders.

Parameter Syntax

$result = $client->describeAppBlockBuilders([
    'MaxResults' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AppBlockBuilders' => [
        [
            'AccessEndpoints' => [
                [
                    'EndpointType' => 'STREAMING',
                    'VpceId' => '<string>',
                ],
                // ...
            ],
            'AppBlockBuilderErrors' => [
                [
                    'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                    'ErrorTimestamp' => <DateTime>,
                ],
                // ...
            ],
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'EnableDefaultInternetAccess' => true || false,
            'IamRoleArn' => '<string>',
            'InstanceType' => '<string>',
            'Name' => '<string>',
            'Platform' => 'WINDOWS_SERVER_2019',
            'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
            'StateChangeReason' => [
                'Code' => 'INTERNAL_ERROR',
                'Message' => '<string>',
            ],
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

DescribeAppBlocks

$result = $client->describeAppBlocks([/* ... */]);
$promise = $client->describeAppBlocksAsync([/* ... */]);

Retrieves a list that describes one or more app blocks.

Parameter Syntax

$result = $client->describeAppBlocks([
    'Arns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AppBlocks' => [
        [
            'AppBlockErrors' => [
                [
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'Name' => '<string>',
            'PackagingType' => 'CUSTOM|APPSTREAM2',
            'PostSetupScriptDetails' => [
                'ExecutableParameters' => '<string>',
                'ExecutablePath' => '<string>',
                'ScriptS3Location' => [
                    'S3Bucket' => '<string>',
                    'S3Key' => '<string>',
                ],
                'TimeoutInSeconds' => <integer>,
            ],
            'SetupScriptDetails' => [
                'ExecutableParameters' => '<string>',
                'ExecutablePath' => '<string>',
                'ScriptS3Location' => [
                    'S3Bucket' => '<string>',
                    'S3Key' => '<string>',
                ],
                'TimeoutInSeconds' => <integer>,
            ],
            'SourceS3Location' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'State' => 'INACTIVE|ACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

DescribeApplicationFleetAssociations

$result = $client->describeApplicationFleetAssociations([/* ... */]);
$promise = $client->describeApplicationFleetAssociationsAsync([/* ... */]);

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

Parameter Syntax

$result = $client->describeApplicationFleetAssociations([
    'ApplicationArn' => '<string>',
    'FleetName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationFleetAssociations' => [
        [
            'ApplicationArn' => '<string>',
            'FleetName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

DescribeApplications

$result = $client->describeApplications([/* ... */]);
$promise = $client->describeApplicationsAsync([/* ... */]);

Retrieves a list that describes one or more applications.

Parameter Syntax

$result = $client->describeApplications([
    'Arns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'AppBlockArn' => '<string>',
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'Enabled' => true || false,
            'IconS3Location' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'IconURL' => '<string>',
            'InstanceFamilies' => ['<string>', ...],
            'LaunchParameters' => '<string>',
            'LaunchPath' => '<string>',
            'Metadata' => ['<string>', ...],
            'Name' => '<string>',
            'Platforms' => ['<string>', ...],
            'WorkingDirectory' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

DescribeDirectoryConfigs

$result = $client->describeDirectoryConfigs([/* ... */]);
$promise = $client->describeDirectoryConfigsAsync([/* ... */]);

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

Parameter Syntax

$result = $client->describeDirectoryConfigs([
    'DirectoryNames' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DirectoryConfigs' => [
        [
            'CertificateBasedAuthProperties' => [
                'CertificateAuthorityArn' => '<string>',
                'Status' => 'DISABLED|ENABLED|ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
            ],
            'CreatedTime' => <DateTime>,
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
            'ServiceAccountCredentials' => [
                'AccountName' => '<string>',
                'AccountPassword' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeEntitlements

$result = $client->describeEntitlements([/* ... */]);
$promise = $client->describeEntitlementsAsync([/* ... */]);

Retrieves a list that describes one of more entitlements.

Parameter Syntax

$result = $client->describeEntitlements([
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Entitlements' => [
        [
            'AppVisibility' => 'ALL|ASSOCIATED',
            'Attributes' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'StackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

EntitlementNotFoundException:

The entitlement can't be found.

DescribeFleets

$result = $client->describeFleets([/* ... */]);
$promise = $client->describeFleetsAsync([/* ... */]);

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Parameter Syntax

$result = $client->describeFleets([
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Fleets' => [
        [
            'Arn' => '<string>',
            'ComputeCapacityStatus' => [
                'ActiveUserSessions' => <integer>,
                'ActualUserSessions' => <integer>,
                'Available' => <integer>,
                'AvailableUserSessions' => <integer>,
                'Desired' => <integer>,
                'DesiredUserSessions' => <integer>,
                'InUse' => <integer>,
                'Running' => <integer>,
            ],
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisconnectTimeoutInSeconds' => <integer>,
            'DisplayName' => '<string>',
            'DomainJoinInfo' => [
                'DirectoryName' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
            ],
            'EnableDefaultInternetAccess' => true || false,
            'FleetErrors' => [
                [
                    'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            'FleetType' => 'ALWAYS_ON|ON_DEMAND|ELASTIC',
            'IamRoleArn' => '<string>',
            'IdleDisconnectTimeoutInSeconds' => <integer>,
            'ImageArn' => '<string>',
            'ImageName' => '<string>',
            'InstanceType' => '<string>',
            'MaxConcurrentSessions' => <integer>,
            'MaxSessionsPerInstance' => <integer>,
            'MaxUserDurationInSeconds' => <integer>,
            'Name' => '<string>',
            'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
            'SessionScriptS3Location' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
            'StreamView' => 'APP|DESKTOP',
            'UsbDeviceFilterStrings' => ['<string>', ...],
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeImageBuilders

$result = $client->describeImageBuilders([/* ... */]);
$promise = $client->describeImageBuildersAsync([/* ... */]);

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

Parameter Syntax

$result = $client->describeImageBuilders([
    'MaxResults' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ImageBuilders' => [
        [
            'AccessEndpoints' => [
                [
                    'EndpointType' => 'STREAMING',
                    'VpceId' => '<string>',
                ],
                // ...
            ],
            'AppstreamAgentVersion' => '<string>',
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'DomainJoinInfo' => [
                'DirectoryName' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
            ],
            'EnableDefaultInternetAccess' => true || false,
            'IamRoleArn' => '<string>',
            'ImageArn' => '<string>',
            'ImageBuilderErrors' => [
                [
                    'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                    'ErrorTimestamp' => <DateTime>,
                ],
                // ...
            ],
            'InstanceType' => '<string>',
            'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
            'Name' => '<string>',
            'NetworkAccessConfiguration' => [
                'EniId' => '<string>',
                'EniPrivateIpAddress' => '<string>',
            ],
            'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
            'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED|UPDATING|PENDING_QUALIFICATION',
            'StateChangeReason' => [
                'Code' => 'INTERNAL_ERROR|IMAGE_UNAVAILABLE',
                'Message' => '<string>',
            ],
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeImagePermissions

$result = $client->describeImagePermissions([/* ... */]);
$promise = $client->describeImagePermissionsAsync([/* ... */]);

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Parameter Syntax

$result = $client->describeImagePermissions([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'SharedAwsAccountIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Name' => '<string>',
    'NextToken' => '<string>',
    'SharedImagePermissionsList' => [
        [
            'imagePermissions' => [
                'allowFleet' => true || false,
                'allowImageBuilder' => true || false,
            ],
            'sharedAccountId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeImages

$result = $client->describeImages([/* ... */]);
$promise = $client->describeImagesAsync([/* ... */]);

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

Parameter Syntax

$result = $client->describeImages([
    'Arns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
    'Type' => 'PUBLIC|PRIVATE|SHARED',
]);

Parameter Details

Result Syntax

[
    'Images' => [
        [
            'Applications' => [
                [
                    'AppBlockArn' => '<string>',
                    'Arn' => '<string>',
                    'CreatedTime' => <DateTime>,
                    'Description' => '<string>',
                    'DisplayName' => '<string>',
                    'Enabled' => true || false,
                    'IconS3Location' => [
                        'S3Bucket' => '<string>',
                        'S3Key' => '<string>',
                    ],
                    'IconURL' => '<string>',
                    'InstanceFamilies' => ['<string>', ...],
                    'LaunchParameters' => '<string>',
                    'LaunchPath' => '<string>',
                    'Metadata' => ['<string>', ...],
                    'Name' => '<string>',
                    'Platforms' => ['<string>', ...],
                    'WorkingDirectory' => '<string>',
                ],
                // ...
            ],
            'AppstreamAgentVersion' => '<string>',
            'Arn' => '<string>',
            'BaseImageArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'DynamicAppProvidersEnabled' => 'ENABLED|DISABLED',
            'ImageBuilderName' => '<string>',
            'ImageBuilderSupported' => true || false,
            'ImageErrors' => [
                [
                    'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                    'ErrorTimestamp' => <DateTime>,
                ],
                // ...
            ],
            'ImagePermissions' => [
                'allowFleet' => true || false,
                'allowImageBuilder' => true || false,
            ],
            'ImageSharedWithOthers' => 'TRUE|FALSE',
            'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
            'Name' => '<string>',
            'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
            'PublicBaseImageReleasedDate' => <DateTime>,
            'State' => 'PENDING|AVAILABLE|FAILED|COPYING|DELETING|CREATING|IMPORTING',
            'StateChangeReason' => [
                'Code' => 'INTERNAL_ERROR|IMAGE_BUILDER_NOT_AVAILABLE|IMAGE_COPY_FAILURE',
                'Message' => '<string>',
            ],
            'SupportedInstanceFamilies' => ['<string>', ...],
            'Visibility' => 'PUBLIC|PRIVATE|SHARED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

ResourceNotFoundException:

The specified resource was not found.

DescribeSessions

$result = $client->describeSessions([/* ... */]);
$promise = $client->describeSessionsAsync([/* ... */]);

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Parameter Syntax

$result = $client->describeSessions([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
    'FleetName' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
    'UserId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Sessions' => [
        [
            'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
            'ConnectionState' => 'CONNECTED|NOT_CONNECTED',
            'FleetName' => '<string>',
            'Id' => '<string>',
            'InstanceId' => '<string>',
            'MaxExpirationTime' => <DateTime>,
            'NetworkAccessConfiguration' => [
                'EniId' => '<string>',
                'EniPrivateIpAddress' => '<string>',
            ],
            'StackName' => '<string>',
            'StartTime' => <DateTime>,
            'State' => 'ACTIVE|PENDING|EXPIRED',
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

DescribeStacks

$result = $client->describeStacks([/* ... */]);
$promise = $client->describeStacksAsync([/* ... */]);

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Parameter Syntax

$result = $client->describeStacks([
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Stacks' => [
        [
            'AccessEndpoints' => [
                [
                    'EndpointType' => 'STREAMING',
                    'VpceId' => '<string>',
                ],
                // ...
            ],
            'ApplicationSettings' => [
                'Enabled' => true || false,
                'S3BucketName' => '<string>',
                'SettingsGroup' => '<string>',
            ],
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'EmbedHostDomains' => ['<string>', ...],
            'FeedbackURL' => '<string>',
            'Name' => '<string>',
            'RedirectURL' => '<string>',
            'StackErrors' => [
                [
                    'ErrorCode' => 'STORAGE_CONNECTOR_ERROR|INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            'StorageConnectors' => [
                [
                    'ConnectorType' => 'HOMEFOLDERS|GOOGLE_DRIVE|ONE_DRIVE',
                    'Domains' => ['<string>', ...],
                    'ResourceIdentifier' => '<string>',
                ],
                // ...
            ],
            'StreamingExperienceSettings' => [
                'PreferredProtocol' => 'TCP|UDP',
            ],
            'UserSettings' => [
                [
                    'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE|DOMAIN_PASSWORD_SIGNIN|DOMAIN_SMART_CARD_SIGNIN|AUTO_TIME_ZONE_REDIRECTION',
                    'MaximumLength' => <integer>,
                    'Permission' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeThemeForStack

$result = $client->describeThemeForStack([/* ... */]);
$promise = $client->describeThemeForStackAsync([/* ... */]);

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Theme' => [
        'CreatedTime' => <DateTime>,
        'StackName' => '<string>',
        'State' => 'ENABLED|DISABLED',
        'ThemeFaviconURL' => '<string>',
        'ThemeFooterLinks' => [
            [
                'DisplayName' => '<string>',
                'FooterLinkURL' => '<string>',
            ],
            // ...
        ],
        'ThemeOrganizationLogoURL' => '<string>',
        'ThemeStyling' => 'LIGHT_BLUE|BLUE|PINK|RED',
        'ThemeTitleText' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

DescribeUsageReportSubscriptions

$result = $client->describeUsageReportSubscriptions([/* ... */]);
$promise = $client->describeUsageReportSubscriptionsAsync([/* ... */]);

Retrieves a list that describes one or more usage report subscriptions.

Parameter Syntax

$result = $client->describeUsageReportSubscriptions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'UsageReportSubscriptions' => [
        [
            'LastGeneratedReportDate' => <DateTime>,
            'S3BucketName' => '<string>',
            'Schedule' => 'DAILY',
            'SubscriptionErrors' => [
                [
                    'ErrorCode' => 'RESOURCE_NOT_FOUND|ACCESS_DENIED|INTERNAL_SERVICE_ERROR',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

DescribeUserStackAssociations

$result = $client->describeUserStackAssociations([/* ... */]);
$promise = $client->describeUserStackAssociationsAsync([/* ... */]);

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

• The stack name

• The user name (email address of the user associated with the stack) and the authentication type for the user

Parameter Syntax

$result = $client->describeUserStackAssociations([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackName' => '<string>',
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'UserStackAssociations' => [
        [
            'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
            'SendEmailNotification' => true || false,
            'StackName' => '<string>',
            'UserName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

DescribeUsers

$result = $client->describeUsers([/* ... */]);
$promise = $client->describeUsersAsync([/* ... */]);

Retrieves a list that describes one or more specified users in the user pool.

Parameter Syntax

$result = $client->describeUsers([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD',
            'CreatedTime' => <DateTime>,
            'Enabled' => true || false,
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Status' => '<string>',
            'UserName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

DisableUser

$result = $client->disableUser([/* ... */]);
$promise = $client->disableUserAsync([/* ... */]);

Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.

Parameter Syntax

$result = $client->disableUser([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DisassociateAppBlockBuilderAppBlock

$result = $client->disassociateAppBlockBuilderAppBlock([/* ... */]);
$promise = $client->disassociateAppBlockBuilderAppBlockAsync([/* ... */]);

Disassociates a specified app block builder from a specified app block.

Parameter Syntax

$result = $client->disassociateAppBlockBuilderAppBlock([
    'AppBlockArn' => '<string>', // REQUIRED
    'AppBlockBuilderName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

DisassociateApplicationFleet

$result = $client->disassociateApplicationFleet([/* ... */]);
$promise = $client->disassociateApplicationFleetAsync([/* ... */]);

Disassociates the specified application from the fleet.

Parameter Syntax

$result = $client->disassociateApplicationFleet([
    'ApplicationArn' => '<string>', // REQUIRED
    'FleetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

OperationNotPermittedException:

The attempted operation is not permitted.

DisassociateApplicationFromEntitlement

$result = $client->disassociateApplicationFromEntitlement([/* ... */]);
$promise = $client->disassociateApplicationFromEntitlementAsync([/* ... */]);

Deletes the specified application from the specified entitlement.

Parameter Syntax

$result = $client->disassociateApplicationFromEntitlement([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EntitlementName' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

EntitlementNotFoundException:

The entitlement can't be found.

OperationNotPermittedException:

The attempted operation is not permitted.

DisassociateFleet

$result = $client->disassociateFleet([/* ... */]);
$promise = $client->disassociateFleetAsync([/* ... */]);

Disassociates the specified fleet from the specified stack.

Parameter Syntax

$result = $client->disassociateFleet([
    'FleetName' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

OperationNotPermittedException:

The attempted operation is not permitted.

EnableUser

$result = $client->enableUser([/* ... */]);
$promise = $client->enableUserAsync([/* ... */]);

Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.

Parameter Syntax

$result = $client->enableUser([
    'AuthenticationType' => 'API|SAML|USERPOOL|AWS_AD', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ExpireSession

$result = $client->expireSession([/* ... */]);
$promise = $client->expireSessionAsync([/* ... */]);

Immediately stops the specified streaming session.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

ListAssociatedFleets

$result = $client->listAssociatedFleets([/* ... */]);
$promise = $client->listAssociatedFleetsAsync([/* ... */]);

Retrieves the name of the fleet that is associated with the specified stack.

Parameter Syntax

$result = $client->listAssociatedFleets([
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAssociatedStacks

$result = $client->listAssociatedStacks([/* ... */]);
$promise = $client->listAssociatedStacksAsync([/* ... */]);

Retrieves the name of the stack with which the specified fleet is associated.

Parameter Syntax

$result = $client->listAssociatedStacks([
    'FleetName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListEntitledApplications

$result = $client->listEntitledApplications([/* ... */]);
$promise = $client->listEntitledApplicationsAsync([/* ... */]);

Retrieves a list of entitled applications.

Parameter Syntax

$result = $client->listEntitledApplications([
    'EntitlementName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EntitledApplications' => [
        [
            'ApplicationIdentifier' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

EntitlementNotFoundException:

The entitlement can't be found.

ListTagsForResource

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

Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

StartAppBlockBuilder

$result = $client->startAppBlockBuilder([/* ... */]);
$promise = $client->startAppBlockBuilderAsync([/* ... */]);

Starts an app block builder.

An app block builder can only be started when it's associated with an app block.

Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AppBlockBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppBlockBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'InstanceType' => '<string>',
        'Name' => '<string>',
        'Platform' => 'WINDOWS_SERVER_2019',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

OperationNotPermittedException:

The attempted operation is not permitted.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

StartFleet

$result = $client->startFleet([/* ... */]);
$promise = $client->startFleetAsync([/* ... */]);

Starts the specified fleet.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

InvalidRoleException:

The specified role is invalid.

StartImageBuilder

$result = $client->startImageBuilder([/* ... */]);
$promise = $client->startImageBuilderAsync([/* ... */]);

Starts the specified image builder.

Parameter Syntax

$result = $client->startImageBuilder([
    'AppstreamAgentVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ImageBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DomainJoinInfo' => [
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
        ],
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'ImageArn' => '<string>',
        'ImageBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'InstanceType' => '<string>',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED|UPDATING|PENDING_QUALIFICATION',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_UNAVAILABLE',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

IncompatibleImageException:

The image can't be updated because it's not compatible for updates.

StopAppBlockBuilder

$result = $client->stopAppBlockBuilder([/* ... */]);
$promise = $client->stopAppBlockBuilderAsync([/* ... */]);

Stops an app block builder.

Stopping an app block builder terminates the instance, and the instance state is not persisted.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AppBlockBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppBlockBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'InstanceType' => '<string>',
        'Name' => '<string>',
        'Platform' => 'WINDOWS_SERVER_2019',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

OperationNotPermittedException:

The attempted operation is not permitted.

ResourceNotFoundException:

The specified resource was not found.

StopFleet

$result = $client->stopFleet([/* ... */]);
$promise = $client->stopFleetAsync([/* ... */]);

Stops the specified fleet.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

StopImageBuilder

$result = $client->stopImageBuilder([/* ... */]);
$promise = $client->stopImageBuilderAsync([/* ... */]);

Stops the specified image builder.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ImageBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'DomainJoinInfo' => [
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
        ],
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'ImageArn' => '<string>',
        'ImageBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'InstanceType' => '<string>',
        'LatestAppstreamAgentVersion' => 'TRUE|FALSE',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED|UPDATING|PENDING_QUALIFICATION',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_UNAVAILABLE',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

TagResource

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

Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

ResourceNotFoundException:

The specified resource was not found.

UntagResource

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

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

UpdateAppBlockBuilder

$result = $client->updateAppBlockBuilder([/* ... */]);
$promise = $client->updateAppBlockBuilderAsync([/* ... */]);

Updates an app block builder.

If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.

Parameter Syntax

$result = $client->updateAppBlockBuilder([
    'AccessEndpoints' => [
        [
            'EndpointType' => 'STREAMING', // REQUIRED
            'VpceId' => '<string>',
        ],
        // ...
    ],
    'AttributesToDelete' => ['<string>', ...],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'EnableDefaultInternetAccess' => true || false,
    'IamRoleArn' => '<string>',
    'InstanceType' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|AMAZON_LINUX2|RHEL8|ROCKY_LINUX8',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'AppBlockBuilder' => [
        'AccessEndpoints' => [
            [
                'EndpointType' => 'STREAMING',
                'VpceId' => '<string>',
            ],
            // ...
        ],
        'AppBlockBuilderErrors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|IAM_SERVICE_ROLE_IS_MISSING|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|FLEET_STOPPED|FLEET_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage' => '<string>',
                'ErrorTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'EnableDefaultInternetAccess' => true || false,
        'IamRoleArn' => '<string>',
        'InstanceType' => '<string>',
        'Name' => '<string>',
        'Platform' => 'WINDOWS_SERVER_2019',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR',
            'Message' => '<string>',
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

InvalidAccountStatusException:

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

InvalidParameterCombinationException:

Indicates an incorrect combination of parameters, or a missing parameter.

InvalidRoleException:

The specified role is invalid.

LimitExceededException:

The requested limit exceeds the permitted limit for an account.

OperationNotPermittedException:

The attempted operation is not permitted.

RequestLimitExceededException:

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

ResourceInUseException:

The specified resource is in use.

ResourceNotAvailableException:

The specified resource exists and is not in use, but isn't available.

ResourceNotFoundException:

The specified resource was not found.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates the specified application.

Parameter Syntax

$result = $client->updateApplication([
    'AppBlockArn' => '<string>',
    'AttributesToDelete' => ['<string>', ...],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'IconS3Location' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'LaunchParameters' => '<string>',
    'LaunchPath' => '<string>',
    'Name' => '<string>', // REQUIRED
    'WorkingDirectory' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Application' => [
        'AppBlockArn' => '<string>',
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Enabled' => true || false,
        'IconS3Location' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'IconURL' => '<string>',
        'InstanceFamilies' => ['<string>', ...],
        'LaunchParameters' => '<string>',
        'LaunchPath' => '<string>',
        'Metadata' => ['<string>', ...],
        'Name' => '<string>',
        'Platforms' => ['<string>', ...],
        'WorkingDirectory' => '<string>',
    ],
]

Result Details

Errors

OperationNotPermittedException:

The attempted operation is not permitted.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

ResourceNotFoundException:

The specified resource was not found.

UpdateDirectoryConfig

$result = $client->updateDirectoryConfig([/* ... */]);
$promise = $client->updateDirectoryConfigAsync([/* ... */]);

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Parameter Syntax

$result = $client->updateDirectoryConfig([
    'CertificateBasedAuthProperties' => [
        'CertificateAuthorityArn' => '<string>',
        'Status' => 'DISABLED|ENABLED|ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
    ],
    'DirectoryName' => '<string>', // REQUIRED
    'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
    'ServiceAccountCredentials' => [
        'AccountName' => '<string>', // REQUIRED
        'AccountPassword' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryConfig' => [
        'CertificateBasedAuthProperties' => [
            'CertificateAuthorityArn' => '<string>',
            'Status' => 'DISABLED|ENABLED|ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
        ],
        'CreatedTime' => <DateTime>,
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
        'ServiceAccountCredentials' => [
            'AccountName' => '<string>',
            'AccountPassword' => '<string>',
        ],
    ],
]

Result Details

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource was not found.

ConcurrentModificationException:

An API error occurred. Wait a few minutes and try again.

OperationNotPermittedException:

The attempted operation is not permitted.

InvalidRoleException:

The specified role is invalid.

UpdateEntitlement

$result = $client->updateEntitlement([/* ... */]);
$promise = $client->updateEntitlementAsync([/* ... */]);

Updates the specified entitlement.

Parameter Syntax

$result = $client->updateEntitlement([
    'AppVisibility' => 'ALL|ASSOCIATED',
    'Attributes' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details