AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Device Farm CreateUpload API operation.

Syntax

New-DFUpload
-Name <String>
-ProjectArn <String>
-Type <UploadType>
-ContentType <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Uploads an app or test scripts.

Parameters

-ContentType <String>
The upload's content type (for example, "application/octet-stream").
Required?False
Position?4
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProjectArn <String>
The ARN of the project for the upload.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Upload'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DeviceFarm.Model.CreateUploadResponse). Specifying the name of a property of type Amazon.DeviceFarm.Model.CreateUploadResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <UploadType>
The upload's upload type.Must be one of the following values:
  • ANDROID_APP: An Android upload.
  • IOS_APP: An iOS upload.
  • WEB_APP: A web application upload.
  • EXTERNAL_DATA: An external data upload.
  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
  • APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
  • APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
  • APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
  • APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
  • CALABASH_TEST_PACKAGE: A Calabash test package upload.
  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
  • XCTEST_TEST_PACKAGE: An Xcode test package upload.
  • XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.
  • APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
  • APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
  • APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
  • APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
  • APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
  • APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
  • APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
  • APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
  • INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
  • XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.
Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
Required?True
Position?3
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Inputs

System.String
You can pipe a String object to this cmdlet for the Name parameter.

Outputs

Amazon.DeviceFarm.Model.Upload or Amazon.DeviceFarm.Model.CreateUploadResponse
This cmdlet returns an Amazon.DeviceFarm.Model.Upload object. The service call response (type Amazon.DeviceFarm.Model.CreateUploadResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\>New-DFUpload -ContentType "application/octet-stream" -ProjectArn "arn:aws:devicefarm:us-west-2:123456789012:project:EXAMPLEa-7ec1-4741-9c1f-d3e04EXAMPLE" -Name "app.apk" -Type ANDROID_APP
This example creates an AWS Device Farm upload for an Android app. You can get the project ARN from the output of New-DFProject or Get-DFProjectList. Use the signed URL in the New-DFUpload output to upload a file to Device Farm.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z