UpdateUploadCommand

Suggest an Edit

Updates an uploaded test spec.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DeviceFarmClient, UpdateUploadCommand } from "@aws-sdk/client-device-farm"; // ES Modules import
// const { DeviceFarmClient, UpdateUploadCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import
const client = new DeviceFarmClient(config);
const input = { // UpdateUploadRequest
  arn: "STRING_VALUE", // required
  name: "STRING_VALUE",
  contentType: "STRING_VALUE",
  editContent: true || false,
};
const command = new UpdateUploadCommand(input);
const response = await client.send(command);
// { // UpdateUploadResult
//   upload: { // Upload
//     arn: "STRING_VALUE",
//     name: "STRING_VALUE",
//     created: new Date("TIMESTAMP"),
//     type: "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",
//     status: "INITIALIZED" || "PROCESSING" || "SUCCEEDED" || "FAILED",
//     url: "STRING_VALUE",
//     metadata: "STRING_VALUE",
//     contentType: "STRING_VALUE",
//     message: "STRING_VALUE",
//     category: "CURATED" || "PRIVATE",
//   },
// };

UpdateUploadCommand Input

See UpdateUploadCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the uploaded test spec.

contentType
string | undefined

The upload's content type (for example, application/x-yaml).

editContent
boolean | undefined

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

name
string | undefined

The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the .yaml or .yml file extension.

UpdateUploadCommand Output

See UpdateUploadCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
upload
Upload | undefined

A test spec uploaded to Device Farm.

Throws

Name
Fault
Details
ArgumentException
client

An invalid argument was specified.

LimitExceededException
client

A limit was exceeded.

NotFoundException
client

The specified entity was not found.

ServiceAccountException
client

There was a problem with the service account.

DeviceFarmServiceException
Base exception class for all service exceptions from DeviceFarm service.