Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetJobUpgradeAnalysis

Retrieves the current status and results of an upgrade analysis.

Request Syntax


{
   "analysisId": "string",
   "jobName": "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.

analysisId

The unique identifier of the upgrade analysis to retrieve.

Type: String

Length Constraints: Fixed length of 39.

Pattern: ja-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

jobName

The name of the job associated with the analysis.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "analysisId": "string",
   "analysisType": "string",
   "autoUpgradeEligibilitySummary": "string",
   "autoUpgradeEvaluationSummary": "string",
   "errorMessage": "string",
   "jobName": "string",
   "sourceVersion": "string",
   "status": "string",
   "targetVersion": "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.

analysisId

The unique identifier of the upgrade analysis.

Type: String

Length Constraints: Fixed length of 39.

Pattern: ja-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

analysisType

The type of upgrade analysis. For auto-upgrade jobs, this value is AUTO_UPGRADE.

Type: String

Valid Values: AUTO_UPGRADE

autoUpgradeEligibilitySummary

A presigned URL for downloading the auto upgrade eligibility summary, which lists the compatibility results for the job. Available once the analysis reaches WAITING_FOR_CONSENT and in all subsequent states. The URL expires after 1 hour. Calling GetJobUpgradeAnalysis again returns a new URL.

Type: String

autoUpgradeEvaluationSummary

A presigned URL for downloading the auto upgrade evaluation summary for the analysis. Available once the analysis reaches a terminal status (SUCCEEDED or FAILED). The URL expires after 1 hour. Calling GetJobUpgradeAnalysis again returns a new URL.

Type: String

errorMessage

The reason the analysis did not complete.

Type: String

jobName

The name of the job associated with this analysis.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

sourceVersion

The AWS Glue version the job was running before the upgrade, for example 4.0.

Type: String

status

The current status of the analysis.

Type: String

targetVersion

The AWS Glue version the job will be upgraded to, for example 6.0.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationNotSupportedException

The operation is not available in the region.

Message: A message describing the problem.

HTTP Status Code: 400