Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class StartObjectCommandProtected

Start upload containing one or many chunks.

Example

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

import { BackupStorageClient, StartObjectCommand } from "@aws-sdk/client-backupstorage"; // ES Modules import
// const { BackupStorageClient, StartObjectCommand } = require("@aws-sdk/client-backupstorage"); // CommonJS import
const client = new BackupStorageClient(config);
const input = { // StartObjectInput
BackupJobId: "STRING_VALUE", // required
ObjectName: "STRING_VALUE", // required
ThrowOnDuplicate: true || false,
};
const command = new StartObjectCommand(input);
const response = await client.send(command);
// { // StartObjectOutput
// UploadId: "STRING_VALUE", // required
// };

Param

StartObjectCommandInput

Returns

StartObjectCommandOutput

See

Throws

AccessDeniedException (client fault)

Throws

DataAlreadyExistsException (client fault) Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

Throws

IllegalArgumentException (client fault) Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

Throws

ResourceNotFoundException (client fault) Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

Throws

RetryableException (server fault) Retryable exception. In general indicates internal failure that can be fixed by retry.

Throws

ServiceInternalException (server fault) Deprecated. To be removed from the model.

Throws

ServiceUnavailableException (server fault) Retryable exception, indicates internal server error.

Throws

ThrottlingException (client fault) Increased rate over throttling limits. Can be retried with exponential backoff.

Throws

BackupStorageServiceException

Base exception class for all service exceptions from BackupStorage service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods