DescribeJob
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
Returns information about a specific job including shipping information, job status, and other important metadata.
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
{
"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"
}
}
}
]
}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.
- JobMetadata
-
Information about a specific job, including shipping information, job status, and other important metadata.
Type: JobMetadata object
- SubJobMetadata
-
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
Type: Array of JobMetadata objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
