- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateReturnShippingLabelCommand
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SnowballClient, CreateReturnShippingLabelCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, CreateReturnShippingLabelCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // CreateReturnShippingLabelRequest
JobId: "STRING_VALUE", // required
ShippingOption: "SECOND_DAY" || "NEXT_DAY" || "EXPRESS" || "STANDARD",
};
const command = new CreateReturnShippingLabelCommand(input);
const response = await client.send(command);
// { // CreateReturnShippingLabelResult
// Status: "InProgress" || "TimedOut" || "Succeeded" || "Failed",
// };
CreateReturnShippingLabelCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
JobIdRequired | string | undefined | The ID for a job that you want to create the return shipping label for; for example, |
ShippingOption | ShippingOption | undefined | The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows: |
CreateReturnShippingLabelCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Status | ShippingLabelStatus | undefined | The status information of the task on a Snow device that is being returned to Amazon Web Services. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConflictException | client | You get this exception when you call |
| InvalidInputCombinationException | client | Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again. |
| InvalidJobStateException | client | The action can't be performed because the job's current state doesn't allow that action to be performed. |
| InvalidResourceException | client | The specified resource can't be found. Check the information you provided in your last request, and try again. |
| ReturnShippingLabelAlreadyExistsException | client | You get this exception if you call |
| SnowballServiceException | Base exception class for all service exceptions from Snowball service. |