NAME

Paws::AppStream - Perl Interface to AWS Amazon AppStream

SYNOPSIS

use Paws;

my $obj = Paws->service('AppStream');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon AppStream 2.0

You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.

For the AWS API documentation, see https://aws.amazon.com/documentation/

METHODS

AssociateFleet

FleetName => Str
StackName => Str

Each argument is described in detail in: Paws::AppStream::AssociateFleet

Returns: a Paws::AppStream::AssociateFleetResult instance

Associates the specified fleet with the specified stack.

CopyImage

DestinationImageName => Str
DestinationRegion => Str
SourceImageName => Str
[DestinationImageDescription => Str]

Each argument is described in detail in: Paws::AppStream::CopyImage

Returns: a Paws::AppStream::CopyImageResponse instance

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.

CreateDirectoryConfig

DirectoryName => Str
OrganizationalUnitDistinguishedNames => ArrayRef[Str|Undef]
ServiceAccountCredentials => Paws::AppStream::ServiceAccountCredentials

Each argument is described in detail in: Paws::AppStream::CreateDirectoryConfig

Returns: a Paws::AppStream::CreateDirectoryConfigResult instance

Creates a directory configuration.

CreateFleet

ComputeCapacity => Paws::AppStream::ComputeCapacity
ImageName => Str
InstanceType => Str
Name => Str
[Description => Str]
[DisconnectTimeoutInSeconds => Int]
[DisplayName => Str]
[DomainJoinInfo => Paws::AppStream::DomainJoinInfo]
[EnableDefaultInternetAccess => Bool]
[FleetType => Str]
[MaxUserDurationInSeconds => Int]
[VpcConfig => Paws::AppStream::VpcConfig]

Each argument is described in detail in: Paws::AppStream::CreateFleet

Returns: a Paws::AppStream::CreateFleetResult instance

Creates a fleet.

CreateImageBuilder

ImageName => Str
InstanceType => Str
Name => Str
[AppstreamAgentVersion => Str]
[Description => Str]
[DisplayName => Str]
[DomainJoinInfo => Paws::AppStream::DomainJoinInfo]
[EnableDefaultInternetAccess => Bool]
[VpcConfig => Paws::AppStream::VpcConfig]

Each argument is described in detail in: Paws::AppStream::CreateImageBuilder

Returns: a Paws::AppStream::CreateImageBuilderResult instance

Creates an image builder.

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

CreateImageBuilderStreamingURL

Name => Str
[Validity => Int]

Each argument is described in detail in: Paws::AppStream::CreateImageBuilderStreamingURL

Returns: a Paws::AppStream::CreateImageBuilderStreamingURLResult instance

Creates a URL to start an image builder streaming session.

CreateStack

Name => Str
[Description => Str]
[DisplayName => Str]
[FeedbackURL => Str]
[RedirectURL => Str]
[StorageConnectors => ArrayRef[Paws::AppStream::StorageConnector]]
[UserSettings => ArrayRef[Paws::AppStream::UserSetting]]

Each argument is described in detail in: Paws::AppStream::CreateStack

Returns: a Paws::AppStream::CreateStackResult instance

Creates a stack.

CreateStreamingURL

FleetName => Str
StackName => Str
UserId => Str
[ApplicationId => Str]
[SessionContext => Str]
[Validity => Int]

Each argument is described in detail in: Paws::AppStream::CreateStreamingURL

Returns: a Paws::AppStream::CreateStreamingURLResult instance

Creates a URL to start a streaming session for the specified user.

DeleteDirectoryConfig

DirectoryName => Str

Each argument is described in detail in: Paws::AppStream::DeleteDirectoryConfig

Returns: a Paws::AppStream::DeleteDirectoryConfigResult instance

Deletes the specified directory configuration.

DeleteFleet

Name => Str

Each argument is described in detail in: Paws::AppStream::DeleteFleet

Returns: a Paws::AppStream::DeleteFleetResult instance

Deletes the specified fleet.

DeleteImage

Name => Str

Each argument is described in detail in: Paws::AppStream::DeleteImage

Returns: a Paws::AppStream::DeleteImageResult instance

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

DeleteImageBuilder

Name => Str

Each argument is described in detail in: Paws::AppStream::DeleteImageBuilder

Returns: a Paws::AppStream::DeleteImageBuilderResult instance

Deletes the specified image builder and releases the capacity.

DeleteStack

Name => Str

Each argument is described in detail in: Paws::AppStream::DeleteStack

Returns: a Paws::AppStream::DeleteStackResult instance

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

DescribeDirectoryConfigs

[DirectoryNames => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::DescribeDirectoryConfigs

Returns: a Paws::AppStream::DescribeDirectoryConfigsResult instance

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.

DescribeFleets

[Names => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::DescribeFleets

Returns: a Paws::AppStream::DescribeFleetsResult instance

Describes the specified fleets or all fleets in the account.

DescribeImageBuilders

[MaxResults => Int]
[Names => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::DescribeImageBuilders

Returns: a Paws::AppStream::DescribeImageBuildersResult instance

Describes the specified image builders or all image builders in the account.

DescribeImages

[Names => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::AppStream::DescribeImages

Returns: a Paws::AppStream::DescribeImagesResult instance

Describes the specified images or all images in the account.

DescribeSessions

FleetName => Str
StackName => Str
[AuthenticationType => Str]
[Limit => Int]
[NextToken => Str]
[UserId => Str]

Each argument is described in detail in: Paws::AppStream::DescribeSessions

Returns: a Paws::AppStream::DescribeSessionsResult instance

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

DescribeStacks

[Names => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::DescribeStacks

Returns: a Paws::AppStream::DescribeStacksResult instance

Describes the specified stacks or all stacks in the account.

DisassociateFleet

FleetName => Str
StackName => Str

Each argument is described in detail in: Paws::AppStream::DisassociateFleet

Returns: a Paws::AppStream::DisassociateFleetResult instance

Disassociates the specified fleet from the specified stack.

ExpireSession

SessionId => Str

Each argument is described in detail in: Paws::AppStream::ExpireSession

Returns: a Paws::AppStream::ExpireSessionResult instance

Stops the specified streaming session.

ListAssociatedFleets

StackName => Str
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::ListAssociatedFleets

Returns: a Paws::AppStream::ListAssociatedFleetsResult instance

Lists the fleets associated with the specified stack.

ListAssociatedStacks

FleetName => Str
[NextToken => Str]

Each argument is described in detail in: Paws::AppStream::ListAssociatedStacks

Returns: a Paws::AppStream::ListAssociatedStacksResult instance

Lists the stacks associated with the specified fleet.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::AppStream::ListTagsForResource

Returns: a Paws::AppStream::ListTagsForResourceResponse instance

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 Tagging Your Resources (http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Developer Guide.

StartFleet

Name => Str

Each argument is described in detail in: Paws::AppStream::StartFleet

Returns: a Paws::AppStream::StartFleetResult instance

Starts the specified fleet.

StartImageBuilder

Name => Str
[AppstreamAgentVersion => Str]

Each argument is described in detail in: Paws::AppStream::StartImageBuilder

Returns: a Paws::AppStream::StartImageBuilderResult instance

Starts the specified image builder.

StopFleet

Name => Str

Each argument is described in detail in: Paws::AppStream::StopFleet

Returns: a Paws::AppStream::StopFleetResult instance

Stops the specified fleet.

StopImageBuilder

Name => Str

Each argument is described in detail in: Paws::AppStream::StopImageBuilder

Returns: a Paws::AppStream::StopImageBuilderResult instance

Stops the specified image builder.

TagResource

ResourceArn => Str
Tags => Paws::AppStream::Tags

Each argument is described in detail in: Paws::AppStream::TagResource

Returns: a Paws::AppStream::TagResourceResponse instance

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 (http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Developer Guide.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AppStream::UntagResource

Returns: a Paws::AppStream::UntagResourceResponse instance

Disassociates the 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 (http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Developer Guide.

UpdateDirectoryConfig

DirectoryName => Str
[OrganizationalUnitDistinguishedNames => ArrayRef[Str|Undef]]
[ServiceAccountCredentials => Paws::AppStream::ServiceAccountCredentials]

Each argument is described in detail in: Paws::AppStream::UpdateDirectoryConfig

Returns: a Paws::AppStream::UpdateDirectoryConfigResult instance

Updates the specified directory configuration.

UpdateFleet

Name => Str
[AttributesToDelete => ArrayRef[Str|Undef]]
[ComputeCapacity => Paws::AppStream::ComputeCapacity]
[DeleteVpcConfig => Bool]
[Description => Str]
[DisconnectTimeoutInSeconds => Int]
[DisplayName => Str]
[DomainJoinInfo => Paws::AppStream::DomainJoinInfo]
[EnableDefaultInternetAccess => Bool]
[ImageName => Str]
[InstanceType => Str]
[MaxUserDurationInSeconds => Int]
[VpcConfig => Paws::AppStream::VpcConfig]

Each argument is described in detail in: Paws::AppStream::UpdateFleet

Returns: a Paws::AppStream::UpdateFleetResult instance

Updates the specified fleet.

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

UpdateStack

Name => Str
[AttributesToDelete => ArrayRef[Str|Undef]]
[DeleteStorageConnectors => Bool]
[Description => Str]
[DisplayName => Str]
[FeedbackURL => Str]
[RedirectURL => Str]
[StorageConnectors => ArrayRef[Paws::AppStream::StorageConnector]]
[UserSettings => ArrayRef[Paws::AppStream::UserSetting]]

Each argument is described in detail in: Paws::AppStream::UpdateStack

Returns: a Paws::AppStream::UpdateStackResult instance

Updates the specified stack.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues