NAME

Paws::DeviceFarm - Perl Interface to AWS AWS Device Farm

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DeviceFarm');
  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

AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

METHODS

CreateDevicePool(Name => Str, ProjectArn => Str, Rules => ArrayRef[Paws::DeviceFarm::Rule], [Description => Str])

Each argument is described in detail in: Paws::DeviceFarm::CreateDevicePool

Returns: a Paws::DeviceFarm::CreateDevicePoolResult instance

  Creates a device pool.

CreateProject(Name => Str)

Each argument is described in detail in: Paws::DeviceFarm::CreateProject

Returns: a Paws::DeviceFarm::CreateProjectResult instance

  Creates a new project.

CreateRemoteAccessSession(DeviceArn => Str, ProjectArn => Str, [Configuration => Paws::DeviceFarm::CreateRemoteAccessSessionConfiguration, Name => Str])

Each argument is described in detail in: Paws::DeviceFarm::CreateRemoteAccessSession

Returns: a Paws::DeviceFarm::CreateRemoteAccessSessionResult instance

  Specifies and starts a remote access session.

CreateUpload(Name => Str, ProjectArn => Str, Type => Str, [ContentType => Str])

Each argument is described in detail in: Paws::DeviceFarm::CreateUpload

Returns: a Paws::DeviceFarm::CreateUploadResult instance

  Uploads an app or test scripts.

DeleteDevicePool(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::DeleteDevicePool

Returns: a Paws::DeviceFarm::DeleteDevicePoolResult instance

  Deletes a device pool given the pool ARN. Does not allow deletion of
curated pools owned by the system.

DeleteProject(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::DeleteProject

Returns: a Paws::DeviceFarm::DeleteProjectResult instance

  Deletes an AWS Device Farm project, given the project ARN.

Note Deleting this resource does not stop an in-progress run.

DeleteRemoteAccessSession(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::DeleteRemoteAccessSession

Returns: a Paws::DeviceFarm::DeleteRemoteAccessSessionResult instance

  Deletes a completed remote access session and its results.

DeleteRun(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::DeleteRun

Returns: a Paws::DeviceFarm::DeleteRunResult instance

  Deletes the run, given the run ARN.

Note Deleting this resource does not stop an in-progress run.

DeleteUpload(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::DeleteUpload

Returns: a Paws::DeviceFarm::DeleteUploadResult instance

  Deletes an upload given the upload ARN.

GetAccountSettings()

Each argument is described in detail in: Paws::DeviceFarm::GetAccountSettings

Returns: a Paws::DeviceFarm::GetAccountSettingsResult instance

  Returns the number of unmetered iOS and/or unmetered Android devices
that have been purchased by the account.

GetDevice(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetDevice

Returns: a Paws::DeviceFarm::GetDeviceResult instance

  Gets information about a unique device type.

GetDevicePool(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetDevicePool

Returns: a Paws::DeviceFarm::GetDevicePoolResult instance

  Gets information about a device pool.

GetDevicePoolCompatibility(DevicePoolArn => Str, [AppArn => Str, TestType => Str])

Each argument is described in detail in: Paws::DeviceFarm::GetDevicePoolCompatibility

Returns: a Paws::DeviceFarm::GetDevicePoolCompatibilityResult instance

  Gets information about compatibility with a device pool.

GetJob(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetJob

Returns: a Paws::DeviceFarm::GetJobResult instance

  Gets information about a job.

GetOfferingStatus([NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::GetOfferingStatus

Returns: a Paws::DeviceFarm::GetOfferingStatusResult instance

  Gets the current status and future status of all offerings purchased by
an AWS account. The response indicates how many offerings are currently
available and the offerings that will be available in the next period.
The API returns a C<NotEligible> error if the user is not permitted to
invoke the operation. Please contact aws-devicefarm-support@amazon.com
if you believe that you should be able to invoke this operation.

GetProject(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetProject

Returns: a Paws::DeviceFarm::GetProjectResult instance

  Gets information about a project.

GetRemoteAccessSession(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetRemoteAccessSession

Returns: a Paws::DeviceFarm::GetRemoteAccessSessionResult instance

  Returns a link to a currently running remote access session.

GetRun(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetRun

Returns: a Paws::DeviceFarm::GetRunResult instance

  Gets information about a run.

GetSuite(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetSuite

Returns: a Paws::DeviceFarm::GetSuiteResult instance

  Gets information about a suite.

GetTest(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetTest

Returns: a Paws::DeviceFarm::GetTestResult instance

  Gets information about a test.

GetUpload(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::GetUpload

Returns: a Paws::DeviceFarm::GetUploadResult instance

  Gets information about an upload.

InstallToRemoteAccessSession(AppArn => Str, RemoteAccessSessionArn => Str)

Each argument is described in detail in: Paws::DeviceFarm::InstallToRemoteAccessSession

Returns: a Paws::DeviceFarm::InstallToRemoteAccessSessionResult instance

  Installs an application to the device in a remote access session. For
Android applications, the file must be in .apk format. For iOS
applications, the file must be in .ipa format.

ListArtifacts(Arn => Str, Type => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListArtifacts

Returns: a Paws::DeviceFarm::ListArtifactsResult instance

  Gets information about artifacts.

ListDevicePools(Arn => Str, [NextToken => Str, Type => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListDevicePools

Returns: a Paws::DeviceFarm::ListDevicePoolsResult instance

  Gets information about device pools.

ListDevices([Arn => Str, NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListDevices

Returns: a Paws::DeviceFarm::ListDevicesResult instance

  Gets information about unique device types.

ListJobs(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListJobs

Returns: a Paws::DeviceFarm::ListJobsResult instance

  Gets information about jobs.

ListOfferings([NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListOfferings

Returns: a Paws::DeviceFarm::ListOfferingsResult instance

  Returns a list of products or offerings that the user can manage
through the API. Each offering record indicates the recurring price per
unit and the frequency for that offering. The API returns a
C<NotEligible> error if the user is not permitted to invoke the
operation. Please contact aws-devicefarm-support@amazon.com if you
believe that you should be able to invoke this operation.

ListOfferingTransactions([NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListOfferingTransactions

Returns: a Paws::DeviceFarm::ListOfferingTransactionsResult instance

  Returns a list of all historical purchases, renewals, and system
renewal transactions for an AWS account. The list is paginated and
ordered by a descending timestamp (most recent transactions are first).
The API returns a C<NotEligible> error if the user is not permitted to
invoke the operation. Please contact aws-devicefarm-support@amazon.com
if you believe that you should be able to invoke this operation.

ListProjects([Arn => Str, NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListProjects

Returns: a Paws::DeviceFarm::ListProjectsResult instance

  Gets information about projects.

ListRemoteAccessSessions(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListRemoteAccessSessions

Returns: a Paws::DeviceFarm::ListRemoteAccessSessionsResult instance

  Returns a list of all currently running remote access sessions.

ListRuns(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListRuns

Returns: a Paws::DeviceFarm::ListRunsResult instance

  Gets information about runs, given an AWS Device Farm project ARN.

ListSamples(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListSamples

Returns: a Paws::DeviceFarm::ListSamplesResult instance

  Gets information about samples, given an AWS Device Farm project ARN

ListSuites(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListSuites

Returns: a Paws::DeviceFarm::ListSuitesResult instance

  Gets information about suites.

ListTests(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListTests

Returns: a Paws::DeviceFarm::ListTestsResult instance

  Gets information about tests.

ListUniqueProblems(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListUniqueProblems

Returns: a Paws::DeviceFarm::ListUniqueProblemsResult instance

  Gets information about unique problems.

ListUploads(Arn => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DeviceFarm::ListUploads

Returns: a Paws::DeviceFarm::ListUploadsResult instance

  Gets information about uploads, given an AWS Device Farm project ARN.

PurchaseOffering([OfferingId => Str, Quantity => Int])

Each argument is described in detail in: Paws::DeviceFarm::PurchaseOffering

Returns: a Paws::DeviceFarm::PurchaseOfferingResult instance

  Immediately purchases offerings for an AWS account. Offerings renew
with the latest total purchased quantity for an offering, unless the
renewal was overridden. The API returns a C<NotEligible> error if the
user is not permitted to invoke the operation. Please contact
aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.

RenewOffering([OfferingId => Str, Quantity => Int])

Each argument is described in detail in: Paws::DeviceFarm::RenewOffering

Returns: a Paws::DeviceFarm::RenewOfferingResult instance

  Explicitly sets the quantity of devices to renew for an offering,
starting from the C<effectiveDate> of the next period. The API returns
a C<NotEligible> error if the user is not permitted to invoke the
operation. Please contact aws-devicefarm-support@amazon.com if you
believe that you should be able to invoke this operation.

ScheduleRun(DevicePoolArn => Str, ProjectArn => Str, Test => Paws::DeviceFarm::ScheduleRunTest, [AppArn => Str, Configuration => Paws::DeviceFarm::ScheduleRunConfiguration, Name => Str])

Each argument is described in detail in: Paws::DeviceFarm::ScheduleRun

Returns: a Paws::DeviceFarm::ScheduleRunResult instance

  Schedules a run.

StopRemoteAccessSession(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::StopRemoteAccessSession

Returns: a Paws::DeviceFarm::StopRemoteAccessSessionResult instance

  Ends a specified remote access session.

StopRun(Arn => Str)

Each argument is described in detail in: Paws::DeviceFarm::StopRun

Returns: a Paws::DeviceFarm::StopRunResult instance

  Initiates a stop request for the current test run. AWS Device Farm will
immediately stop the run on devices where tests have not started
executing, and you will not be billed for these devices. On devices
where tests have started executing, Setup Suite and Teardown Suite
tests will run to completion before stopping execution on those
devices. You will be billed for Setup, Teardown, and any tests that
were in progress or already completed.

UpdateDevicePool(Arn => Str, [Description => Str, Name => Str, Rules => ArrayRef[Paws::DeviceFarm::Rule]])

Each argument is described in detail in: Paws::DeviceFarm::UpdateDevicePool

Returns: a Paws::DeviceFarm::UpdateDevicePoolResult instance

  Modifies the name, description, and rules in a device pool given the
attributes and the pool ARN. Rule updates are all-or-nothing, meaning
they can only be updated as a whole (or not at all).

UpdateProject(Arn => Str, [Name => Str])

Each argument is described in detail in: Paws::DeviceFarm::UpdateProject

Returns: a Paws::DeviceFarm::UpdateProjectResult instance

  Modifies the specified project name, given the project ARN and a new
name.

PAGINATORS

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

GetAllOfferingStatus(sub { },[NextToken => Str])

GetAllOfferingStatus([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - current, passing the object as the first parameter, and the string 'current' as the second parameter 

 - nextPeriod, passing the object as the first parameter, and the string 'nextPeriod' as the second parameter 

If not, it will return a a Paws::DeviceFarm::GetOfferingStatusResult instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllArtifacts(sub { },Arn => Str, Type => Str, [NextToken => Str])

ListAllArtifacts(Arn => Str, Type => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - artifacts, passing the object as the first parameter, and the string 'artifacts' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListArtifactsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDevicePools(sub { },Arn => Str, [NextToken => Str, Type => Str])

ListAllDevicePools(Arn => Str, [NextToken => Str, Type => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - devicePools, passing the object as the first parameter, and the string 'devicePools' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListDevicePoolsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDevices(sub { },[Arn => Str, NextToken => Str])

ListAllDevices([Arn => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - devices, passing the object as the first parameter, and the string 'devices' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListDevicesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobs(sub { },Arn => Str, [NextToken => Str])

ListAllJobs(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - jobs, passing the object as the first parameter, and the string 'jobs' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListJobsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOfferings(sub { },[NextToken => Str])

ListAllOfferings([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - offerings, passing the object as the first parameter, and the string 'offerings' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListOfferingsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOfferingTransactions(sub { },[NextToken => Str])

ListAllOfferingTransactions([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - offeringTransactions, passing the object as the first parameter, and the string 'offeringTransactions' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListOfferingTransactionsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[Arn => Str, NextToken => Str])

ListAllProjects([Arn => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - projects, passing the object as the first parameter, and the string 'projects' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListProjectsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRuns(sub { },Arn => Str, [NextToken => Str])

ListAllRuns(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - runs, passing the object as the first parameter, and the string 'runs' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListRunsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSamples(sub { },Arn => Str, [NextToken => Str])

ListAllSamples(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - samples, passing the object as the first parameter, and the string 'samples' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListSamplesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSuites(sub { },Arn => Str, [NextToken => Str])

ListAllSuites(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - suites, passing the object as the first parameter, and the string 'suites' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListSuitesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTests(sub { },Arn => Str, [NextToken => Str])

ListAllTests(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - tests, passing the object as the first parameter, and the string 'tests' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListTestsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUniqueProblems(sub { },Arn => Str, [NextToken => Str])

ListAllUniqueProblems(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - uniqueProblems, passing the object as the first parameter, and the string 'uniqueProblems' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListUniqueProblemsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUploads(sub { },Arn => Str, [NextToken => Str])

ListAllUploads(Arn => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - uploads, passing the object as the first parameter, and the string 'uploads' as the second parameter 

If not, it will return a a Paws::DeviceFarm::ListUploadsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config