Paws

 view release on metacpan or  search on metacpan

lib/Paws/AppStream.pm  view on Meta::CPAN

    return undef
  }
  sub ListAllAssociatedStacks {
    my $self = shift;

    my $callback = shift @_ if (ref($_[0]) eq 'CODE');
    my $result = $self->ListAssociatedStacks(@_);
    my $next_result = $result;

    if (not defined $callback) {
      while ($next_result->NextToken) {
        $next_result = $self->ListAssociatedStacks(@_, NextToken => $next_result->NextToken);
        push @{ $result->Names }, @{ $next_result->Names };
      }
      return $result;
    } else {
      while ($result->NextToken) {
        $callback->($_ => 'Names') foreach (@{ $result->Names });
        $result = $self->ListAssociatedStacks(@_, NextToken => $result->NextToken);
      }
      $callback->($_ => 'Names') foreach (@{ $result->Names });
    }

    return undef
  }


  sub operations { qw/AssociateFleet BatchAssociateUserStack BatchDisassociateUserStack CopyImage CreateDirectoryConfig CreateFleet CreateImageBuilder CreateImageBuilderStreamingURL CreateStack CreateStreamingURL CreateUpdatedImage CreateUsageReportS...

1;

### main pod documentation begin ###

=head1 NAME

Paws::AppStream - Perl Interface to AWS Amazon AppStream

=head1 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' } ],
  );

=head1 DESCRIPTION

Amazon AppStream 2.0

This is the I<Amazon AppStream 2.0 API Reference>. This documentation
provides descriptions and syntax for each of the actions and data types
in AppStream 2.0. AppStream 2.0 is a fully managed, secure application
streaming service that lets you stream desktop applications to users
without rewriting applications. AppStream 2.0 manages the AWS resources
that are required to host and run your applications, scales
automatically, and provides access to your users on demand.

You can call the AppStream 2.0 API operations by using an interface VPC
endpoint (interface endpoint). For more information, see Access
AppStream 2.0 API Operations and CLI Commands Through an Interface VPC
Endpoint
(https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html)
in the I<Amazon AppStream 2.0 Administration Guide>.

To learn more about AppStream 2.0, see the following resources:

=over

=item *

Amazon AppStream 2.0 product page (http://aws.amazon.com/appstream2)

=item *

Amazon AppStream 2.0 documentation
(http://aws.amazon.com/documentation/appstream2)

=back


For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appstream2-2016-12-01>


=head1 METHODS

=head2 AssociateFleet

=over

=item FleetName => Str

=item StackName => Str


=back

Each argument is described in detail in: L<Paws::AppStream::AssociateFleet>

Returns: a L<Paws::AppStream::AssociateFleetResult> instance

Associates the specified fleet with the specified stack.


=head2 BatchAssociateUserStack

=over

=item UserStackAssociations => ArrayRef[L<Paws::AppStream::UserStackAssociation>]


=back

Each argument is described in detail in: L<Paws::AppStream::BatchAssociateUserStack>

lib/Paws/AppStream.pm  view on Meta::CPAN


=item [ServiceAccountCredentials => L<Paws::AppStream::ServiceAccountCredentials>]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateDirectoryConfig>

Returns: a L<Paws::AppStream::CreateDirectoryConfigResult> instance

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


=head2 CreateFleet

=over

=item ComputeCapacity => L<Paws::AppStream::ComputeCapacity>

=item InstanceType => Str

=item Name => Str

=item [Description => Str]

=item [DisconnectTimeoutInSeconds => Int]

=item [DisplayName => Str]

=item [DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo>]

=item [EnableDefaultInternetAccess => Bool]

=item [FleetType => Str]

=item [IamRoleArn => Str]

=item [IdleDisconnectTimeoutInSeconds => Int]

=item [ImageArn => Str]

=item [ImageName => Str]

=item [MaxUserDurationInSeconds => Int]

=item [StreamView => Str]

=item [Tags => L<Paws::AppStream::Tags>]

=item [VpcConfig => L<Paws::AppStream::VpcConfig>]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateFleet>

Returns: a L<Paws::AppStream::CreateFleetResult> instance

Creates a fleet. A fleet consists of streaming instances that run a
specified image.


=head2 CreateImageBuilder

=over

=item InstanceType => Str

=item Name => Str

=item [AccessEndpoints => ArrayRef[L<Paws::AppStream::AccessEndpoint>]]

=item [AppstreamAgentVersion => Str]

=item [Description => Str]

=item [DisplayName => Str]

=item [DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo>]

=item [EnableDefaultInternetAccess => Bool]

=item [IamRoleArn => Str]

=item [ImageArn => Str]

=item [ImageName => Str]

=item [Tags => L<Paws::AppStream::Tags>]

=item [VpcConfig => L<Paws::AppStream::VpcConfig>]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateImageBuilder>

Returns: a L<Paws::AppStream::CreateImageBuilderResult> instance

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

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


=head2 CreateImageBuilderStreamingURL

=over

=item Name => Str

=item [Validity => Int]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateImageBuilderStreamingURL>

Returns: a L<Paws::AppStream::CreateImageBuilderStreamingURLResult> instance

Creates a URL to start an image builder streaming session.


=head2 CreateStack

=over

=item Name => Str

=item [AccessEndpoints => ArrayRef[L<Paws::AppStream::AccessEndpoint>]]

=item [ApplicationSettings => L<Paws::AppStream::ApplicationSettings>]

=item [Description => Str]

=item [DisplayName => Str]

=item [EmbedHostDomains => ArrayRef[Str|Undef]]

=item [FeedbackURL => Str]

=item [RedirectURL => Str]

=item [StorageConnectors => ArrayRef[L<Paws::AppStream::StorageConnector>]]

=item [Tags => L<Paws::AppStream::Tags>]

=item [UserSettings => ArrayRef[L<Paws::AppStream::UserSetting>]]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateStack>

Returns: a L<Paws::AppStream::CreateStackResult> instance

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


=head2 CreateStreamingURL

=over

=item FleetName => Str

=item StackName => Str

=item UserId => Str

=item [ApplicationId => Str]

=item [SessionContext => Str]

=item [Validity => Int]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateStreamingURL>

Returns: a L<Paws::AppStream::CreateStreamingURLResult> instance

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


=head2 CreateUpdatedImage

=over

=item ExistingImageName => Str

=item NewImageName => Str

=item [DryRun => Bool]

=item [NewImageDescription => Str]

=item [NewImageDisplayName => Str]

=item [NewImageTags => L<Paws::AppStream::Tags>]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateUpdatedImage>

Returns: a L<Paws::AppStream::CreateUpdatedImageResult> instance

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

For more information, see the "Update an Image by Using Managed
AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0
Images
(https://docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html),
in the I<Amazon AppStream 2.0 Administration Guide>.


=head2 CreateUsageReportSubscription






Each argument is described in detail in: L<Paws::AppStream::CreateUsageReportSubscription>

Returns: a L<Paws::AppStream::CreateUsageReportSubscriptionResult> instance

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


=head2 CreateUser

=over

=item AuthenticationType => Str

=item UserName => Str

=item [FirstName => Str]

=item [LastName => Str]

=item [MessageAction => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::CreateUser>

Returns: a L<Paws::AppStream::CreateUserResult> instance

Creates a new user in the user pool.


=head2 DeleteDirectoryConfig

=over

=item DirectoryName => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteDirectoryConfig>

Returns: a L<Paws::AppStream::DeleteDirectoryConfigResult> instance

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


=head2 DeleteFleet

=over

=item Name => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteFleet>

Returns: a L<Paws::AppStream::DeleteFleetResult> instance

Deletes the specified fleet.


=head2 DeleteImage

=over

=item Name => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteImage>

Returns: a L<Paws::AppStream::DeleteImageResult> instance

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


=head2 DeleteImageBuilder

=over

=item Name => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteImageBuilder>

Returns: a L<Paws::AppStream::DeleteImageBuilderResult> instance

Deletes the specified image builder and releases the capacity.


=head2 DeleteImagePermissions

=over

=item Name => Str

=item SharedAccountId => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteImagePermissions>

Returns: a L<Paws::AppStream::DeleteImagePermissionsResult> instance

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


=head2 DeleteStack

=over

=item Name => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteStack>

Returns: a L<Paws::AppStream::DeleteStackResult> instance

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


=head2 DeleteUsageReportSubscription






Each argument is described in detail in: L<Paws::AppStream::DeleteUsageReportSubscription>

Returns: a L<Paws::AppStream::DeleteUsageReportSubscriptionResult> instance

Disables usage report generation.


=head2 DeleteUser

=over

=item AuthenticationType => Str

=item UserName => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DeleteUser>

Returns: a L<Paws::AppStream::DeleteUserResult> instance

Deletes a user from the user pool.


=head2 DescribeDirectoryConfigs

=over

=item [DirectoryNames => ArrayRef[Str|Undef]]

=item [MaxResults => Int]

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeDirectoryConfigs>

Returns: a L<Paws::AppStream::DescribeDirectoryConfigsResult> instance

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

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

lib/Paws/AppStream.pm  view on Meta::CPAN


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeImagePermissions>

Returns: a L<Paws::AppStream::DescribeImagePermissionsResult> instance

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


=head2 DescribeImages

=over

=item [Arns => ArrayRef[Str|Undef]]

=item [MaxResults => Int]

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

=item [NextToken => Str]

=item [Type => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeImages>

Returns: a L<Paws::AppStream::DescribeImagesResult> instance

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


=head2 DescribeSessions

=over

=item FleetName => Str

=item StackName => Str

=item [AuthenticationType => Str]

=item [Limit => Int]

=item [NextToken => Str]

=item [UserId => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeSessions>

Returns: a L<Paws::AppStream::DescribeSessionsResult> instance

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


=head2 DescribeStacks

=over

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

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeStacks>

Returns: a L<Paws::AppStream::DescribeStacksResult> instance

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


=head2 DescribeUsageReportSubscriptions

=over

=item [MaxResults => Int]

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeUsageReportSubscriptions>

Returns: a L<Paws::AppStream::DescribeUsageReportSubscriptionsResult> instance

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


=head2 DescribeUsers

=over

=item AuthenticationType => Str

=item [MaxResults => Int]

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::DescribeUsers>

Returns: a L<Paws::AppStream::DescribeUsersResult> instance

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

lib/Paws/AppStream.pm  view on Meta::CPAN

Each argument is described in detail in: L<Paws::AppStream::DisableUser>

Returns: a L<Paws::AppStream::DisableUserResult> instance

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


=head2 DisassociateFleet

=over

=item FleetName => Str

=item StackName => Str


=back

Each argument is described in detail in: L<Paws::AppStream::DisassociateFleet>

Returns: a L<Paws::AppStream::DisassociateFleetResult> instance

Disassociates the specified fleet from the specified stack.


=head2 EnableUser

=over

=item AuthenticationType => Str

=item UserName => Str


=back

Each argument is described in detail in: L<Paws::AppStream::EnableUser>

Returns: a L<Paws::AppStream::EnableUserResult> instance

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


=head2 ExpireSession

=over

=item SessionId => Str


=back

Each argument is described in detail in: L<Paws::AppStream::ExpireSession>

Returns: a L<Paws::AppStream::ExpireSessionResult> instance

Immediately stops the specified streaming session.


=head2 ListAssociatedFleets

=over

=item StackName => Str

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::ListAssociatedFleets>

Returns: a L<Paws::AppStream::ListAssociatedFleetsResult> instance

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


=head2 ListAssociatedStacks

=over

=item FleetName => Str

=item [NextToken => Str]


=back

Each argument is described in detail in: L<Paws::AppStream::ListAssociatedStacks>

Returns: a L<Paws::AppStream::ListAssociatedStacksResult> instance

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


=head2 ListTagsForResource

=over

=item ResourceArn => Str


=back

Each argument is described in detail in: L<Paws::AppStream::ListTagsForResource>

Returns: a L<Paws::AppStream::ListTagsForResourceResponse> instance

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

For more information about tags, see Tagging Your Resources
(https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html)
in the I<Amazon AppStream 2.0 Administration Guide>.



( run in 1.240 second using v1.01-cache-2.11-cpan-140bd7fdf52 )