Skip to content

list_job_schema_versions

list_job_schema_versions(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    job_category: Optional[JobCategory] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListJobSchemaVersionsResponse

Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document.

The following operations are related to ListJobSchemaVersions:

  • DescribeJobSchemaVersion

  • CreateJob

Parameters:

  • job_category (Optional[JobCategory], default: None ) –

    The category of job schemas to list.

  • next_token (Optional[NextToken], default: None ) –

    If the previous response was truncated, this token retrieves the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of schema versions to return in the response. The default value is 5.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_job_schema_versions(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    job_category: Optional["capo_sagemaker.types.job_category.JobCategory"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_job_schema_versions_response.ListJobSchemaVersionsResponse":
    """<p>Lists available configuration schema versions for a specified job category. Use the schema versions with <code>DescribeJobSchemaVersion</code> to retrieve the full schema document.</p> <p>The following operations are related to <code>ListJobSchemaVersions</code>:</p> <ul> <li> <p> <code>DescribeJobSchemaVersion</code> </p> </li> <li> <p> <code>CreateJob</code> </p> </li> </ul>

    Args:
        job_category: <p>The category of job schemas to list.</p>
        next_token: <p>If the previous response was truncated, this token retrieves the next set of results.</p>
        max_results: <p>The maximum number of schema versions to return in the response. The default value is 5.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_job_schema_versions_request.ListJobSchemaVersionsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_job_schema_versions_response.ListJobSchemaVersionsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_job_schema_versions

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_job_schema_versions.list_job_schema_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListJobSchemaVersions")
    )
    input_: capo_sagemaker.types.list_job_schema_versions_request.ListJobSchemaVersionsRequest = {}
    if job_category is not None:
        input_["job_category"] = job_category
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output