DescribeJob - Amazon Snowball
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeJob

返回有关特定作业的信息,包括发运信息、作业状态和其他重要元数据。

请求语法

{ "JobId": "string" }

请求参数

有关所有操作通用的参数的信息,请参阅常见参数.

请求接受采用 JSON 格式的以下数据。

JobId

例如,作业自动生成的 IDJID123e4567-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", "JobId": "string", "JobLogInfo": { "JobCompletionReportURI": "string", "JobFailureLogURI": "string", "JobSuccessLogURI": "string" }, "JobState": "string", "JobType": "string", "KmsKeyARN": "string", "LongTermPricingId": "string", "Notification": { "JobStatesToNotify": [ "string" ], "NotifyAll": boolean, "SnsTopicARN": "string" }, "OnDeviceServiceConfiguration": { "NFSOnDeviceService": { "StorageLimit": number, "StorageUnit": "string" }, "TGWOnDeviceService": { "StorageLimit": number, "StorageUnit": "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", "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", "JobId": "string", "JobLogInfo": { "JobCompletionReportURI": "string", "JobFailureLogURI": "string", "JobSuccessLogURI": "string" }, "JobState": "string", "JobType": "string", "KmsKeyARN": "string", "LongTermPricingId": "string", "Notification": { "JobStatesToNotify": [ "string" ], "NotifyAll": boolean, "SnsTopicARN": "string" }, "OnDeviceServiceConfiguration": { "NFSOnDeviceService": { "StorageLimit": number, "StorageUnit": "string" }, "TGWOnDeviceService": { "StorageLimit": number, "StorageUnit": "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", "SnowballType": "string", "TaxDocuments": { "IND": { "GSTIN": "string" } } } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

JobMetadata

返回有关特定任务的信息,包括发运信息、任务状态和其他重要元数据。

类型:JobMetadata 对象

SubJobMetadata

返回有关特定任务部件的信息(如果是出口任务),包括发运信息、任务状态和其他重要元数据。

类型: 数组JobMetadata对象

错误

有关所有操作常见错误的信息,请参阅常见错误.

InvalidResourceException

找不到指定的资源。检查上次请求中所提供的信息,然后重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: