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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23

METHODS

CreateDevicePool

Name => Str
ProjectArn => Str
Rules => ArrayRef[Paws::DeviceFarm::Rule]
[Description => Str]
[MaxDevices => Int]

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

Returns: a Paws::DeviceFarm::CreateDevicePoolResult instance

Creates a device pool.

CreateInstanceProfile

Name => Str
[Description => Str]
[ExcludeAppPackagesFromCleanup => ArrayRef[Str|Undef]]
[PackageCleanup => Bool]
[RebootAfterUse => Bool]

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

Returns: a Paws::DeviceFarm::CreateInstanceProfileResult instance

Creates a profile that can be applied to one or more private fleet device instances.

CreateNetworkProfile

Name => Str
ProjectArn => Str
[Description => Str]
[DownlinkBandwidthBits => Int]
[DownlinkDelayMs => Int]
[DownlinkJitterMs => Int]
[DownlinkLossPercent => Int]
[Type => Str]
[UplinkBandwidthBits => Int]
[UplinkDelayMs => Int]
[UplinkJitterMs => Int]
[UplinkLossPercent => Int]

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

Returns: a Paws::DeviceFarm::CreateNetworkProfileResult instance

Creates a network profile.

CreateProject

Name => Str
[DefaultJobTimeoutMinutes => Int]

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
[ClientId => Str]
[Configuration => Paws::DeviceFarm::CreateRemoteAccessSessionConfiguration]
[InstanceArn => Str]
[InteractionMode => Str]
[Name => Str]
[RemoteDebugEnabled => Bool]
[RemoteRecordAppArn => Str]
[RemoteRecordEnabled => Bool]
[SkipAppResign => Bool]
[SshPublicKey => 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.

CreateVPCEConfiguration

ServiceDnsName => Str
VpceConfigurationName => Str
VpceServiceName => Str
[VpceConfigurationDescription => Str]

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

Returns: a Paws::DeviceFarm::CreateVPCEConfigurationResult instance

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

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.

DeleteInstanceProfile

Arn => Str

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

Returns: a Paws::DeviceFarm::DeleteInstanceProfileResult instance

Deletes a profile that can be applied to one or more private device instances.

DeleteNetworkProfile

Arn => Str

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

Returns: a Paws::DeviceFarm::DeleteNetworkProfileResult instance

Deletes a network profile.

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.

DeleteVPCEConfiguration

Arn => Str

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

Returns: a Paws::DeviceFarm::DeleteVPCEConfigurationResult instance

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

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.

GetDeviceInstance

Arn => Str

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

Returns: a Paws::DeviceFarm::GetDeviceInstanceResult instance

Returns information about a device instance belonging to a private device fleet.

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]
[Configuration => Paws::DeviceFarm::ScheduleRunConfiguration]
[Test => Paws::DeviceFarm::ScheduleRunTest]
[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.

GetInstanceProfile

Arn => Str

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

Returns: a Paws::DeviceFarm::GetInstanceProfileResult instance

Returns information about the specified instance profile.

GetJob

Arn => Str

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

Returns: a Paws::DeviceFarm::GetJobResult instance

Gets information about a job.

GetNetworkProfile

Arn => Str

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

Returns: a Paws::DeviceFarm::GetNetworkProfileResult instance

Returns information about a network profile.

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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com (mailto: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.

GetVPCEConfiguration

Arn => Str

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

Returns: a Paws::DeviceFarm::GetVPCEConfigurationResult instance

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

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.

ListDeviceInstances

[MaxResults => Int]
[NextToken => Str]

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

Returns: a Paws::DeviceFarm::ListDeviceInstancesResult instance

Returns information about the private device instances associated with one or more AWS accounts.

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]
[Filters => ArrayRef[Paws::DeviceFarm::DeviceFilter]]
[NextToken => Str]

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

Returns: a Paws::DeviceFarm::ListDevicesResult instance

Gets information about unique device types.

ListInstanceProfiles

[MaxResults => Int]
[NextToken => Str]

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

Returns: a Paws::DeviceFarm::ListInstanceProfilesResult instance

Returns information about all the instance profiles in an AWS account.

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 for a given test run.

ListNetworkProfiles

Arn => Str
[NextToken => Str]
[Type => Str]

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

Returns: a Paws::DeviceFarm::ListNetworkProfilesResult instance

Returns the list of available network profiles.

ListOfferingPromotions

[NextToken => Str]

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

Returns: a Paws::DeviceFarm::ListOfferingPromotionsResult instance

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) if you believe that you should be able to invoke this operation.

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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com (mailto: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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com (mailto: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 job 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 test suites for a given job.

ListTagsForResource

ResourceARN => Str

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

Returns: a Paws::DeviceFarm::ListTagsForResourceResponse instance

List the tags for an AWS Device Farm resource.

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 in a given test suite.

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]
[Type => 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.

ListVPCEConfigurations

[MaxResults => Int]
[NextToken => Str]

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

Returns: a Paws::DeviceFarm::ListVPCEConfigurationsResult instance

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

PurchaseOffering

[OfferingId => Str]
[OfferingPromotionId => 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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com (mailto: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 effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) if you believe that you should be able to invoke this operation.

ScheduleRun

ProjectArn => Str
Test => Paws::DeviceFarm::ScheduleRunTest
[AppArn => Str]
[Configuration => Paws::DeviceFarm::ScheduleRunConfiguration]
[DevicePoolArn => Str]
[DeviceSelectionConfiguration => Paws::DeviceFarm::DeviceSelectionConfiguration]
[ExecutionConfiguration => Paws::DeviceFarm::ExecutionConfiguration]
[Name => Str]

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

Returns: a Paws::DeviceFarm::ScheduleRunResult instance

Schedules a run.

StopJob

Arn => Str

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

Returns: a Paws::DeviceFarm::StopJobResult instance

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

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.

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::DeviceFarm::Tag]

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

Returns: a Paws::DeviceFarm::TagResourceResponse instance

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

UntagResource

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

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

Returns: a Paws::DeviceFarm::UntagResourceResponse instance

Deletes the specified tags from a resource.

UpdateDeviceInstance

Arn => Str
[Labels => ArrayRef[Str|Undef]]
[ProfileArn => Str]

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

Returns: a Paws::DeviceFarm::UpdateDeviceInstanceResult instance

Updates information about an existing private device instance.

UpdateDevicePool

Arn => Str
[ClearMaxDevices => Bool]
[Description => Str]
[MaxDevices => Int]
[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).

UpdateInstanceProfile

Arn => Str
[Description => Str]
[ExcludeAppPackagesFromCleanup => ArrayRef[Str|Undef]]
[Name => Str]
[PackageCleanup => Bool]
[RebootAfterUse => Bool]

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

Returns: a Paws::DeviceFarm::UpdateInstanceProfileResult instance

Updates information about an existing private device instance profile.

UpdateNetworkProfile

Arn => Str
[Description => Str]
[DownlinkBandwidthBits => Int]
[DownlinkDelayMs => Int]
[DownlinkJitterMs => Int]
[DownlinkLossPercent => Int]
[Name => Str]
[Type => Str]
[UplinkBandwidthBits => Int]
[UplinkDelayMs => Int]
[UplinkJitterMs => Int]
[UplinkLossPercent => Int]

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

Returns: a Paws::DeviceFarm::UpdateNetworkProfileResult instance

Updates the network profile with specific settings.

UpdateProject

Arn => Str
[DefaultJobTimeoutMinutes => Int]
[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.

UpdateUpload

Arn => Str
[ContentType => Str]
[EditContent => Bool]
[Name => Str]

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

Returns: a Paws::DeviceFarm::UpdateUploadResult instance

Update an uploaded test specification (test spec).

UpdateVPCEConfiguration

Arn => Str
[ServiceDnsName => Str]
[VpceConfigurationDescription => Str]
[VpceConfigurationName => Str]
[VpceServiceName => Str]

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

Returns: a Paws::DeviceFarm::UpdateVPCEConfigurationResult instance

Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.

PAGINATORS

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