Amazon AppStream 2016-12-01

AssociateFleet

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

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 does not support storage connectors.

• OperationNotPermittedException:

  The attempted operation is not permitted.

BatchAssociateUserStack

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• OperationNotPermittedException:

  The attempted operation is not permitted.

BatchDisassociateUserStack

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

CopyImage

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

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 does not support storage connectors.

CreateDirectoryConfig

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

Parameter Syntax

$result = $client->createDirectoryConfig([
    'DirectoryName' => '<string>', // REQUIRED
    'OrganizationalUnitDistinguishedNames' => ['<string>', ...], // REQUIRED
    'ServiceAccountCredentials' => [ // REQUIRED
        'AccountName' => '<string>', // REQUIRED
        'AccountPassword' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryConfig' => [
        'CreatedTime' => <DateTime>,
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
        'ServiceAccountCredentials' => [
            'AccountName' => '<string>',
            'AccountPassword' => '<string>',
        ],
    ],
]

Result Details

Errors

• 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.

CreateFleet

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

Parameter Syntax

$result = $client->createFleet([
    'ComputeCapacity' => [ // REQUIRED
        'DesiredInstances' => <integer>, // REQUIRED
    ],
    'Description' => '<string>',
    'DisconnectTimeoutInSeconds' => <integer>,
    'DisplayName' => '<string>',
    'DomainJoinInfo' => [
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedName' => '<string>',
    ],
    'EnableDefaultInternetAccess' => true || false,
    'FleetType' => 'ALWAYS_ON|ON_DEMAND',
    'IamRoleArn' => '<string>',
    'IdleDisconnectTimeoutInSeconds' => <integer>,
    'ImageArn' => '<string>',
    'ImageName' => '<string>',
    'InstanceType' => '<string>', // REQUIRED
    'MaxUserDurationInSeconds' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'Fleet' => [
        'Arn' => '<string>',
        'ComputeCapacityStatus' => [
            'Available' => <integer>,
            'Desired' => <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|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',
        'IamRoleArn' => '<string>',
        'IdleDisconnectTimeoutInSeconds' => <integer>,
        'ImageArn' => '<string>',
        'ImageName' => '<string>',
        'InstanceType' => '<string>',
        'MaxUserDurationInSeconds' => <integer>,
        'Name' => '<string>',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        '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.

• 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 does not support storage connectors.

• OperationNotPermittedException:

  The attempted operation is not permitted.

CreateImageBuilder

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

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|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>',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED',
        '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.

• 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 does not support storage connectors.

• OperationNotPermittedException:

  The attempted operation is not permitted.

CreateImageBuilderStreamingURL

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

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

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>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
    'UserSettings' => [
        [
            'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE', // REQUIRED
            '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>',
            ],
            // ...
        ],
        'UserSettings' => [
            [
                'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE',
                '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.

CreateStreamingURL

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

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.

CreateUsageReportSubscription

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

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

Parameter Syntax

$result = $client->createUser([
    'AuthenticationType' => 'API|SAML|USERPOOL', // 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.

DeleteDirectoryConfig

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

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.

DeleteFleet

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Image' => [
        'Applications' => [
            [
                'DisplayName' => '<string>',
                'Enabled' => true || false,
                'IconURL' => '<string>',
                'LaunchParameters' => '<string>',
                'LaunchPath' => '<string>',
                'Metadata' => ['<string>', ...],
                'Name' => '<string>',
            ],
            // ...
        ],
        'AppstreamAgentVersion' => '<string>',
        'Arn' => '<string>',
        'BaseImageArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'ImageBuilderName' => '<string>',
        'ImageBuilderSupported' => true || false,
        'ImagePermissions' => [
            'allowFleet' => true || false,
            'allowImageBuilder' => true || false,
        ],
        'Name' => '<string>',
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
        'PublicBaseImageReleasedDate' => <DateTime>,
        'State' => 'PENDING|AVAILABLE|FAILED|COPYING|DELETING',
        'StateChangeReason' => [
            'Code' => 'INTERNAL_ERROR|IMAGE_BUILDER_NOT_AVAILABLE|IMAGE_COPY_FAILURE',
            'Message' => '<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([/* ... */]);

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|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>',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED',
        '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([/* ... */]);

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

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.

• ConcurrentModificationException:

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

DeleteUsageReportSubscription

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

DescribeDirectoryConfigs

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DirectoryConfigs' => [
        [
            'CreatedTime' => <DateTime>,
            'DirectoryName' => '<string>',
            'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
            'ServiceAccountCredentials' => [
                'AccountName' => '<string>',
                'AccountPassword' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

DescribeFleets

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Fleets' => [
        [
            'Arn' => '<string>',
            'ComputeCapacityStatus' => [
                'Available' => <integer>,
                'Desired' => <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|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',
            'IamRoleArn' => '<string>',
            'IdleDisconnectTimeoutInSeconds' => <integer>,
            'ImageArn' => '<string>',
            'ImageName' => '<string>',
            'InstanceType' => '<string>',
            'MaxUserDurationInSeconds' => <integer>,
            'Name' => '<string>',
            'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

DescribeImageBuilders

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

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|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>',
            'Name' => '<string>',
            'NetworkAccessConfiguration' => [
                'EniId' => '<string>',
                'EniPrivateIpAddress' => '<string>',
            ],
            'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
            'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED',
            '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([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Images' => [
        [
            'Applications' => [
                [
                    'DisplayName' => '<string>',
                    'Enabled' => true || false,
                    'IconURL' => '<string>',
                    'LaunchParameters' => '<string>',
                    'LaunchPath' => '<string>',
                    'Metadata' => ['<string>', ...],
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AppstreamAgentVersion' => '<string>',
            'Arn' => '<string>',
            'BaseImageArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'ImageBuilderName' => '<string>',
            'ImageBuilderSupported' => true || false,
            'ImagePermissions' => [
                'allowFleet' => true || false,
                'allowImageBuilder' => true || false,
            ],
            'Name' => '<string>',
            'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
            'PublicBaseImageReleasedDate' => <DateTime>,
            'State' => 'PENDING|AVAILABLE|FAILED|COPYING|DELETING',
            'StateChangeReason' => [
                'Code' => 'INTERNAL_ERROR|IMAGE_BUILDER_NOT_AVAILABLE|IMAGE_COPY_FAILURE',
                'Message' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Sessions' => [
        [
            'AuthenticationType' => 'API|SAML|USERPOOL',
            'ConnectionState' => 'CONNECTED|NOT_CONNECTED',
            'FleetName' => '<string>',
            'Id' => '<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([/* ... */]);

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>',
                ],
                // ...
            ],
            'UserSettings' => [
                [
                    'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE',
                    'Permission' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

DescribeUsageReportSubscriptions

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidParameterCombinationException:

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

DescribeUsers

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'AuthenticationType' => 'API|SAML|USERPOOL',
            '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.

DisableUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

DisassociateFleet

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

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.

EnableUser

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

Parameter Syntax

$result = $client->enableUser([
    'AuthenticationType' => 'API|SAML|USERPOOL', // 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([/* ... */]);

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

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

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.

ListTagsForResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

StartFleet

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

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.

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

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|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>',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED',
        '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 does not support storage connectors.

StopFleet

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

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

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|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>',
        'Name' => '<string>',
        'NetworkAccessConfiguration' => [
            'EniId' => '<string>',
            'EniPrivateIpAddress' => '<string>',
        ],
        'Platform' => 'WINDOWS|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019',
        'State' => 'PENDING|UPDATING_AGENT|RUNNING|STOPPING|STOPPED|REBOOTING|SNAPSHOTTING|DELETING|FAILED',
        '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([/* ... */]);

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

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.

UpdateDirectoryConfig

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

Parameter Syntax

$result = $client->updateDirectoryConfig([
    'DirectoryName' => '<string>', // REQUIRED
    'OrganizationalUnitDistinguishedNames' => ['<string>', ...],
    'ServiceAccountCredentials' => [
        'AccountName' => '<string>', // REQUIRED
        'AccountPassword' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryConfig' => [
        '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.

UpdateFleet

$result = $client->updateFleet([/* ... */]);
$promise = $client->updateFleetAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFleet([
    'AttributesToDelete' => ['<string>', ...],
    'ComputeCapacity' => [
        'DesiredInstances' => <integer>, // REQUIRED
    ],
    'DeleteVpcConfig' => true || false,
    'Description' => '<string>',
    'DisconnectTimeoutInSeconds' => <integer>,
    'DisplayName' => '<string>',
    'DomainJoinInfo' => [
        'DirectoryName' => '<string>',
        'OrganizationalUnitDistinguishedName' => '<string>',
    ],
    'EnableDefaultInternetAccess' => true || false,
    'IamRoleArn' => '<string>',
    'IdleDisconnectTimeoutInSeconds' => <integer>,
    'ImageArn' => '<string>',
    'ImageName' => '<string>',
    'InstanceType' => '<string>',
    'MaxUserDurationInSeconds' => <integer>,
    'Name' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'Fleet' => [
        'Arn' => '<string>',
        'ComputeCapacityStatus' => [
            'Available' => <integer>,
            'Desired' => <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|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',
        'IamRoleArn' => '<string>',
        'IdleDisconnectTimeoutInSeconds' => <integer>,
        'ImageArn' => '<string>',
        'ImageName' => '<string>',
        'InstanceType' => '<string>',
        'MaxUserDurationInSeconds' => <integer>,
        'Name' => '<string>',
        'State' => 'STARTING|RUNNING|STOPPING|STOPPED',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

• ResourceInUseException:

  The specified resource is in use.

• 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.

• InvalidRoleException:

  The specified role is invalid.

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceNotAvailableException:

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

• InvalidParameterCombinationException:

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

• ConcurrentModificationException:

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

• IncompatibleImageException:

  The image does not support storage connectors.

• OperationNotPermittedException:

  The attempted operation is not permitted.

UpdateImagePermissions

$result = $client->updateImagePermissions([/* ... */]);
$promise = $client->updateImagePermissionsAsync([/* ... */]);

Parameter Syntax

$result = $client->updateImagePermissions([
    'ImagePermissions' => [ // REQUIRED
        'allowFleet' => true || false,
        'allowImageBuilder' => true || false,
    ],
    'Name' => '<string>', // REQUIRED
    'SharedAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• 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.

UpdateStack

$result = $client->updateStack([/* ... */]);
$promise = $client->updateStackAsync([/* ... */]);

Parameter Syntax

$result = $client->updateStack([
    'AccessEndpoints' => [
        [
            'EndpointType' => 'STREAMING', // REQUIRED
            'VpceId' => '<string>',
        ],
        // ...
    ],
    'ApplicationSettings' => [
        'Enabled' => true || false, // REQUIRED
        'SettingsGroup' => '<string>',
    ],
    'AttributesToDelete' => ['<string>', ...],
    'DeleteStorageConnectors' => true || false,
    '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>',
        ],
        // ...
    ],
    'UserSettings' => [
        [
            'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE', // REQUIRED
            '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>',
            ],
            // ...
        ],
        'UserSettings' => [
            [
                'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|FILE_UPLOAD|FILE_DOWNLOAD|PRINTING_TO_LOCAL_DEVICE',
                'Permission' => 'ENABLED|DISABLED',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The specified resource was not found.

• ResourceInUseException:

  The specified resource is in use.

• InvalidRoleException:

  The specified role is invalid.

• InvalidParameterCombinationException:

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

• 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 does not support storage connectors.

• OperationNotPermittedException:

  The attempted operation is not permitted.

• ConcurrentModificationException:

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