Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
DescribeJob
Devuelve información sobre una tarea específica que incluye información de envío, estado de la tarea y otros metadatos importantes.
Sintaxis de la solicitud
{
"JobId": "string
"
}
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- JobId
-
El ID generado automáticamente para un trabajo, por ejemplo,
JID123e4567-e89b-12d3-a456-426655440000
.Tipo: cadena
Limitaciones de longitud: longitud fija de 39.
Patrón:
(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Obligatorio: sí
Sintaxis de la respuesta
{
"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"
}
}
}
]
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- JobMetadata
-
Devuelve información sobre un trabajo específico, que incluye información de envío, estado del trabajo y otros metadatos importantes.
Tipo: objeto JobMetadata
- SubJobMetadata
-
Información sobre un trabajo específico (en el caso de un trabajo de exportación), que incluye información de envío, estado del trabajo y otros metadatos importantes.
Tipo: matriz de objetos JobMetadata
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidResourceException
-
No se ha encontrado el recurso especificado. Compruebe la información que proporcionó en la última solicitud e inténtelo de nuevo.
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: