本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeJob
返回有关特定作业的信息,包括发运信息、作业状态和其他重要元数据。
请求语法
{
"JobId": "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}
必需:是
响应语法
{
"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"
}
}
}
]
}
响应元素
如果操作成功,服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
- JobMetadata
-
有关特定作业的信息,包括配送信息、作业状态和其他重要元数据。
类型:JobMetadata 对象
- SubJobMetadata
-
有关特定作业部分(如果是导出作业)的信息,包括配送信息、作业状态和其他重要元数据。
类型:JobMetadata 对象数组
错误
有关所有操作返回的常见错误的信息,请参阅 常见错误。
- InvalidResourceException
-
找不到指定的资源。请查看您在上次请求中提供的信息,然后重试。
HTTP状态码:400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: