uploads

Creates, updates, deletes, gets or lists a uploads resource.

Overview

Name	uploads
Type	Resource
Id	aws.devicefarm.uploads

Fields

The following fields are returned by SELECT queries:

get_upload

Name	Datatype	Description
name	string	The upload's file name.
arn	string	The upload's ARN. (pattern: <code>^arn:aws:devicefarm:.+</code>)
category	string	The upload's category. Allowed values include: CURATED: An upload managed by AWS Device Farm. PRIVATE: An upload managed by the AWS Device Farm customer. (CURATED, PRIVATE)
content_type	string	The upload's content type (for example, application/octet-stream).
created	string (date-time)	When the upload was created.
message	string	A message about the upload's result.
metadata	string	The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
status	string	The upload's status. Must be one of the following values: FAILED INITIALIZED PROCESSING SUCCEEDED (INITIALIZED, PROCESSING, SUCCEEDED, FAILED)
type_	string	The upload's type. Must be one of the following values: ANDROID_APP IOS_APP WEB_APP EXTERNAL_DATA APPIUM_JAVA_JUNIT_TEST_PACKAGE APPIUM_JAVA_TESTNG_TEST_PACKAGE APPIUM_PYTHON_TEST_PACKAGE APPIUM_NODE_TEST_PACKAGE APPIUM_RUBY_TEST_PACKAGE APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE APPIUM_WEB_PYTHON_TEST_PACKAGE APPIUM_WEB_NODE_TEST_PACKAGE APPIUM_WEB_RUBY_TEST_PACKAGE INSTRUMENTATION_TEST_PACKAGE XCTEST_TEST_PACKAGE XCTEST_UI_TEST_PACKAGE APPIUM_JAVA_JUNIT_TEST_SPEC APPIUM_JAVA_TESTNG_TEST_SPEC APPIUM_PYTHON_TEST_SPEC APPIUM_NODE_TEST_SPEC APPIUM_RUBY_TEST_SPEC APPIUM_WEB_JAVA_JUNIT_TEST_SPEC APPIUM_WEB_JAVA_TESTNG_TEST_SPEC APPIUM_WEB_PYTHON_TEST_SPEC APPIUM_WEB_NODE_TEST_SPEC APPIUM_WEB_RUBY_TEST_SPEC INSTRUMENTATION_TEST_SPEC XCTEST_UI_TEST_SPEC (ANDROID_APP, IOS_APP, WEB_APP, EXTERNAL_DATA, APPIUM_JAVA_JUNIT_TEST_PACKAGE, APPIUM_JAVA_TESTNG_TEST_PACKAGE, APPIUM_PYTHON_TEST_PACKAGE, APPIUM_NODE_TEST_PACKAGE, APPIUM_RUBY_TEST_PACKAGE, APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE, APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE, APPIUM_WEB_PYTHON_TEST_PACKAGE, APPIUM_WEB_NODE_TEST_PACKAGE, APPIUM_WEB_RUBY_TEST_PACKAGE, CALABASH_TEST_PACKAGE, INSTRUMENTATION_TEST_PACKAGE, UIAUTOMATION_TEST_PACKAGE, UIAUTOMATOR_TEST_PACKAGE, XCTEST_TEST_PACKAGE, XCTEST_UI_TEST_PACKAGE, APPIUM_JAVA_JUNIT_TEST_SPEC, APPIUM_JAVA_TESTNG_TEST_SPEC, APPIUM_PYTHON_TEST_SPEC, APPIUM_NODE_TEST_SPEC, APPIUM_RUBY_TEST_SPEC, APPIUM_WEB_JAVA_JUNIT_TEST_SPEC, APPIUM_WEB_JAVA_TESTNG_TEST_SPEC, APPIUM_WEB_PYTHON_TEST_SPEC, APPIUM_WEB_NODE_TEST_SPEC, APPIUM_WEB_RUBY_TEST_SPEC, INSTRUMENTATION_TEST_SPEC, XCTEST_UI_TEST_SPEC)
url	string	The presigned Amazon S3 URL that was used to store a file using a PUT request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upload	select	region		Gets information about an upload.
create_upload	insert	region, projectArn, name, type		Uploads an app or test scripts.
update_upload	update	region, arn		Updates an uploaded test spec.
delete_upload	delete	region		Deletes an upload given the upload ARN.
list_uploads	exec	region, arn		Gets information about uploads, given an AWS Device Farm project ARN.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_upload

Gets information about an upload.

SELECT
name,
arn,
category,
content_type,
created,
message,
metadata,
status,
type_,
url
FROM aws.devicefarm.uploads
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_upload

Uploads an app or test scripts.

INSERT INTO aws.devicefarm.uploads (
projectArn,
name,
type,
contentType,
region
)
SELECT 
'{{ projectArn }}' /* required */,
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ contentType }}',
'{{ region }}'
RETURNING
upload
;

Manifest

# Description fields are for documentation purposes
- name: uploads
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the uploads resource.
  - name: projectArn
    value: "{{ projectArn }}"
    description: |
      The ARN of the project for the upload.
  - name: name
    value: "{{ name }}"
    description: |
      The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.
  - name: type
    value: "{{ type }}"
    description: |
      The upload's upload type. Must be one of the following values: ANDROID_APP IOS_APP WEB_APP EXTERNAL_DATA APPIUM_JAVA_JUNIT_TEST_PACKAGE APPIUM_JAVA_TESTNG_TEST_PACKAGE APPIUM_PYTHON_TEST_PACKAGE APPIUM_NODE_TEST_PACKAGE APPIUM_RUBY_TEST_PACKAGE APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE APPIUM_WEB_PYTHON_TEST_PACKAGE APPIUM_WEB_NODE_TEST_PACKAGE APPIUM_WEB_RUBY_TEST_PACKAGE INSTRUMENTATION_TEST_PACKAGE XCTEST_TEST_PACKAGE XCTEST_UI_TEST_PACKAGE APPIUM_JAVA_JUNIT_TEST_SPEC APPIUM_JAVA_TESTNG_TEST_SPEC APPIUM_PYTHON_TEST_SPEC APPIUM_NODE_TEST_SPEC APPIUM_RUBY_TEST_SPEC APPIUM_WEB_JAVA_JUNIT_TEST_SPEC APPIUM_WEB_JAVA_TESTNG_TEST_SPEC APPIUM_WEB_PYTHON_TEST_SPEC APPIUM_WEB_NODE_TEST_SPEC APPIUM_WEB_RUBY_TEST_SPEC INSTRUMENTATION_TEST_SPEC XCTEST_UI_TEST_SPEC If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
    valid_values: ['ANDROID_APP', 'IOS_APP', 'WEB_APP', 'EXTERNAL_DATA', 'APPIUM_JAVA_JUNIT_TEST_PACKAGE', 'APPIUM_JAVA_TESTNG_TEST_PACKAGE', 'APPIUM_PYTHON_TEST_PACKAGE', 'APPIUM_NODE_TEST_PACKAGE', 'APPIUM_RUBY_TEST_PACKAGE', 'APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE', 'APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE', 'APPIUM_WEB_PYTHON_TEST_PACKAGE', 'APPIUM_WEB_NODE_TEST_PACKAGE', 'APPIUM_WEB_RUBY_TEST_PACKAGE', 'CALABASH_TEST_PACKAGE', 'INSTRUMENTATION_TEST_PACKAGE', 'UIAUTOMATION_TEST_PACKAGE', 'UIAUTOMATOR_TEST_PACKAGE', 'XCTEST_TEST_PACKAGE', 'XCTEST_UI_TEST_PACKAGE', 'APPIUM_JAVA_JUNIT_TEST_SPEC', 'APPIUM_JAVA_TESTNG_TEST_SPEC', 'APPIUM_PYTHON_TEST_SPEC', 'APPIUM_NODE_TEST_SPEC', 'APPIUM_RUBY_TEST_SPEC', 'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC', 'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC', 'APPIUM_WEB_PYTHON_TEST_SPEC', 'APPIUM_WEB_NODE_TEST_SPEC', 'APPIUM_WEB_RUBY_TEST_SPEC', 'INSTRUMENTATION_TEST_SPEC', 'XCTEST_UI_TEST_SPEC']
  - name: contentType
    value: "{{ contentType }}"
    description: |
      The upload's content type (for example, application/octet-stream).

UPDATE examples

update_upload

Updates an uploaded test spec.

UPDATE aws.devicefarm.uploads
SET 
arn = '{{ arn }}',
name = '{{ name }}',
contentType = '{{ contentType }}',
editContent = {{ editContent }}
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
upload;

DELETE examples

delete_upload

Deletes an upload given the upload ARN.

DELETE FROM aws.devicefarm.uploads
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_uploads

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

EXEC aws.devicefarm.uploads.list_uploads 
@region='{{ region }}' --required 
@@json=
'{
"arn": "{{ arn }}", 
"type": "{{ type }}", 
"nextToken": "{{ nextToken }}"
}'
;