AppStreamClient Class

Member Function Documentation

AppStreamClient::AppStreamClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a AppStreamClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

AppStreamClient::AppStreamClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads AppStreamClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateFleetResponse *AppStreamClient::associateFleet(const AssociateFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an AssociateFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates the specified fleet with the specified

[slot] CopyImageResponse *AppStreamClient::copyImage(const CopyImageRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CopyImageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateDirectoryConfigResponse *AppStreamClient::createDirectoryConfig(const CreateDirectoryConfigRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateDirectoryConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a directory

[slot] CreateFleetResponse *AppStreamClient::createFleet(const CreateFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a

[slot] CreateImageBuilderResponse *AppStreamClient::createImageBuilder(const CreateImageBuilderRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateImageBuilderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an image

builder>

The initial state of the builder is <code>PENDING</code>. When it is ready, the state is

[slot] CreateImageBuilderStreamingURLResponse *AppStreamClient::createImageBuilderStreamingURL(const CreateImageBuilderStreamingURLRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateImageBuilderStreamingURLResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a URL to start an image builder streaming

[slot] CreateStackResponse *AppStreamClient::createStack(const CreateStackRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a

[slot] CreateStreamingURLResponse *AppStreamClient::createStreamingURL(const CreateStreamingURLRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an CreateStreamingURLResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a URL to start a streaming session for the specified

[slot] DeleteDirectoryConfigResponse *AppStreamClient::deleteDirectoryConfig(const DeleteDirectoryConfigRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DeleteDirectoryConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified directory

[slot] DeleteFleetResponse *AppStreamClient::deleteFleet(const DeleteFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DeleteFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified

[slot] DeleteImageResponse *AppStreamClient::deleteImage(const DeleteImageRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DeleteImageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteImageBuilderResponse *AppStreamClient::deleteImageBuilder(const DeleteImageBuilderRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DeleteImageBuilderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified image builder and releases the

[slot] DeleteStackResponse *AppStreamClient::deleteStack(const DeleteStackRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DeleteStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are

[slot] DescribeDirectoryConfigsResponse *AppStreamClient::describeDirectoryConfigs(const DescribeDirectoryConfigsRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeDirectoryConfigsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

[slot] DescribeFleetsResponse *AppStreamClient::describeFleets(const DescribeFleetsRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeFleetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified fleets or all fleets in the

[slot] DescribeImageBuildersResponse *AppStreamClient::describeImageBuilders(const DescribeImageBuildersRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeImageBuildersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified image builders or all image builders in the

[slot] DescribeImagesResponse *AppStreamClient::describeImages(const DescribeImagesRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeImagesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified images or all images in the

[slot] DescribeSessionsResponse *AppStreamClient::describeSessions(const DescribeSessionsRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeSessionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming

[slot] DescribeStacksResponse *AppStreamClient::describeStacks(const DescribeStacksRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DescribeStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified stacks or all stacks in the

[slot] DisassociateFleetResponse *AppStreamClient::disassociateFleet(const DisassociateFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an DisassociateFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates the specified fleet from the specified

[slot] ExpireSessionResponse *AppStreamClient::expireSession(const ExpireSessionRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an ExpireSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the specified streaming

[slot] ListAssociatedFleetsResponse *AppStreamClient::listAssociatedFleets(const ListAssociatedFleetsRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an ListAssociatedFleetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the fleets associated with the specified

[slot] ListAssociatedStacksResponse *AppStreamClient::listAssociatedStacks(const ListAssociatedStacksRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an ListAssociatedStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the stacks associated with the specified

[slot] ListTagsForResourceResponse *AppStreamClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the 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 <a href="http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer

[slot] StartFleetResponse *AppStreamClient::startFleet(const StartFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an StartFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the specified

[slot] StartImageBuilderResponse *AppStreamClient::startImageBuilder(const StartImageBuilderRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an StartImageBuilderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the specified image

[slot] StopFleetResponse *AppStreamClient::stopFleet(const StopFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an StopFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the specified

[slot] StopImageBuilderResponse *AppStreamClient::stopImageBuilder(const StopImageBuilderRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an StopImageBuilderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the specified image

[slot] TagResourceResponse *AppStreamClient::tagResource(const TagResourceRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>ListTagsForResource</a>. To disassociate tags from your resources, use

<a>UntagResource</a>>

For more information about tags, see <a href="http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer

[slot] UntagResourceResponse *AppStreamClient::untagResource(const UntagResourceRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates the specified tags from the specified AppStream 2.0

resource>

To list the current tags for your resources, use

<a>ListTagsForResource</a>>

For more information about tags, see <a href="http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer

[slot] UpdateDirectoryConfigResponse *AppStreamClient::updateDirectoryConfig(const UpdateDirectoryConfigRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an UpdateDirectoryConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified directory

[slot] UpdateFleetResponse *AppStreamClient::updateFleet(const UpdateFleetRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an UpdateFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified

fleet>

If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code> and <code>ComputeCapacity</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update

[slot] UpdateStackResponse *AppStreamClient::updateStack(const UpdateStackRequest &request)

Sends request to the AppStreamClient service, and returns a pointer to an UpdateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified