CreateReturnShippingLabel
Snow デバイスを AWS に返すために使用する配送ラベルを作成します。
リクエストの構文
{
"JobId": "string
",
"ShippingOption": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- JobId
-
返品配送ラベルを作成するジョブのID。たとえば、
JID123e4567-e89b-12d3-a456-426655440000
。型: 文字列
長さの制限: 固定長は 39 です。
パターン:
(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
必須: はい
- ShippingOption
-
特定のジョブの配送速度。この速度は、デバイスがどれくらい早く AWS に戻されるかを決定するものではありません。この速度は、転送中の目的地への移動速度を表します。リージョンの配送速度は次のとおりです。
型: 文字列
有効な値:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
必須:いいえ
レスポンスの構文
{
"Status": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Status
-
AWS に返される Snow デバイスのタスクに関するステータス情報。
型: 文字列
有効な値:
InProgress | TimedOut | Succeeded | Failed
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- ConflictException
-
この例外は、他のリクエストが完了しない場合に
CreateReturnShippingLabel
を複数回呼び出したときに発生します。HTTP ステータスコード:400
- InvalidInputCombinationException
-
ジョブまたはクラスターの作成に失敗しました。1 つ以上の入力が無効です。CreateCluster:SnowballType 値がCreateJob:JobTypeをサポートしていることを確認し、再度お試しください。
HTTP ステータスコード:400
- InvalidJobStateException
-
ジョブの現在の状態ではそのアクションの実行が許可されていないため、アクションを実行できません。
HTTP ステータスコード:400
- InvalidResourceException
-
指定されたリソースが見つかりません。前回のリクエストで入力した情報をチェックし、もう一度お試しください。
HTTP ステータスコード:400
- ReturnShippingLabelAlreadyExistsException
-
CreateReturnShippingLabel
を呼び出し、有効な返送用ラベルが既に存在している場合、この例外が発生します。この場合は、DescribeReturnShippingLabel
を使用して、その URL を取得します。HTTP ステータスコード:400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。