Upgrade analysis
The Upgrade analysis API includes operations for viewing, resuming, and stopping upgrade analyses for jobs in Amazon Glue.
Operations
GetJobUpgradeAnalysis action (Python: get_job_upgrade_analysis)
Retrieves the current status and results of an upgrade analysis.
Request
-
analysisId– Required: UTF-8 string, not less than 39 or more than 39 bytes long, matching the Custom string pattern #80.The unique identifier of the upgrade analysis to retrieve.
-
jobName– Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.The name of the job associated with the analysis.
Response
-
jobName– Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.The name of the job associated with this analysis.
-
analysisId– Required: UTF-8 string, not less than 39 or more than 39 bytes long, matching the Custom string pattern #80.The unique identifier of the upgrade analysis.
-
status– Required: UTF-8 string (valid values:OBSERVING|WAITING_FOR_CONSENT|UPGRADING|SUCCEEDED|FAILED|TIMEOUT|STOPPED).The current status of the analysis.
-
sourceVersion– UTF-8 string.The Amazon Glue version the job was running before the upgrade, for example
4.0. -
targetVersion– Required: UTF-8 string.The Amazon Glue version the job will be upgraded to, for example
6.0. -
analysisType– UTF-8 string (valid values:AUTO_UPGRADE).The type of upgrade analysis. For auto-upgrade jobs, this value is
AUTO_UPGRADE. -
autoUpgradeEvaluationSummary– UTF-8 string.A presigned URL for downloading the auto upgrade evaluation summary for the analysis. Available once the analysis reaches a terminal status (
SUCCEEDEDorFAILED). The URL expires after 1 hour. CallingGetJobUpgradeAnalysisagain returns a new URL. -
errorMessage– UTF-8 string.The reason the analysis did not complete.
-
autoUpgradeEligibilitySummary– UTF-8 string.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_CONSENTand in all subsequent states. The URL expires after 1 hour. CallingGetJobUpgradeAnalysisagain returns a new URL.
Errors
InvalidInputExceptionEntityNotFoundExceptionOperationNotSupportedExceptionAccessDeniedExceptionInternalServiceException
StartJobUpgradeAnalysis action (Python: start_job_upgrade_analysis)
Resumes an analysis that is waiting for upgrade consent.
Request
-
jobName– Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.The name of the job associated with the analysis to resume.
-
analysisId– UTF-8 string, not less than 39 or more than 39 bytes long, matching the Custom string pattern #80.The unique identifier of the upgrade analysis. The analysis must be in
WAITING_FOR_CONSENTstatus. -
upgradeConsent– UTF-8 string (valid values:APPROVE|DECLINE).The customer's decision on whether to proceed with the upgrade.
Response
-
analysisId– UTF-8 string, not less than 39 or more than 39 bytes long, matching the Custom string pattern #80.The unique identifier of the upgrade analysis.
-
jobName– UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.The name of the job associated with this analysis.
Errors
ResourceNumberLimitExceededExceptionInvalidInputExceptionValidationExceptionEntityNotFoundExceptionOperationNotSupportedExceptionAccessDeniedExceptionInternalServiceException
StopJobUpgradeAnalysis action (Python: stop_job_upgrade_analysis)
Stops an in-progress upgrade analysis.
Request
-
jobName– Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.The name of the job associated with the analysis.
-
analysisId– Required: UTF-8 string, not less than 39 or more than 39 bytes long, matching the Custom string pattern #80.The unique identifier of the analysis to stop.
Response
No Response parameters.
Errors
InvalidInputExceptionEntityNotFoundExceptionOperationNotSupportedExceptionThrottlingExceptionAccessDeniedExceptionInternalServiceException