CreateReturnShippingLabel
Important
End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers.
For more information, visit this blog post
Creates a shipping label that will be used to return the Snow device to AWS.
Request Syntax
{
"JobId": "string",
"ShippingOption": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
The ID for a job that you want to create the return shipping label for; for example,
JID123e4567-e89b-12d3-a456-426655440000.Type: String
Length Constraints: Fixed length of 39.
Pattern:
(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: Yes
- ShippingOption
-
The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
Type: String
Valid Values:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARDRequired: No
Response Syntax
{
"Status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Status
-
The status information of the task on a Snow device that is being returned to AWS.
Type: String
Valid Values:
InProgress | TimedOut | Succeeded | Failed
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
You get this exception when you call
CreateReturnShippingLabelmore than once when other requests are not completed.HTTP Status Code: 400
- InvalidInputCombinationException
-
Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateCluster:SnowballType value supports your CreateJob:JobType, and try again.
HTTP Status Code: 400
- InvalidJobStateException
-
The action can't be performed because the job's current state doesn't allow that action to be performed.
HTTP Status Code: 400
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
- ReturnShippingLabelAlreadyExistsException
-
You get this exception if you call
CreateReturnShippingLabeland a valid return shipping label already exists. In this case, useDescribeReturnShippingLabelto get the URL.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
