DescribeReturnShippingLabel
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
Information on the shipping label of a Snow device that is being returned to AWS.
Request Syntax
{
"JobId": "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 automatically generated ID for a job, 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
Response Syntax
{
"ExpirationDate": number,
"ReturnShippingLabelURI": "string",
"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.
- ExpirationDate
-
The expiration date of the current return shipping label.
Type: Timestamp
- ReturnShippingLabelURI
-
The pre-signed Amazon S3 URI used to download the return shipping label.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.* - 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
-
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
. You get this exception when you call
CreateReturnShippingLabelmore than once when other requests are not completed.HTTP Status Code: 400
- InvalidJobStateException
-
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
. 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
-
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
. The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
