

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DescribeJob
<a name="API_DescribeJob"></a>

**注意**  
 AWS Snowball 邊緣 不再提供給新客戶。新客戶應探索[AWS DataSync](https://aws.amazon.com/datasync/)線上傳輸、用於安全實體傳輸的[AWS 資料傳輸終端機](https://aws.amazon.com/data-transfer-terminal/)，或 AWS 合作夥伴解決方案。對於邊緣運算，請探索 [AWS Outposts](https://aws.amazon.com/outposts/)。

傳回特定任務的相關資訊，包括運送資訊、任務狀態，以及其他重要的中繼資料。

## 請求語法
<a name="API_DescribeJob_RequestSyntax"></a>

```
{
   "JobId": "string"
}
```

## 請求參數
<a name="API_DescribeJob_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [JobId](#API_DescribeJob_RequestSyntax) **   <a name="Snowball-DescribeJob-request-JobId"></a>
自動產生的任務 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}`  
必要：是

## 回應語法
<a name="API_DescribeJob_ResponseSyntax"></a>

```
{
   "JobMetadata": { 
      "AddressId": "string",
      "ClusterId": "string",
      "CreationDate": number,
      "DataTransferProgress": { 
         "BytesTransferred": number,
         "ObjectsTransferred": number,
         "TotalBytes": number,
         "TotalObjects": number
      },
      "Description": "string",
      "DeviceConfiguration": { 
         "SnowconeDeviceConfiguration": { 
            "WirelessConnection": { 
               "IsWifiEnabled": boolean
            }
         }
      },
      "ForwardingAddressId": "string",
      "ImpactLevel": "string",
      "JobId": "string",
      "JobLogInfo": { 
         "JobCompletionReportURI": "string",
         "JobFailureLogURI": "string",
         "JobSuccessLogURI": "string"
      },
      "JobState": "string",
      "JobType": "string",
      "KmsKeyARN": "string",
      "LongTermPricingId": "string",
      "Notification": { 
         "DevicePickupSnsTopicARN": "string",
         "JobStatesToNotify": [ "string" ],
         "NotifyAll": boolean,
         "SnsTopicARN": "string"
      },
      "OnDeviceServiceConfiguration": { 
         "EKSOnDeviceService": { 
            "EKSAnywhereVersion": "string",
            "KubernetesVersion": "string"
         },
         "NFSOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "S3OnDeviceService": { 
            "FaultTolerance": number,
            "ServiceSize": number,
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "TGWOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         }
      },
      "PickupDetails": { 
         "DevicePickupId": "string",
         "Email": "string",
         "IdentificationExpirationDate": number,
         "IdentificationIssuingOrg": "string",
         "IdentificationNumber": "string",
         "Name": "string",
         "PhoneNumber": "string"
      },
      "RemoteManagement": "string",
      "Resources": { 
         "Ec2AmiResources": [ 
            { 
               "AmiId": "string",
               "SnowballAmiId": "string"
            }
         ],
         "LambdaResources": [ 
            { 
               "EventTriggers": [ 
                  { 
                     "EventResourceARN": "string"
                  }
               ],
               "LambdaArn": "string"
            }
         ],
         "S3Resources": [ 
            { 
               "BucketArn": "string",
               "KeyRange": { 
                  "BeginMarker": "string",
                  "EndMarker": "string"
               },
               "TargetOnDeviceServices": [ 
                  { 
                     "ServiceName": "string",
                     "TransferOption": "string"
                  }
               ]
            }
         ]
      },
      "RoleARN": "string",
      "ShippingDetails": { 
         "InboundShipment": { 
            "Status": "string",
            "TrackingNumber": "string"
         },
         "OutboundShipment": { 
            "Status": "string",
            "TrackingNumber": "string"
         },
         "ShippingOption": "string"
      },
      "SnowballCapacityPreference": "string",
      "SnowballId": "string",
      "SnowballType": "string",
      "TaxDocuments": { 
         "IND": { 
            "GSTIN": "string"
         }
      }
   },
   "SubJobMetadata": [ 
      { 
         "AddressId": "string",
         "ClusterId": "string",
         "CreationDate": number,
         "DataTransferProgress": { 
            "BytesTransferred": number,
            "ObjectsTransferred": number,
            "TotalBytes": number,
            "TotalObjects": number
         },
         "Description": "string",
         "DeviceConfiguration": { 
            "SnowconeDeviceConfiguration": { 
               "WirelessConnection": { 
                  "IsWifiEnabled": boolean
               }
            }
         },
         "ForwardingAddressId": "string",
         "ImpactLevel": "string",
         "JobId": "string",
         "JobLogInfo": { 
            "JobCompletionReportURI": "string",
            "JobFailureLogURI": "string",
            "JobSuccessLogURI": "string"
         },
         "JobState": "string",
         "JobType": "string",
         "KmsKeyARN": "string",
         "LongTermPricingId": "string",
         "Notification": { 
            "DevicePickupSnsTopicARN": "string",
            "JobStatesToNotify": [ "string" ],
            "NotifyAll": boolean,
            "SnsTopicARN": "string"
         },
         "OnDeviceServiceConfiguration": { 
            "EKSOnDeviceService": { 
               "EKSAnywhereVersion": "string",
               "KubernetesVersion": "string"
            },
            "NFSOnDeviceService": { 
               "StorageLimit": number,
               "StorageUnit": "string"
            },
            "S3OnDeviceService": { 
               "FaultTolerance": number,
               "ServiceSize": number,
               "StorageLimit": number,
               "StorageUnit": "string"
            },
            "TGWOnDeviceService": { 
               "StorageLimit": number,
               "StorageUnit": "string"
            }
         },
         "PickupDetails": { 
            "DevicePickupId": "string",
            "Email": "string",
            "IdentificationExpirationDate": number,
            "IdentificationIssuingOrg": "string",
            "IdentificationNumber": "string",
            "Name": "string",
            "PhoneNumber": "string"
         },
         "RemoteManagement": "string",
         "Resources": { 
            "Ec2AmiResources": [ 
               { 
                  "AmiId": "string",
                  "SnowballAmiId": "string"
               }
            ],
            "LambdaResources": [ 
               { 
                  "EventTriggers": [ 
                     { 
                        "EventResourceARN": "string"
                     }
                  ],
                  "LambdaArn": "string"
               }
            ],
            "S3Resources": [ 
               { 
                  "BucketArn": "string",
                  "KeyRange": { 
                     "BeginMarker": "string",
                     "EndMarker": "string"
                  },
                  "TargetOnDeviceServices": [ 
                     { 
                        "ServiceName": "string",
                        "TransferOption": "string"
                     }
                  ]
               }
            ]
         },
         "RoleARN": "string",
         "ShippingDetails": { 
            "InboundShipment": { 
               "Status": "string",
               "TrackingNumber": "string"
            },
            "OutboundShipment": { 
               "Status": "string",
               "TrackingNumber": "string"
            },
            "ShippingOption": "string"
         },
         "SnowballCapacityPreference": "string",
         "SnowballId": "string",
         "SnowballType": "string",
         "TaxDocuments": { 
            "IND": { 
               "GSTIN": "string"
            }
         }
      }
   ]
}
```

## 回應元素
<a name="API_DescribeJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [JobMetadata](#API_DescribeJob_ResponseSyntax) **   <a name="Snowball-DescribeJob-response-JobMetadata"></a>
特定任務的相關資訊，包括運送資訊、任務狀態和其他重要的中繼資料。  
類型：[JobMetadata](API_JobMetadata.md) 物件

 ** [SubJobMetadata](#API_DescribeJob_ResponseSyntax) **   <a name="Snowball-DescribeJob-response-SubJobMetadata"></a>
特定任務部分的相關資訊 （在匯出任務的情況下），包括運送資訊、任務狀態和其他重要的中繼資料。  
類型：[JobMetadata](API_JobMetadata.md) 物件陣列

## 錯誤
<a name="API_DescribeJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidResourceException **   
找不到指定的資源。請檢查您在上一個請求中提供的資訊，然後再試一次。    
 ** ResourceType **   
提供的資源值無效。
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/DescribeJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/DescribeJob) 