openapi: 3.2.0 info: description: 'Use the Data Science API to organize your data science work, access data and computing resources, and build, train, deploy and manage models and model deployments. For more information, see [Data Science](https://docs.oracle.com/iaas/data-science/using/data-science.htm). ' license: name: Oracle Corporation title: Data Science API version: '20190101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/f1a75e5659851c428e226e9cb3ebff6b0fcf452acf8ad4fa06094c0fa7dc4b2c.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Science API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/f1a75e5659851c428e226e9cb3ebff6b0fcf452acf8ad4fa06094c0fa7dc4b2c.yaml what: the harvested document for Data Science API servers: - url: https://$SWAGGER_HOST_URL/20190101 tags: - name: dataScience paths: /computeTargetShapes: get: description: Lists the valid compute target shapes. operationId: ListComputeTargetShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: List of compute target shapes retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ComputeTargetShapeSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the valid compute target shapes. tags: - dataScience x-obmcs-client-retries-enabled: true /computeTargets: get: description: 'List all compute targets in the specified compartment. Supports queries on various other parameters in the query alongside compartmentId (must be included). ' operationId: ListComputeTargets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ComputeTargetLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ComputeTargetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of compute targets retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ComputeTargetSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List compute targets in the specified compartment. tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new compute target resource. operationId: CreateComputeTarget parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: 'The request was successfully received and the compute target creation is in progress. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ComputeTarget' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new compute target resource. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ComputeTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateComputeTargetDetails' description: Details for creating a new compute target. required: true /computeTargets/{computeTargetId}: delete: description: Deletes the specified compute target. operationId: DeleteComputeTarget parameters: - $ref: '#/components/parameters/ComputeTargetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the compute target. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ComputeTarget' get: description: Retrieves the compute target for the specified `computeTargetId`. operationId: GetComputeTarget parameters: - $ref: '#/components/parameters/ComputeTargetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Compute Target retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ComputeTarget' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the compute target. tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the compute target. operationId: UpdateComputeTarget parameters: - $ref: '#/components/parameters/ComputeTargetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The compute target resource is being updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the compute target. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ComputeTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateComputeTargetDetails' description: Details for updating a Compute Target. required: true /computeTargets/{computeTargetId}/actions/changeCompartment: post: description: Moves a compute target into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeComputeTargetCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ComputeTargetIdPathParam' responses: '204': description: The compute target was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a compute target into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ComputeTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeComputeTargetCompartmentDetails' description: Details for changing the compartment of a compute target. required: true /dataSciencePrivateEndpoints: get: description: 'Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn''t include compartmentId, or includes compartmentId with two or more other parameters, then an error is returned. ' operationId: ListDataSciencePrivateEndpoints parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DataSciencePrivateEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/DataSciencePrivateEndpointSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/DataScienceResourceTypeQueryParam' responses: 200: description: 'Returns a list of Data Science private endpoints. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DataSciencePrivateEndpointSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the datascience private endpoints. tags: - dataScience x-example: 'GET /dataSciencePrivateEndpoints?compartmentId=<compartmentId> HTTP/1.1 Host: datascience.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/DataSciencePrivateEndpoint' post: description: 'Creates a Data Science private endpoint to be used by a Data Science resource. ' operationId: CreateDataSciencePrivateEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Returns the created private endpoint metadata, and a work request ID to track the progress of the operation. ' headers: Location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSciencePrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a Data Science private endpoint to be used by a Data Science resource. tags: - dataScience x-example: "POST /dataSciencePrivateEndpoints HTTP/1.1\nHost: datascience.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\" : \"<compartmentId>\",\n \"displayName\": \"pe_1234\",\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataSciencePrivateEndpointDetails' description: 'The parameters required to create a private endpoint. ' required: true /dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}: delete: description: 'Deletes a private endpoint using `privateEndpointId`. ' operationId: DeleteDataSciencePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSciencePrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the work reqest ID to track the progress of the operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a private endpoint. tags: - dataScience x-example: 'DELETE /dataSciencePrivateEndpoints/<privateEndpointId> HTTP/1.1 Host: datascience.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/DataSciencePrivateEndpoint' get: description: 'Retrieves an private endpoint using a `privateEndpointId`. ' operationId: GetDataSciencePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSciencePrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Returns a private endpoint. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSciencePrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get a private endpoint. tags: - dataScience x-example: 'GET /dataSciencePrivateEndpoints/<privateEndpointId> HTTP/1.1 Host: datascience.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: 'Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code is returned. This indicates that a conflict has been detected. ' operationId: UpdateDataSciencePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSciencePrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the private endpoint metadata and a work request ID to track the progress of the operation. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSciencePrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update a private endpoint. tags: - dataScience x-example: "PUT /dataSciencePrivateEndpoints/<privateEndpointId> HTTP/1.1\nHost: datascience.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\":\"PE to DB32002\",\n \"dnsZones\" : [ \"app.examplecorp.com\", \"oracle.com\" ],\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" x-related-resource: '#/definitions/DataSciencePrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataSciencePrivateEndpointDetails' description: 'Details for updating a private endpoint. ' required: true /dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}/actions/changeCompartment: post: description: 'Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeDataSciencePrivateEndpointCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DataSciencePrivateEndpointIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'Returns the work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a private endpoint into a different compartment. tags: - dataScience x-example: "POST /dataSciencePrivateEndpoints/<privateEndpointId>/actions/changeCompartment HTTP/1.1\nHost: datascience.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/DataSciencePrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataSciencePrivateEndpointCompartmentDetails' description: 'Details for changing a private endpoint''s compartment. ' required: true /fastLaunchJobConfigs: get: description: List fast launch capable job configs in the specified compartment. operationId: ListFastLaunchJobConfigs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: List of job shapes retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/FastLaunchJobConfigSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: FastLaunchJobConfigs tags: - dataScience x-obmcs-client-retries-enabled: true /jobRuns: get: description: List out job runs. operationId: ListJobRuns parameters: - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/JobIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/JobSortByQueryParam' - $ref: '#/components/parameters/JobRunLifecycleStateQueryParam' responses: 200: description: List of job runs retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/JobRunSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListJobRuns tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a job run. operationId: CreateJobRun parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Job run created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateJobRun tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJobRunDetails' description: Details for creating a new job run. required: true /jobRuns/{jobRunId}: delete: description: Deletes a job run. operationId: DeleteJobRun parameters: - $ref: '#/components/parameters/JobRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteJobRun tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/JobRun' get: description: Gets a job run. operationId: GetJobRun parameters: - $ref: '#/components/parameters/JobRunIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Job run retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetJobRun tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates a job run. operationId: UpdateJobRun parameters: - $ref: '#/components/parameters/JobRunIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Job run updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateJobRun tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/JobRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJobRunDetails' description: Details for updating a job. required: true /jobRuns/{jobRunId}/actions/cancelJobRun: post: description: Cancels an IN_PROGRESS job run. operationId: CancelJobRun parameters: - $ref: '#/components/parameters/JobRunIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': description: Accepted headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CancelJobRun tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/JobRun' /jobRuns/{jobRunId}/actions/changeCompartment: post: description: Changes a job run's compartment operationId: ChangeJobRunCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobRunIdPathParam' responses: '204': description: The job run was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeJobRunCompartment tags: - dataScience x-related-resource: '#/definitions/JobRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeJobRunCompartmentDetails' description: Details for changing the compartment of a job. required: true /jobShapes: get: description: List job shapes available in the specified compartment. operationId: ListJobShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: List of job shapes retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/JobShapeSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListJobShapes tags: - dataScience x-obmcs-client-retries-enabled: true /jobs: get: description: List jobs in the specified compartment. operationId: ListJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/JobLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/JobSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of jobs retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/JobSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListJobs tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a job. operationId: CreateJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Job created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateJob tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJobDetails' description: Details for creating a new job. required: true /jobs/{jobId}: delete: description: Deletes a job. operationId: DeleteJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - description: Delete all JobRuns associated with this job. in: query name: deleteRelatedJobRuns required: false schema: type: boolean default: false responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteJob tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Job' get: description: Gets a job. operationId: GetJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Job retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetJob tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates a job. operationId: UpdateJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Job updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateJob tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJobDetails' description: Details for updating a job. required: true /jobs/{jobId}/actions/changeCompartment: post: description: Changes a job's compartment operationId: ChangeJobCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: '204': description: The job was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeJobCompartment tags: - dataScience x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeJobCompartmentDetails' description: Details for changing the compartment of a job. required: true /jobs/{jobId}/artifact: post: description: Uploads a job artifact. operationId: CreateJobArtifact parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContentLengthHeader' - $ref: '#/components/parameters/JobContentDispositionHeader' responses: '204': description: Job artifact uploaded successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateJobArtifact tags: - dataScience x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/Job' requestBody: content: application/octet-stream: schema: format: binary type: string description: The job artifact to upload. required: true /jobs/{jobId}/artifact/content: get: description: Downloads job artifact content for specified job. operationId: GetJobArtifactContent parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RangeRequestHeader' responses: 200: description: Successfully downloaded job artifact content. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 206: description: Successfully downloaded partial job artifact. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetJobArtifactContent tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Job' head: description: Gets job artifact metadata. operationId: HeadJobArtifact parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Job artifact metadata retrieved successfully. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: HeadJobArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Job' /mlApplicationImplementationVersions: get: description: 'Returns a list of MlApplicationImplementationVersions. ' operationId: ListMlApplicationImplementationVersions parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdRequiredQueryParam' - $ref: '#/components/parameters/MlApplicationImplementationVersionLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MlApplicationImplementationVersionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MlApplicationImplementationVersionSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementationVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all MlApplicationImplementationVersions in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementationVersion' /mlApplicationImplementationVersions/{mlApplicationImplementationVersionId}: get: description: Gets a MlApplicationImplementationVersion by identifier operationId: GetMlApplicationImplementationVersion parameters: - $ref: '#/components/parameters/MlApplicationImplementationVersionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MlApplicationImplementationVersion with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementationVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get MlApplicationImplementationVersion tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the MlApplicationImplementationVersion operationId: UpdateMlApplicationImplementationVersion parameters: - $ref: '#/components/parameters/MlApplicationImplementationVersionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates and retrieves the MlApplicationImplementationVersion headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementationVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the MlApplicationImplementationVersion identified by the id tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementationVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMlApplicationImplementationVersionDetails' description: The information to be updated. required: true /mlApplicationImplementationVersions/{mlApplicationImplementationVersionId}/mlApplicationHistoricalPackage/content: get: description: Retrieves ML Application package for MlApplicationImplementationVersion with given id. operationId: GetMlApplicationHistoricalPackageContent parameters: - $ref: '#/components/parameters/MlApplicationImplementationVersionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Downloads ML Application package for ML Application Implementation Version with the given id. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get GetMlApplicationHistoricalPackageContent tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementationVersion' /mlApplicationImplementations: get: description: 'Returns a list of MlApplicationImplementations. ' operationId: ListMlApplicationImplementations parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/MlApplicationIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/MlApplicationImplementationLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MlApplicationImplementationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MlApplicationImplementationSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all MlApplicationImplementations in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' post: description: 'Creates a new MlApplicationImplementation. ' operationId: CreateMlApplicationImplementation parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Creates and retrieves the MlApplicationImplementation headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new MlApplicationImplementation tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMlApplicationImplementationDetails' description: Details for the new MlApplicationImplementation. required: true /mlApplicationImplementations/{mlApplicationImplementationId}: delete: description: Deletes a MlApplicationImplementation resource by identifier operationId: DeleteMlApplicationImplementation parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The MlApplicationImplementation will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned MlApplicationImplementation tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' get: description: Gets a MlApplicationImplementation by identifier operationId: GetMlApplicationImplementation parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MlApplicationImplementation with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationImplementation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get MlApplicationImplementation tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the MlApplicationImplementation operationId: UpdateMlApplicationImplementation parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The MlApplicationImplementation will be updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the MlApplicationImplementation identified by the id tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMlApplicationImplementationDetails' description: The information to be updated. required: true /mlApplicationImplementations/{mlApplicationImplementationId}/actions/changeCompartment: post: description: Moves a MlApplicationImplementation resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMlApplicationImplementationCompartment parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The MlApplicationImplementation resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMlApplicationImplementationCompartmentDetails' description: The information to be updated. required: true /mlApplicationImplementations/{mlApplicationImplementationId}/mlApplicationPackage: put: description: Upload ML Application Package operationId: PutMlApplicationPackage parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContentLengthHeader' - $ref: '#/components/parameters/ContentDispositionHeader' - $ref: '#/components/parameters/MlApplicationPackageArgumentsHeader' responses: 202: description: Upload ML Application Package. It will be validated and stored. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Upload ML Application Package tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' requestBody: content: application/octet-stream: schema: format: binary type: string description: ML Application Package to upload required: true /mlApplicationImplementations/{mlApplicationImplementationId}/mlApplicationPackage/content: get: description: Retrieves last ML Application package uploaded for given ML Application Implementation operationId: GetMlApplicationPackageContent parameters: - $ref: '#/components/parameters/MlApplicationImplementationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves ML Application Implementation package headers: opc-ml-app-package-args: description: 'List of arguments (Json map - argument name to argument value) for ML Application package (available arguments are in ML Application package descriptor). E.g. {"vcnId": "ocid1.vcn.oc1.iad.abcd...", "logId":"ocid1.log.oc1.iad.abcd..."}' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get ML Application package content tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationImplementation' /mlApplicationInstanceViews: get: description: 'Returns a list of MlApplicationInstanceViews. ' operationId: ListMlApplicationInstanceViews parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MlApplicationIdentifierQueryParam' - $ref: '#/components/parameters/MlApplicationImplementationIdQueryParam' - $ref: '#/components/parameters/MlApplicationInstanceIdQueryParam' - $ref: '#/components/parameters/MlApplicationInstanceViewLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MlApplicationInstanceViewSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MlApplicationInstanceViewSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceViewCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all MlApplicationInstanceViews in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' /mlApplicationInstanceViews/{mlApplicationInstanceViewId}: get: description: Gets a MlApplicationInstanceView by identifier operationId: GetMlApplicationInstanceView parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MlApplicationInstanceView with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceView' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get MlApplicationInstanceView tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the MlApplicationInstanceView operationId: UpdateMlApplicationInstanceView parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates and retrieves the MlApplicationInstanceView headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceView' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the MlApplicationInstanceView identified by the id tags: - dataScience x-related-resource: '#/definitions/MlApplicationInstanceView' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMlApplicationInstanceViewDetails' description: The information to be updated. required: true /mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/changeCompartment: post: description: Moves a MlApplicationInstanceView resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMlApplicationInstanceViewCompartment parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The MlApplicationInstanceView resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMlApplicationInstanceViewCompartmentDetails' description: The information to be updated. required: true /mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/disableTrigger: post: description: Disable trigger of given name for given ML Application Instance View flow operationId: DisableMlApplicationInstanceViewTrigger parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Disables trigger headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceView' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable trigger tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' requestBody: content: application/json: schema: $ref: '#/components/schemas/DisableMlApplicationInstanceViewTriggerDetails' description: Details for disable trigger request. required: true /mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/enableTrigger: post: description: Enable trigger of given name for given ML Application Instance View flow operationId: EnableMlApplicationInstanceViewTrigger parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Enables trigger headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceView' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable trigger tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableMlApplicationInstanceViewTriggerDetails' description: Details for enable trigger request. required: true /mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/recover: post: description: 'Provider can initiate recovery of the resource only if MlApplicationInstanceView is in one of the recoverable sub-states (RECOVERABLE_PROVIDER_ISSUE, RECOVERABLE_SERVICE_ISSUE). Provider should investigate (using MlApplicationInstanceView lifecycleDetails, relevant logs and metrics) and fix the issue before the recovery is initiated. ' operationId: RecoverMlApplicationInstanceView parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Recovery of MlApplicationInstanceView initiated successfully. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Recovers MlApplicationInstanceView from failures by retrying failed operation. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' /mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/trigger: post: description: Trigger ML Application Instance View flow if possible operationId: TriggerMlApplicationInstanceViewFlow parameters: - $ref: '#/components/parameters/MlApplicationInstanceViewIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request for triggering ML Application Instance View flow headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Trigger request tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstanceView' requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerMlApplicationInstanceViewFlowDetails' description: Details for trigger request. required: true /mlApplicationInstances: get: description: 'Returns a list of MlApplicationsInstances. ' operationId: ListMlApplicationInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MlApplicationIdentifierQueryParam' - $ref: '#/components/parameters/MlApplicationInstanceLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MlApplicationInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MlApplicationInstanceSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstanceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all MlApplicationInstances in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' post: description: 'Creates a new MlApplicationInstance. ' operationId: CreateMlApplicationInstance parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the MlApplicationInstance creation is in progress. headers: content-location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new MlApplicationInstance tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMlApplicationInstanceDetails' description: Details for the new MlApplicationInstance. required: true /mlApplicationInstances/{mlApplicationInstanceId}: delete: description: Deletes a MlApplicationInstance resource by identifier operationId: DeleteMlApplicationInstance parameters: - $ref: '#/components/parameters/MlApplicationInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The MlApplicationInstance will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned MlApplicationInstance tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' get: description: Gets a MlApplicationInstance by identifier operationId: GetMlApplicationInstance parameters: - $ref: '#/components/parameters/MlApplicationInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MlApplicationInstance with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get MlApplicationInstance tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the MlApplicationInstance operationId: UpdateMlApplicationInstance parameters: - $ref: '#/components/parameters/MlApplicationInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The MlApplicationInstance will be updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the MlApplicationInstance identified by the id tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMlApplicationInstanceDetails' description: The information to be updated. required: true /mlApplicationInstances/{mlApplicationInstanceId}/actions/changeCompartment: post: description: Moves a MlApplicationInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMlApplicationInstanceCompartment parameters: - $ref: '#/components/parameters/MlApplicationInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The MlApplicationInstance resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMlApplicationInstanceCompartmentDetails' description: The information to be updated. required: true /mlApplicationInstances/{mlApplicationInstanceId}/actions/trigger: post: description: Trigger ML Application Instance flow if possible operationId: TriggerMlApplicationInstanceFlow parameters: - $ref: '#/components/parameters/MlApplicationInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request for triggering ML Application Instance flow headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Trigger request tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplicationInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerMlApplicationInstanceFlowDetails' description: Details for trigger request. required: true /mlApplications: get: description: 'Returns a list of MlApplications. ' operationId: ListMlApplications parameters: - $ref: '#/components/parameters/MlApplicationIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/MlApplicationLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MlApplicationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MlApplicationSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplicationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all MlApplications in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplication' post: description: 'Creates a new MlApplication. ' operationId: CreateMlApplication parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Creates and retrieves the MlApplication headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new MlApplication tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMlApplicationDetails' description: Details for the new MlApplication. required: true /mlApplications/{mlApplicationId}: delete: description: Deletes a MlApplication resource by identifier operationId: DeleteMlApplication parameters: - $ref: '#/components/parameters/MlApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The MlApplication is deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a MlApplication tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplication' get: description: Gets a MlApplication by identifier operationId: GetMlApplication parameters: - $ref: '#/components/parameters/MlApplicationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MlApplication with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get MlApplication tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the MlApplication operationId: UpdateMlApplication parameters: - $ref: '#/components/parameters/MlApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates and retrieves the MlApplication headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MlApplication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the MlApplication identified by the id tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMlApplicationDetails' description: The information to be updated. required: true /mlApplications/{mlApplicationId}/actions/changeCompartment: post: description: Moves a MlApplication resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMlApplicationCompartment parameters: - $ref: '#/components/parameters/MlApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Moves the MlApplication resource into a different compartment headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MlApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMlApplicationCompartmentDetails' description: The information to be updated. required: true /modelDeploymentShapes: get: description: Lists the valid model deployment shapes. operationId: ListModelDeploymentShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: List of Model deployment shapes retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelDeploymentShapeSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the valid model deployment shapes. tags: - dataScience x-obmcs-client-retries-enabled: true /modelDeployments: get: description: 'Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned. ' operationId: ListModelDeployments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelDeploymentLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelDeploymentSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of model deployments retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelDeploymentSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Lists the model deployments. tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new model deployment. operationId: CreateModelDeployment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: 'The request was successfully received and the model deployment creation is in progress. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelDeployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new model deployment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelDeploymentDetails' description: Details for creating a new model deployment. required: true /modelDeployments/{modelDeploymentId}: delete: description: Deletes the specified model deployment. Any unsaved work in this model deployment is lost. operationId: DeleteModelDeployment parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the model deployment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelDeployment' get: description: Retrieves the model deployment for the specified `modelDeploymentId`. operationId: GetModelDeployment parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model Deployment retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelDeployment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the model deployment. tags: - dataScience x-obmcs-client-retries-enabled: true put: description: 'Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time when the model deployment''s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails` can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated. ' operationId: UpdateModelDeployment parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The model deployment resource is being updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the model deployment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelDeploymentDetails' description: 'Details for updating a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time when the model deployment''s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails` can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated. ' required: true /modelDeployments/{modelDeploymentId}/actions/activate: post: description: Activates the model deployment. operationId: ActivateModelDeployment parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Activates the model deployment. tags: - dataScience x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/ModelDeployment' /modelDeployments/{modelDeploymentId}/actions/changeCompartment: post: description: Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeModelDeploymentCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelDeploymentIdPathParam' responses: '204': description: The model deployment was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a model deployment into a different compartment. tags: - dataScience x-related-resource: '#/definitions/ModelDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelDeploymentCompartmentDetails' description: Details for changing the compartment of a model deployment. required: true /modelDeployments/{modelDeploymentId}/actions/deactivate: post: description: Deactivates the model deployment. operationId: DeactivateModelDeployment parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deactivates the model deployment. tags: - dataScience x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/ModelDeployment' /modelDeployments/{modelDeploymentId}/models/modelState: get: description: Lists the status of models in a model group deployment. operationId: ListModelDeploymentModelStates parameters: - $ref: '#/components/parameters/ModelDeploymentIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/InferenceKeyQueryParam' - $ref: '#/components/parameters/ModelIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelDeploymentSortByQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: List of model states in a model group deployment retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelDeploymentModelStateSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the status of models in a model group deployment. tags: - dataScience x-obmcs-client-retries-enabled: true /modelGroupVersionHistory: get: description: List all modelGroupVersionHistories in the specified compartment. The query must include compartmentId. operationId: ListModelGroupVersionHistories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelGroupVersionHistoryLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelGroupVersionHistorySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of ModelGroupVersionHistories retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelGroupVersionHistorySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List all modelGroupVersionHistories in the specified compartment. tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new modelGroupVersionHistory. operationId: CreateModelGroupVersionHistory parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Model Group Version History created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroupVersionHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new modelGroupVersionHistory. tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelGroupVersionHistoryDetails' description: Details for creating a new model group version History. required: true /modelGroupVersionHistory/{modelGroupVersionHistoryId}: delete: description: Deletes the specified modelGroupVersionHistory. operationId: DeleteModelGroupVersionHistory parameters: - $ref: '#/components/parameters/ModelGroupVersionHistoryIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified modelGroupVersionHistory. tags: - dataScience x-related-resource: '#/definitions/ModelGroupVersionHistory' get: description: Gets the specified modelGroupVersionHistory's information. operationId: GetModelGroupVersionHistory parameters: - $ref: '#/components/parameters/ModelGroupVersionHistoryIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ModelGroupVersionHistory retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroupVersionHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets information of the specified ModelGroupVersionHistory. tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the properties of a modelGroupVersionHistory. operationId: UpdateModelGroupVersionHistory parameters: - $ref: '#/components/parameters/ModelGroupVersionHistoryIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: ModelGroupVersionHistory updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroupVersionHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the properties of a modelGroupVersionHistory. tags: - dataScience x-related-resource: '#/definitions/ModelGroupVersionHistory' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelGroupVersionHistoryDetails' description: Details for updating a modelGroupVersionHistory. required: true /modelGroupVersionHistory/{modelGroupVersionHistoryId}/actions/changeCompartment: post: description: Moves a model Group Version History resource into a different compartment. operationId: ChangeModelGroupVersionHistoryCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelGroupVersionHistoryIdPathParam' responses: '204': description: The Model Group Version History was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change compartment of the modelGroupVersionHistory. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroupVersionHistory' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelGroupVersionHistoryCompartmentDetails' description: Details for changing the compartment of a Model Group Version History. required: true /modelGroups: get: description: Lists all the modelGroups in the specified compartment. The query must include compartmentId. operationId: ListModelGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/ModelGroupVersionHistoryIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelGroupsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of ModelGroups retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelGroupSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List all model groups in the specified compartment. tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Create a new Model Group resource. operationId: CreateModelGroup parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: The request was successfully received and the model group creation is in progress. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a new Model Group resource. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBaseModelGroupDetails' description: Details for creating a new model group. required: true /modelGroups/{modelGroupId}: delete: description: Deletes the specified Model Group. operationId: DeleteModelGroup parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Model Group. tags: - dataScience x-related-resource: '#/definitions/ModelGroup' get: description: Retrieves the Model Group resource based on the specified modelGroup id. operationId: GetModelGroup parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ModelGroup retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets information of the specified Model Group. tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the properties of the Model Group. operationId: UpdateModelGroup parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: ModelGroup updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the properties of the Model Group. tags: - dataScience x-related-resource: '#/definitions/ModelGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelGroupDetails' description: Details for updating a modelGroup. required: true /modelGroups/{modelGroupId}/actions/activate: post: description: Activates the model group. operationId: ActivateModelGroup parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The model group was successfully activated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroup' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Activates the model group. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' /modelGroups/{modelGroupId}/actions/changeCompartment: post: description: Moves a model group resource into a different compartment. operationId: ChangeModelGroupCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelGroupIdPathParam' responses: '204': description: The model group was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change compartment of the Model Group. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelGroupCompartmentDetails' description: Details for changing the compartment of a model group. required: true /modelGroups/{modelGroupId}/actions/deactivate: post: description: Deactivates the model group. operationId: DeactivateModelGroup parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The model group was successfully deactivated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelGroup' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deactivates the model group. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' /modelGroups/{modelGroupId}/artifact: post: description: Creates artifact for the Model Group. operationId: CreateModelGroupArtifact parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContentLengthHeader' - $ref: '#/components/parameters/ContentDispositionHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: Model group artifact created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates artifact for the Model Group. tags: - dataScience x-obmcs-client-retries-enabled: true x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/ModelGroup' requestBody: content: application/octet-stream: schema: format: binary type: string description: The model group artifact to upload. required: true /modelGroups/{modelGroupId}/artifact/content: get: description: Downloads the model artifact for the specified model group. operationId: GetModelGroupArtifactContent parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RangeRequestHeader' responses: 200: description: Successfully downloaded model group artifact content. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 206: description: Successfully downloaded partial model group artifact. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string content-range: description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233), section 4.2. schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Downloads the model group artifact. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' head: description: Gets model group artifact metadata for a specified model group. operationId: HeadModelGroupArtifact parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model group artifact metadata retrieved successfully. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets model group artifact metadata. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' /modelGroups/{modelGroupId}/models: get: description: Lists all models associated with the modelGroup in the specified compartment. operationId: ListModelGroupModels parameters: - $ref: '#/components/parameters/ModelGroupIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelGroupsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of Models associated with the Model Group is retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelGroupModelSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List models associated with the Model Group. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelGroup' /modelVersionSets: get: description: Lists model version sets in the specified compartment. operationId: ListModelVersionSets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/ModelVersionSetLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelVersionSetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of model version sets retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelVersionSetSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListModelVersionSets tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new modelVersionSet. operationId: CreateModelVersionSet parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: ModelVersionSet created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelVersionSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateModelVersionSet tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelVersionSetDetails' description: Details for creating a new modelVersionSet. required: true /modelVersionSets/{modelVersionSetId}: delete: description: Deletes the specified modelVersionSet. operationId: DeleteModelVersionSet parameters: - $ref: '#/components/parameters/ModelVersionSetIdPathParam' - $ref: '#/components/parameters/ModelVersionSetDeleteRelatedModelsQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteModelVersionSet tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelVersionSet' get: description: Gets the specified model version set information. operationId: GetModelVersionSet parameters: - $ref: '#/components/parameters/ModelVersionSetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The model version set was retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelVersionSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetModelVersionSet tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelVersionSet' put: description: Updates the properties of a model version set. User can update the `description` property. operationId: UpdateModelVersionSet parameters: - $ref: '#/components/parameters/ModelVersionSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The model version set updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelVersionSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateModelVersionSet tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelVersionSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelVersionSetDetails' description: Details for updating a model version set. You can update `description` property only. required: true /modelVersionSets/{modelVersionSetId}/actions/changeCompartment: post: description: Moves a modelVersionSet resource into a different compartment. operationId: ChangeModelVersionSetCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelVersionSetIdPathParam' responses: 202: description: The model version set was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeModelVersionSetCompartment tags: - dataScience x-related-resource: '#/definitions/ModelVersionSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelVersionSetCompartmentDetails' description: Details for changing the compartment of a model version set. required: true /models: get: description: Lists models in the specified compartment. operationId: ListModels parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ModelVersionSetNameQueryParam' - $ref: '#/components/parameters/VersionLabelQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of models retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ModelSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListModels tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new model. operationId: CreateModel parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Model created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateModel tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelDetails' description: Details for creating a new model. required: true /models/{modelId}: delete: description: Deletes the specified model. operationId: DeleteModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Model deleted successfully. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteModel tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' get: description: Gets the specified model's information. operationId: GetModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetModel tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties. operationId: UpdateModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateModel tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelDetails' description: Details for updating a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties. required: true /models/{modelId}/actions/activate: post: description: Activates the model. operationId: ActivateModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The model was successfully activated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ActivateModel tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' /models/{modelId}/actions/changeCompartment: post: description: Moves a model resource into a different compartment. operationId: ChangeModelCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelIdPathParam' responses: '204': description: The model was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeModelCompartment tags: - dataScience x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelCompartmentDetails' description: Details for changing the compartment of a model. required: true /models/{modelId}/actions/deactivate: post: description: Deactivates the model. operationId: DeactivateModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The model was successfully deactivated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeactivateModel tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' /models/{modelId}/actions/exportArtifact: post: description: Export model artifact from source to the service bucket operationId: ExportModelArtifact parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request has been accepted for processing headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ExportModelArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportModelArtifactDetails' description: Model artifact source details for exporting. required: true /models/{modelId}/actions/importArtifact: post: description: Import model artifact from service bucket operationId: ImportModelArtifact parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request has been accepted for processing headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ImportModelArtifact tags: - dataScience x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportModelArtifactDetails' description: Model artifact source details for importing. required: true /models/{modelId}/actions/restore: post: description: Restore archived model artifact operationId: RestoreArchivedModelArtifact parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RestoreModelForHoursSpecifiedParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Model is already restored. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 202: description: Request has been accepted for processing headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RestoreArchivedModelArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' /models/{modelId}/artifact: post: description: Creates model artifact for specified model. operationId: CreateModelArtifact parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContentLengthHeader' - $ref: '#/components/parameters/ContentDispositionHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '204': description: Model artifact uploaded successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateModelArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/Model' requestBody: content: application/octet-stream: schema: format: binary type: string description: The model artifact to upload. required: true /models/{modelId}/artifact/content: get: description: Downloads model artifact content for specified model. operationId: GetModelArtifactContent parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RangeRequestHeader' responses: 200: description: Successfully downloaded model artifact content. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 206: description: Successfully downloaded partial model artifact. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string content-range: description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233), section 4.2. schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetModelArtifactContent tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' head: description: Gets model artifact metadata for specified model. operationId: HeadModelArtifact parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model artifact metadata retrieved successfully. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: HeadModelArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' /models/{modelId}/provenance: get: description: Gets provenance information for specified model. operationId: GetModelProvenance parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Provenance retrieved successfully for specified model. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelProvenance' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetModelProvenance tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' post: description: Creates provenance information for the specified model. operationId: CreateModelProvenance parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Provenance information created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelProvenance' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateModelProvenance tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelProvenanceDetails' description: Provenance information for specified model. required: true put: description: Updates the provenance information for the specified model. operationId: UpdateModelProvenance parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '200': description: Provenance information updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelProvenance' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateModelProvenance tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelProvenanceDetails' description: Provenance information for the specified model. required: true /notebookSessionShapes: get: description: Lists the valid notebook session shapes. operationId: ListNotebookSessionShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: List of notebook session shapes retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NotebookSessionShapeSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListNotebookSessionShapes tags: - dataScience x-obmcs-client-retries-enabled: true /notebookSessions: get: description: Lists the notebook sessions in the specified compartment. operationId: ListNotebookSessions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NotebookSessionLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NotebookSessionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of notebook sessions retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NotebookSessionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: ListNotebookSessions tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new notebook session. operationId: CreateNotebookSession parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: 'The request was successfully received and the notebook session creation is in progress. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NotebookSession' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateNotebookSession tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/NotebookSession' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNotebookSessionDetails' description: Details for creating a new notebook session. required: true /notebookSessions/{notebookSessionId}: delete: description: Deletes the specified notebook session. Any unsaved work in this notebook session are lost. operationId: DeleteNotebookSession parameters: - $ref: '#/components/parameters/NotebookSessionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteNotebookSession tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/NotebookSession' get: description: Gets the specified notebook session's information. operationId: GetNotebookSession parameters: - $ref: '#/components/parameters/NotebookSessionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Notebook session retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NotebookSession' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetNotebookSession tags: - dataScience x-obmcs-client-retries-enabled: true put: description: 'Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties. When the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`. Changes to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource. ' operationId: UpdateNotebookSession parameters: - $ref: '#/components/parameters/NotebookSessionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Notebook session updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NotebookSession' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateNotebookSession tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/NotebookSession' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNotebookSessionDetails' description: 'Details for updating a notebook session. `notebookSessionConfigurationDetails` can only be updated while the notebook session is in the `INACTIVE` state. Changes to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource. ' required: true /notebookSessions/{notebookSessionId}/actions/activate: post: description: Activates the notebook session. operationId: ActivateNotebookSession parameters: - $ref: '#/components/parameters/NotebookSessionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ActivateNotebookSession tags: - dataScience x-related-resource: '#/definitions/NotebookSession' /notebookSessions/{notebookSessionId}/actions/changeCompartment: post: description: Moves a notebook session resource into a different compartment. operationId: ChangeNotebookSessionCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/NotebookSessionIdPathParam' responses: '204': description: The notebook session was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeNotebookSessionCompartment tags: - dataScience x-related-resource: '#/definitions/NotebookSession' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNotebookSessionCompartmentDetails' description: Details for changing the compartment of a notebook session. required: true /notebookSessions/{notebookSessionId}/actions/deactivate: post: description: Deactivates the notebook session. operationId: DeactivateNotebookSession parameters: - $ref: '#/components/parameters/NotebookSessionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeactivateNotebookSession tags: - dataScience x-related-resource: '#/definitions/NotebookSession' /pipelineRuns: get: description: Returns a list of PipelineRuns. operationId: ListPipelineRuns parameters: - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/PipelineIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PipelineRunLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PipelineRunSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: An array of PipelineRunSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PipelineRunSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all PipelineRuns in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/PipelineRun' post: description: 'Creates a new PipelineRun. ' operationId: CreatePipelineRun parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Pipeline Run created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PipelineRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new PipelineRun tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePipelineRunDetails' description: Details for the new PipelineRun. required: true /pipelineRuns/{pipelineRunId}: delete: description: Deletes a PipelineRun resource by identifier. operationId: DeletePipelineRun parameters: - $ref: '#/components/parameters/PipelineRunIdPathParam' - $ref: '#/components/parameters/DeleteRelatedJobRunsQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The PipelineRun will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned PipelineRun tags: - dataScience x-related-resource: '#/definitions/PipelineRun' get: description: Gets a PipelineRun by identifier. operationId: GetPipelineRun parameters: - $ref: '#/components/parameters/PipelineRunIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the PipelineRun with the given id. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PipelineRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get PipelineRun tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the PipelineRun. operationId: UpdatePipelineRun parameters: - $ref: '#/components/parameters/PipelineRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The PipelineRun was successfully updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PipelineRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the PipelineRun identified by the id tags: - dataScience x-related-resource: '#/definitions/PipelineRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineRunDetails' description: The information to be updated. required: true /pipelineRuns/{pipelineRunId}/actions/cancelPipelineRun: post: description: Cancel a PipelineRun. operationId: CancelPipelineRun parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/PipelineRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PipelineRunTerminateGracefullyQueryParam' responses: 202: description: Accepted the request. PipelineRun will be cancelled. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Cancel a PipelineRun tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/PipelineRun' /pipelineRuns/{pipelineRunId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangePipelineRunCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PipelineRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The PipelineRun has been successfully moved. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-related-resource: '#/definitions/PipelineRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePipelineRunCompartmentDetails' description: Details for the compartment move. required: true /pipelines: get: description: Returns a list of Pipelines. operationId: ListPipelines parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PipelineLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PipelineSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PipelineSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PipelineSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all Pipelines in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Pipeline' post: description: 'Creates a new Pipeline. ' operationId: CreatePipeline parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Pipeline created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new Pipeline tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePipelineDetails' description: Details for the new Pipeline. required: true /pipelines/{pipelineId}: delete: description: Deletes a Pipeline resource by identifier. operationId: DeletePipeline parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/DeleteRelatedPipelineRunsQueryParam' - $ref: '#/components/parameters/DeleteRelatedJobRunsQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Pipeline will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned Pipeline tags: - dataScience x-related-resource: '#/definitions/Pipeline' get: description: Gets a Pipeline by identifier. operationId: GetPipeline parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Pipeline with the given id. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Pipeline tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the Pipeline. operationId: UpdatePipeline parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Pipeline was successfully updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the Pipeline identified by the id tags: - dataScience x-related-resource: '#/definitions/Pipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineDetails' description: The information to be updated. required: true /pipelines/{pipelineId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangePipelineCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The Pipeline has been successfully moved. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-related-resource: '#/definitions/Pipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePipelineCompartmentDetails' description: Details for the compartment move. required: true /pipelines/{pipelineId}/steps/{stepName}/artifact: post: description: Upload the artifact for a step in the pipeline. operationId: CreateStepArtifact parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/StepNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContentLengthHeader' - $ref: '#/components/parameters/ContentDispositionHeader' responses: '204': description: Step artifact created successfully. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Upload Artifact tags: - dataScience x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/Pipeline' requestBody: content: application/octet-stream: schema: format: binary type: string description: The step artifact to upload. required: true /pipelines/{pipelineId}/steps/{stepName}/artifact/content: get: description: Download the artifact for a step in the pipeline. operationId: GetStepArtifactContent parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/StepNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RangeRequestHeader' responses: '200': description: Successfully downloaded Step artifact. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string '206': description: Successfully downloaded partial step artifact. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string content-range: description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233), section 4.2. schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Download Artifact tags: - dataScience x-obmcs-client-retries-enabled: true x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/Pipeline' head: description: Get the artifact metadata for a step in the pipeline. operationId: HeadStepArtifact parameters: - $ref: '#/components/parameters/PipelineIdPathParam' - $ref: '#/components/parameters/StepNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Step artifact metadata retrieved successfully. headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: HeadStepArtifact tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Pipeline' /projects: get: description: Lists projects in the specified compartment. operationId: ListProjects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProjectLifecycleStateQueryParam' - $ref: '#/components/parameters/CreatedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ProjectsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of projects retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ProjectSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListProjects tags: - dataScience x-obmcs-client-retries-enabled: true post: description: Creates a new project. operationId: CreateProject parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Project created successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateProject tags: - dataScience x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProjectDetails' description: Details for creating a new project. required: true /projects/{projectId}: delete: description: Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project. operationId: DeleteProject parameters: - $ref: '#/components/parameters/ProjectIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 204: $ref: '#/components/responses/204' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteProject tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Project' get: description: Gets the specified project's information. operationId: GetProject parameters: - $ref: '#/components/parameters/ProjectIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Project retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetProject tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties. operationId: UpdateProject parameters: - $ref: '#/components/parameters/ProjectIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Project updated successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateProject tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectDetails' description: Details for updating a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties. required: true /projects/{projectId}/actions/changeCompartment: post: description: Moves a project resource into a different compartment. operationId: ChangeProjectCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ProjectIdPathParam' responses: '204': description: The project was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeProjectCompartment tags: - dataScience x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProjectCompartmentDetails' description: Details for changing the compartment of a project. required: true /schedules: get: description: 'Returns a list of Schedules. ' operationId: ListSchedules parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/ScheduleLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ScheduleIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScheduleSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of ScheduleSummary objects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ScheduleSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all Schedules in a compartment tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Schedule' post: description: 'Creates a new Schedule. ' operationId: CreateSchedule parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The Schedule will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string location: description: URL for the created schedule, the schedule id will be generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new Schedule tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Schedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduleDetails' description: Details for the new Schedule. required: true /schedules/{scheduleId}: delete: description: Deletes a Schedule resource by identifier operationId: DeleteSchedule parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Schedule will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned Schedule tags: - dataScience x-related-resource: '#/definitions/Schedule' get: description: Gets a Schedule by identifier operationId: GetSchedule parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Schedule with the given id headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Schedule tags: - dataScience x-obmcs-client-retries-enabled: true put: description: Updates the Schedule operationId: UpdateSchedule parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Schedule will be updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the Schedule identified by the id tags: - dataScience x-related-resource: '#/definitions/Schedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScheduleDetails' description: The information to be updated. required: true /schedules/{scheduleId}/actions/activate: post: description: Activate schedule. operationId: ActivateSchedule parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Schedule resource will be activated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Activate schedule tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Schedule' /schedules/{scheduleId}/actions/changeCompartment: post: description: Moves a Schedule resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeScheduleCompartment parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Schedule resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Schedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeScheduleCompartmentDetails' description: The information to be updated. required: true /schedules/{scheduleId}/actions/deactivate: post: description: Deactivate schedule. operationId: DeactivateSchedule parameters: - $ref: '#/components/parameters/ScheduleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Schedule resource will be deactivated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Deactivate schedule tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Schedule' /workRequests: get: description: Lists work requests in the specified compartment. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/OperationTypeQueryParam' - $ref: '#/components/parameters/WorkRequestStatusFilterQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: List of work requests retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListWorkRequests tags: - dataScience x-obmcs-client-retries-enabled: true /workRequests/{workRequestId}: delete: description: Cancels a work request that has not started. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': description: Accepted headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CancelWorkRequest tags: - dataScience x-related-resource: '#/definitions/WorkRequest' get: description: Gets the specified work request's information. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Work request retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string retry-after: description: Indicates the number of seconds to wait before making a follow-up request. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetWorkRequest tags: - dataScience x-obmcs-client-retries-enabled: true /workRequests/{workRequestId}/errors: get: description: Lists work request errors for the specified work request. operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: '200': description: List of work request errors retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestError' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListWorkRequestErrors tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: Lists work request logs for the specified work request. operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: '200': description: List of work request logs retrieved successfully. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListWorkRequestLogs tags: - dataScience x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' components: schemas: ScheduleSummary: description: Summary representation of a schedule. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the schedule. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the schedule. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of the schedule. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the schedule. Example: `ACTIVE` ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ScheduleLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the schedule. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: "The date and time the schedule was created.\nFormat is defined by RFC3339. \nExample: `2022-08-05T01:02:29.600Z`\n" format: date-time type: string timeUpdated: description: "The date and time the schedule was updated.\nFormat is defined by RFC3339. \nExample: `2022-08-05T01:02:29.600Z`\n" format: date-time type: string trigger: $ref: '#/components/schemas/ScheduleTrigger' required: - id - displayName - compartmentId - projectId - timeCreated - createdBy - lifecycleState - trigger type: object UpdateModelDeploymentConfigurationDetails: description: The model deployment configuration details for update. discriminator: propertyName: deploymentType properties: deploymentType: description: The type of the model deployment. enum: - SINGLE_MODEL - MODEL_GROUP - SINGLE_MODEL_FLEX maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentType' type: object UpdateComputeTargetDetails: description: Details for updating a compute target. properties: computeConfigurationDetails: $ref: '#/components/schemas/UpdateComputeConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the compute target. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object metadata: additionalProperties: type: string description: 'Metadata for the compute target. The size of metadata must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall metadata is limited to 2048 bytes. Key can''t be reserved Compute Target metadata. ' type: object UpdateProjectDetails: description: Details for updating a project. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the project. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ImplementationLogDetails: description: Log configuration details for particular areas of ML Application Implementation. properties: enableLogging: default: false description: If logging is enabled. type: boolean logGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the log group. type: string logId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the log. type: string type: object MlApplicationImplementationVersion: description: Read-only fully managed snapshot of MlApplicationImplementation taken when MlApplicationImplementation was updated with new ML Application package. properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array applicationComponents: description: List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package. items: $ref: '#/components/schemas/ApplicationComponent' type: array configurationSchema: description: Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. items: $ref: '#/components/schemas/ConfigurationPropertySchema' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of ML Application Implementation defined in ML Application package descriptor maxLength: 1024 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationImplementationVersion. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 1024 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationImplementationVersion. enum: - CREATING - ACTIVE - FAILED - DELETING type: string mlApplicationId: description: The OCID of the ML Application implemented by this ML Application Implementation. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: The OCID of the MlApplicationImplementation for which this resource keeps the historical state. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId) maxLength: 255 minLength: 1 type: string mlApplicationPackageArguments: $ref: '#/components/schemas/MlApplicationPackageArguments' name: description: ML Application Implementation name which is unique for given ML Application. maxLength: 255 minLength: 1 type: string packageVersion: description: The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation time of MlApplicationImplementationVersion in the format defined by RFC 3339. format: date-time type: string required: - id - mlApplicationImplementationId - name - mlApplicationId - mlApplicationName - timeCreated - lifecycleState - lifecycleDetails - freeformTags - definedTags type: object NotebookSessionConfigDetails: description: Details for the notebook session configuration. properties: blockStorageSizeInGBs: default: 100 description: 'A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. ' example: 100 maximum: 10240 minimum: 50 type: integer notebookSessionShapeConfigDetails: $ref: '#/components/schemas/NotebookSessionShapeConfigDetails' privateEndpointId: description: 'The OCID of a Data Science private endpoint. ' maxLength: 255 minLength: 1 type: string shape: description: 'The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. ' example: VM.Standard.E3.Flex type: string subnetId: description: 'A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. ' maxLength: 255 minLength: 1 type: string required: - shape Error: description: Error schema. properties: code: description: 'A short error code that defines the error, which is meant for programmatic parsing. See [API Errors](/Content/General/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message CategoryLogDetails: description: The log details for each category. properties: access: $ref: '#/components/schemas/LogDetails' predict: $ref: '#/components/schemas/LogDetails' type: object MlApplicationInstanceViewCollection: description: Results of a MlApplicationInstanceView search. It contains list of MlApplicationInstanceViewSummary items. properties: items: description: List of MlApplicationInstanceViews. items: $ref: '#/components/schemas/MlApplicationInstanceViewSummary' type: array required: - items type: object ChangeProjectCompartmentDetails: description: Details for changing the compartment of a project. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateModelDeploymentDetails: description: 'Details for updating a model deployment. You can update `modelDeploymentConfigurationDetails` and change `instanceShapeName` and `modelId` when the model deployment is in the ACTIVE lifecycle state. The `bandwidthMbps` or `instanceCount` can only be updated while the model deployment is in the `INACTIVE` state. Changes to the `bandwidthMbps` or `instanceCount` will take effect the next time the `ActivateModelDeployment` action is invoked on the model deployment resource. ' properties: categoryLogDetails: $ref: '#/components/schemas/UpdateCategoryLogDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model deployment. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object modelDeploymentConfigurationDetails: $ref: '#/components/schemas/UpdateModelDeploymentConfigurationDetails' Pipeline: description: A Pipeline to orchestrate and execute machine learning workflows. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the pipeline. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the pipeline. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. maxLength: 255 minLength: 1 type: string infrastructureConfigurationDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the pipeline. enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleState' logConfigurationDetails: $ref: '#/components/schemas/PipelineLogConfigurationDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline with. maxLength: 255 minLength: 1 type: string stepDetails: description: Array of step details for each step. items: $ref: '#/components/schemas/PipelineStepDetails' maxItems: 30 minItems: 1 type: array storageMountConfigurationDetailsList: description: The storage mount details to mount to the instance running the pipeline step. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' maxItems: 5 minItems: 0 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - createdBy - projectId - compartmentId - displayName - stepDetails - lifecycleState type: object JobEnvironmentConfigurationDetails: description: Environment configuration to capture job runtime dependencies. discriminator: propertyName: jobEnvironmentType properties: jobEnvironmentType: description: The environment configuration type used for job runtime. enum: - OCIR_CONTAINER type: string required: - jobEnvironmentType type: object UpdateModelProvenanceDetails: description: Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained. properties: gitBranch: description: For model reproducibility purposes. Branch of the git repository associated with model training. example: master maxLength: 255 minLength: 1 type: string gitCommit: description: For model reproducibility purposes. Commit ID of the git repository associated with model training. example: 0978b63 maxLength: 255 minLength: 1 type: string repositoryUrl: description: For model reproducibility purposes. URL of the git repository associated with model training. example: http://git-remote.com/my-repo maxLength: 255 minLength: 1 type: string scriptDir: description: For model reproducibility purposes. Path to model artifacts. maxLength: 255 minLength: 1 type: string trainingId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes. example: ocid1.datasciencenotebooksession.oc1.iad.amaaaaaav66vvniaxe2qpktdlwtcvhkuq467mz2n46pf2swol23bmjh3r4wq maxLength: 255 minLength: 1 type: string trainingScript: description: 'For model reproducibility purposes. Path to the python script or notebook in which the model was trained." ' example: model-dev/model1/model-training.ipynb maxLength: 255 minLength: 1 type: string type: object JobNodeConfigurationDetails: description: The job node configuration details discriminator: propertyName: jobNodeType properties: jobNodeType: description: The node type used for job run. enum: - MULTI_NODE type: string required: - jobNodeType type: object JobConfigurationDetails: description: 'The job configuration details ' discriminator: propertyName: jobType properties: jobType: description: The type of job. enum: - DEFAULT - EMPTY type: string required: - jobType MlApplication: description: Resource representing a definition of an AI/ML use-case properties: compartmentId: description: The OCID of the compartment where the MlApplication is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Optional description of the ML Application maxLength: 1024 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplication. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 1024 minLength: 1 type: string lifecycleState: description: The current state of the MlApplication. enum: - ACTIVE - FAILED type: string name: description: The name of MlApplication. It is unique in a given tenancy. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation time of MlApplication in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: Time of last MlApplication update in the format defined by RFC 3339. format: date-time type: string required: - id - name - compartmentId - timeCreated - timeUpdated - lifecycleState - lifecycleDetails - freeformTags - definedTags type: object ChangeMlApplicationImplementationCompartmentDetails: description: The information to be updated. properties: compartmentId: description: The OCID of the compartment into which the resource should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object JobInfrastructureConfigurationDetails: description: 'The job infrastructure configuration details (shape, block storage, etc.) ' discriminator: propertyName: jobInfrastructureType properties: jobInfrastructureType: description: The infrastructure type used for job run. enum: - STANDALONE - ME_STANDALONE - MULTI_NODE - EMPTY - MANAGED_COMPUTE_CLUSTER type: string required: - jobInfrastructureType type: object CreatePipelineDetails: description: The information about new Pipeline. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the pipeline. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string x-default-description: The value will be set to a service generated display name freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object infrastructureConfigurationDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' logConfigurationDetails: $ref: '#/components/schemas/PipelineLogConfigurationDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline with. maxLength: 255 minLength: 1 type: string stepDetails: description: Array of step details for each step. items: $ref: '#/components/schemas/PipelineStepDetails' maxItems: 30 minItems: 1 type: array storageMountConfigurationDetailsList: description: The storage mount details to mount to the instance running the pipeline step. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' maxItems: 5 minItems: 0 type: array required: - projectId - compartmentId - stepDetails type: object ChangeJobRunCompartmentDetails: description: Details for changing the compartment of a job run. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateMlApplicationImplementationDetails: description: The information to be updated. properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logging: $ref: '#/components/schemas/ImplementationLogging' type: object UpdateCategoryLogDetails: description: The log details for each category for update. properties: access: $ref: '#/components/schemas/LogDetails' predict: $ref: '#/components/schemas/LogDetails' type: object ModelVersionSet: description: A model version set to associate different versions of machine learning models. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model version set. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model version set. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model version set. enum: - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelVersionSetLifecycleState' name: description: A user-friendly name for the resource. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model version set. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - compartmentId - projectId - name - description - lifecycleState - timeCreated - timeUpdated - createdBy type: object MlApplicationInstanceSummary: description: Summary of the MlApplicationInstance. properties: compartmentId: description: The OCID of the compartment where you the MlApplicationInstance is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of MlApplicationInstance. System will generate displayName when not provided during creation. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationInstance. Unique identifier that is immutable after creation maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationInstance. type: string x-obmcs-enumref: '#/definitions/MlApplicationInstance/lifecycleState' lifecycleSubstate: description: The current substate of the MlApplicationInstance. The substate has MlApplicationInstance specific values in comparison with lifecycleState which has standard values common for all OCI resources. type: string x-obmcs-enumref: '#/definitions/MlApplicationInstance/lifecycleSubstate' mlApplicationId: description: The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) maxLength: 255 minLength: 1 type: string mlApplicationImplementationName: description: The name of Ml Application Implementation (based on mlApplicationImplementationId) maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the MlApplication was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - mlApplicationId - mlApplicationName - mlApplicationImplementationId - mlApplicationImplementationName - compartmentId - timeCreated - lifecycleState - lifecycleSubstate type: object TriggerMlApplicationInstanceFlowDetails: description: Payload for trigger request endpoint properties: triggerName: description: Name of trigger maxLength: 255 minLength: 1 type: string required: - triggerName type: object UpdatePipelineDetails: description: The information of pipeline to be updated. properties: configurationDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description for the resource. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object infrastructureConfigurationDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' logConfigurationDetails: $ref: '#/components/schemas/PipelineLogConfigurationDetails' stepDetails: description: Array of update details for each step. Only step configurations and step infrastructure configurations are allowed to be updated. items: $ref: '#/components/schemas/PipelineStepUpdateDetails' maxItems: 30 minItems: 1 type: array storageMountConfigurationDetailsList: description: The storage mount details to mount to the instance running the pipeline step. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' maxItems: 5 minItems: 0 type: array type: object JobSummary: description: Summary information for a job. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the project. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the job. enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/JobLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job with. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - createdBy - projectId - compartmentId - lifecycleState Model: description: Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts. properties: backupOperationDetails: $ref: '#/components/schemas/BackupOperationDetails' backupSetting: $ref: '#/components/schemas/BackupSetting' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model. maxLength: 255 minLength: 1 type: string customMetadataList: description: An array of custom metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedMetadataList: description: An array of defined metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model. maxLength: 255 minLength: 1 type: string inputSchema: description: Input schema file content in String format example: '{"predict_arguments":{"sepal_length_(cm)":{"type":"continuous","dtype":"float64"},"sepal_width_(cm)":{"type":"continuous","dtype":"float64"},"petal_length_(cm)":{"type":"continuous","dtype":"float64"},"petal_width_(cm)":{"type":"continuous","dtype":"float64"}},"predict_response":{"target":{"type":"categorical","dtype":"category"}},"problem_type":"multiclass_classification"}' type: string lifecycleDetails: description: Details about the lifecycle state of the model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model. enum: - ACTIVE - DELETED - FAILED - INACTIVE example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelLifecycleState' modelVersionSetId: description: The OCID of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string modelVersionSetName: description: The name of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string outputSchema: description: Output schema file content in String format example: '{"class":3,"probabilities":[0.1,0.2,0.7]}' type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. maxLength: 255 minLength: 1 type: string retentionOperationDetails: $ref: '#/components/schemas/RetentionOperationDetails' retentionSetting: $ref: '#/components/schemas/RetentionSetting' timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string versionId: description: Unique identifier assigned to each version of the model. format: int64 type: integer versionLabel: description: The version label can add an additional description of the lifecycle state of the model or the application using and training the model. maxLength: 255 minLength: 1 type: string required: - compartmentId - projectId - id - displayName - lifecycleState - timeCreated - createdBy - modelVersionSetId - modelVersionSetName - versionId - versionLabel - lifecycleDetails - retentionSetting - backupSetting - retentionOperationDetails - backupOperationDetails type: object MlApplicationInstanceViewSummary: description: Summary of the MlApplicationInstanceView. properties: compartmentId: description: The OCID of the compartment where the MlApplicationInstanceView is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of the MlApplicationInstance (created by the consumer) which this MlApplicationInstanceView is mirroring. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationInstanceView. Unique identifier that is immutable after creation maxLength: 255 minLength: 1 type: string isEnabled: description: This field is a copy from MlApplicationInstance created by the consumer. States whether the MlApplicationInstance is supposed to be in ACTIVE lifecycle state. type: boolean lifecycleState: description: The current state of the MlApplicationInstance(View). type: string x-obmcs-enumref: '#/definitions/MlApplicationInstanceView/lifecycleState' lifecycleSubstate: description: The current substate of the MlApplicationInstance. The substate has MlApplicationInstance specific values in comparison with lifecycleState which has standard values common for all OCI resources. type: string x-obmcs-enumref: '#/definitions/MlApplicationInstanceView/lifecycleSubstate' mlApplicationId: description: The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: This field is a copy from MlApplicationInstance created by the consumer. The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) maxLength: 255 minLength: 1 type: string mlApplicationImplementationName: description: This field is a copy from MlApplicationInstance created by the consumer. The name of Ml Application Implemenation (based on mlApplicationImplementationId) maxLength: 255 minLength: 1 type: string mlApplicationImplementationVersionId: description: The OCID of the currently used MlApplicationImplementationVersion maxLength: 255 minLength: 1 type: string mlApplicationInstanceId: description: The OCID of the MlApplicationInstance (created by the consumer) which this MlApplicationInstanceView is mirroring. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string packageVersion: description: Version of MlApplication package which is currently used by this MlApplicationInstance. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the MlApplicationInstanceView was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - mlApplicationId - mlApplicationName - mlApplicationInstanceId - mlApplicationImplementationId - mlApplicationImplementationName - packageVersion - mlApplicationImplementationVersionId - isEnabled - compartmentId - timeCreated - lifecycleState - lifecycleSubstate type: object ScheduleAction: description: The schedule action discriminator: propertyName: actionType properties: actionType: description: The Schedule Action type enum: - HTTP type: string required: - actionType type: object ModelVersionSetSummary: description: Summary information for a model version set. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model version set. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model version set. enum: - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelVersionSetLifecycleState' name: description: A user-friendly name for the resource. It must be unique and can't be modified. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model version set. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - compartmentId - projectId - name - lifecycleState - timeCreated - timeUpdated - createdBy type: object ModelSummary: description: Summary information for a model. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model. enum: - ACTIVE - DELETED - FAILED - INACTIVE example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelLifecycleState' modelVersionSetId: description: The OCID of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string modelVersionSetName: description: The name of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string versionId: description: Unique identifier assigned to each version of the model. format: int64 type: integer versionLabel: description: The version label can add an additional description of the lifecycle state of the model or the application using and training the model. maxLength: 255 minLength: 1 type: string required: - compartmentId - projectId - id - displayName - lifecycleState - timeCreated - createdBy - modelVersionSetId - modelVersionSetName - versionId - versionLabel type: object NotebookSessionSummary: description: Summary information for a notebook session. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the notebook session. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My NotebookSession` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the notebook session. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE - UPDATING example: CREATING maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/NotebookSessionLifecycleState' notebookSessionConfigDetails: $ref: '#/components/schemas/NotebookSessionConfigDetails' notebookSessionConfigurationDetails: $ref: '#/components/schemas/NotebookSessionConfigurationDetails' notebookSessionUrl: description: The URL to interact with the notebook session. type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the notebook session. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - projectId - createdBy - compartmentId - lifecycleState DataSciencePrivateEndpointSummary: description: 'List of Data Science private endpoints. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create private Endpoint. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user that created the private endpoint. maxLength: 255 minLength: 1 type: string dataScienceResourceType: description: Data Science resource type. enum: - NOTEBOOK_SESSION - MODEL_DEPLOYMENT example: NOTEBOOK_SESSION maxLength: 50 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/DataScienceResourceType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string fqdn: description: 'Accesing Data Science resource using FQDN. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details of the state of a private endpoint. maxLength: 400 minLength: 1 type: string lifecycleState: description: State of a private endpoint. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: ACTIVE maxLength: 50 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/DataSciencePrivateEndpointLifecycleState' nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array subnetId: description: 'The OCID of a subnet. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time that the Data Science private endpoint was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the Data Science private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - definedTags - displayName - freeformTags - id - lifecycleState - lifecycleDetails - createdBy - dataScienceResourceType - subnetId - fqdn - timeCreated - timeUpdated type: object UpdateModelGroupDetails: description: Details for updating a modelGroup. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the modelGroup. maxLength: 400 minLength: 1 type: string displayName: description: "A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.\n Example: `My ModelGroup`\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object modelGroupVersionHistoryId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model group version history to which the modelGroup will be associated. maxLength: 255 minLength: 1 type: string versionLabel: description: An additional description of the lifecycle state of the model group. maxLength: 400 minLength: 1 type: string type: object UpdateDataSciencePrivateEndpointDetails: description: 'The details required to update a private endpoint. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array type: object WorkRequestSummary: description: Summary information for a work request. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request's compartment. example: ocid1.compartment.oc1..aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. example: ocid1.datascienceworkrequest.oc1.iad.aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string operationType: description: The type of work the work request is doing. enum: - NOTEBOOK_SESSION_CREATE - NOTEBOOK_SESSION_DELETE - NOTEBOOK_SESSION_ACTIVATE - NOTEBOOK_SESSION_DEACTIVATE - MODELVERSIONSET_DELETE - EXPORT_MODEL_ARTIFACT - IMPORT_MODEL_ARTIFACT - MODEL_DEPLOYMENT_CREATE - MODEL_DEPLOYMENT_DELETE - MODEL_DEPLOYMENT_ACTIVATE - MODEL_DEPLOYMENT_DEACTIVATE - MODEL_DEPLOYMENT_UPDATE - PROJECT_DELETE - WORKREQUEST_CANCEL - JOB_DELETE - PIPELINE_CREATE - PIPELINE_DELETE - PIPELINE_RUN_CREATE - PIPELINE_RUN_CANCEL - PIPELINE_RUN_DELETE - ML_APPLICATION_PACKAGE_UPLOAD - ML_APPLICATION_TRIGGER_START - ML_APPLICATION_IMPLEMENTATION_DELETE - ML_APPLICATION_IMPLEMENTATION_UPDATE - ML_APPLICATION_IMPLEMENTATION_MOVE - ML_APPLICATION_INSTANCE_CREATE - ML_APPLICATION_INSTANCE_UPDATE - ML_APPLICATION_INSTANCE_DELETE - ML_APPLICATION_INSTANCE_MOVE - ML_APPLICATION_INSTANCE_VIEW_CREATE - ML_APPLICATION_INSTANCE_VIEW_UPDATE - ML_APPLICATION_INSTANCE_VIEW_DELETE - ML_APPLICATION_INSTANCE_VIEW_UPGRADE - ML_APPLICATION_INSTANCE_VIEW_MOVE - PRIVATE_ENDPOINT_CREATE - PRIVATE_ENDPOINT_DELETE - PRIVATE_ENDPOINT_MOVE - PRIVATE_ENDPOINT_UPDATE - SCHEDULE_CREATE - SCHEDULE_UPDATE - SCHEDULE_DELETE - SCHEDULE_MOVE - SCHEDULE_ACTIVATE - SCHEDULE_DEACTIVATE - RESTORE_ARCHIVED_MODEL - COMPUTE_TARGET_CREATE - COMPUTE_TARGET_UPDATE - COMPUTE_TARGET_DELETE - MODEL_GROUP_CREATE - MODEL_GROUP_UPDATE - MODEL_GROUP_DELETE - MODEL_GROUP_VERSION_HISTORY_DELETE example: NOTEBOOK_SESSION_CREATE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' percentComplete: description: Percentage of the request completed. example: 100.0 format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED example: SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: The date and time the work request was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The date and time the work request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the work request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - operationType - status - id - compartmentId - percentComplete - resources - timeAccepted type: object MlApplicationInstanceCollection: description: Results of a mlApplicationInstance search. It contains list of MlApplicationInstanceSummary items. properties: items: description: List of MlApplicationInstanceSummaries. items: $ref: '#/components/schemas/MlApplicationInstanceSummary' type: array required: - items type: object PipelineRun: description: Description of PipelineRun. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline run. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' configurationOverrideDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the pipeline run. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run. maxLength: 255 minLength: 1 type: string infrastructureConfigurationOverrideDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the pipeline run. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETING - DELETED example: IN_PROGRESS maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/PipelineRunLifecycleState' logConfigurationOverrideDetails: $ref: '#/components/schemas/PipelineLogConfigurationDetails' logDetails: $ref: '#/components/schemas/PipelineRunLogDetails' pipelineId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline run with. maxLength: 255 minLength: 1 type: string stepOverrideDetails: description: Array of step override details. Only Step Configuration is allowed to be overridden. items: $ref: '#/components/schemas/PipelineStepOverrideDetails' maxItems: 30 minItems: 1 type: array stepRuns: description: Array of StepRun object for each step. items: $ref: '#/components/schemas/PipelineStepRun' maxItems: 30 minItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeAccepted: description: The date and time the pipeline run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The date and time the pipeline run was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - timeAccepted - createdBy - projectId - compartmentId - pipelineId - displayName - stepRuns - lifecycleState type: object UpdateMlApplicationInstanceDetails: description: The information to be updated. properties: configuration: description: Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplication. items: $ref: '#/components/schemas/ConfigurationProperty' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Switches lifecycle state of MlApplicationInstance from INACTIVE to ACTIVE (true value) or vice versa (false value). type: boolean mlApplicationImplementationId: description: The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) used for the given instance. maxLength: 255 minLength: 1 type: string type: object UpdateModelGroupVersionHistoryDetails: description: Details for updating a model group version history. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model group version history. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object latestModelGroupId: description: The OCID of the latest version of the model group associated. maxLength: 255 minLength: 1 type: string type: object ComputeTargetSummary: description: Summary information for a Compute Target. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with the compute target. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the compute target. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the compute target. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ComputeTargetLifecycleState' timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - displayName - timeCreated - createdBy - compartmentId - lifecycleState ChangeScheduleCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangePipelineRunCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeModelVersionSetCompartmentDetails: description: Details for changing the compartment of a model version set. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Schedule: description: 'A repeating action. Examples: * Invoke a ML Pipeline Run once an hour. * Call ML Job Run every night at midnight. ' properties: action: $ref: '#/components/schemas/ScheduleAction' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the schedule. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the schedule. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the schedule. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. Avoid entering confidential information. maxLength: 64 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule. maxLength: 255 minLength: 1 type: string lastScheduleRunDetails: description: 'Details about the action performed by the last schedule execution. Example: `Invoked ML Application trigger.` ' maxLength: 400 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. type: string lifecycleState: description: "The current state of the schedule. \nExample: `ACTIVE`\n" enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ScheduleLifecycleState' logDetails: $ref: '#/components/schemas/ScheduleLogDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the schedule. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: "The date and time the schedule was created.\nFormat is defined by RFC3339. \nExample: `2022-08-05T01:02:29.600Z`\n" format: date-time type: string timeLastScheduleRun: description: 'The last schedule execution time. Format is defined by RFC3339. Example: `2022-08-05T01:02:29.600Z` ' format: date-time type: string timeNextScheduledRun: description: 'The next scheduled execution time for the schedule. Format is defined by RFC3339. Example: `2022-08-05T01:02:29.600Z` ' format: date-time type: string timeUpdated: description: "The date and time the schedule was updated.\nFormat is defined by RFC3339. \nExample: `2022-09-05T01:02:29.600Z`\n" format: date-time type: string trigger: $ref: '#/components/schemas/ScheduleTrigger' required: - id - compartmentId - projectId - displayName - timeCreated - createdBy - lifecycleState - trigger - action type: object UpdateNotebookSessionDetails: description: 'Details for updating a notebook session. `notebookSessionConfigurationDetails` can only be updated while the notebook session is in the `INACTIVE` state. Changes to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My NotebookSession` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object notebookSessionConfigurationDetails: $ref: '#/components/schemas/NotebookSessionConfigurationDetails' notebookSessionRuntimeConfigDetails: $ref: '#/components/schemas/NotebookSessionRuntimeConfigDetails' notebookSessionStorageMountConfigurationDetailsList: description: Collection of NotebookSessionStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array LogDetails: description: The log details. properties: logGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a log group to work with. maxLength: 255 minLength: 1 type: string logId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a log to work with. maxLength: 255 minLength: 1 type: string required: - logId - logGroupId type: object JobRunLogDetails: description: 'Customer logging details for job run. ' properties: logGroupId: description: 'The log group id for where log objects will be for job runs. ' maxLength: 255 minLength: 1 type: string logId: description: 'The log id of the log object the job run logs will be shipped to. ' maxLength: 255 minLength: 1 type: string required: - logGroupId - logId ModelGroupModelSummary: description: Summary information for a model associated with the model group. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name of the model. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model group. maxLength: 255 minLength: 1 type: string inferenceKey: description: SaaS friendly name of the model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model. enum: - ACTIVE - DELETED - FAILED - INACTIVE example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelLifecycleState' modelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - modelId - compartmentId - projectId - displayName - createdBy - timeCreated - timeUpdated - lifecycleState - lifecycleDetails type: object ApplicationComponent: description: Reference to an application component discriminator: propertyName: type properties: componentName: description: Name of application component maxLength: 255 minLength: 1 type: string name: description: Name of referenced resource (generally resources do not have to have any name but most resources have name exposed as 'name' or 'displayName' field). maxLength: 255 minLength: 1 type: string type: description: Type of application component enum: - DATA_SCIENCE_PIPELINE - DATA_SCIENCE_JOB - DATA_SCIENCE_MODEL - DATA_FLOW_APPLICATION - GENERIC_OCI_RESOURCE type: string required: - type - componentName type: object PipelineStepOverrideDetails: description: Override details of the step. Only Step Configuration is allowed to be overridden. properties: stepConfigurationDetails: $ref: '#/components/schemas/PipelineStepConfigurationDetails' stepContainerConfigurationDetails: $ref: '#/components/schemas/PipelineContainerConfigurationDetails' stepDataflowConfigurationDetails: $ref: '#/components/schemas/PipelineDataflowConfigurationDetails' stepInfrastructureConfigurationDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' stepName: description: The name of the step. maxLength: 64 minLength: 1 type: string required: - stepName - stepConfigurationDetails type: object TriggerParameter: description: Trigger parameter properties: name: description: Name of trigger parameter maxLength: 255 minLength: 1 type: string value: description: Value of trigger parameter maxLength: 255 minLength: 1 type: string required: - name - value type: object ChangeMlApplicationInstanceCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PipelineDataflowConfigurationDetails: description: The configuration details of a Dataflow step. properties: configuration: description: The Spark configuration passed to the running process. type: object driverShape: description: The VM shape for the driver. example: VM.STANDARD2.4 maxLength: 255 minLength: 1 type: string driverShapeConfigDetails: $ref: '#/components/schemas/PipelineShapeConfigDetails' executorShape: description: The VM shape for the executors. example: VM.STANDARD2.4 maxLength: 255 minLength: 1 type: string executorShapeConfigDetails: $ref: '#/components/schemas/PipelineShapeConfigDetails' logsBucketUri: description: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. maxLength: 1024 minLength: 1 type: string numExecutors: description: The number of executor VMs requested. minimum: 1 type: integer warehouseBucketUri: description: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. maxLength: 1024 minLength: 1 type: string PipelineConfigurationDetails: description: The configuration details of a pipeline. discriminator: propertyName: type properties: type: description: The type of pipeline. enum: - DEFAULT type: string required: - type CreateJobRunDetails: description: 'Parameters needed to create a new job run. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job run. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobConfigurationOverrideDetails: $ref: '#/components/schemas/JobConfigurationDetails' jobEnvironmentConfigurationOverrideDetails: $ref: '#/components/schemas/JobEnvironmentConfigurationDetails' jobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job to create a run for. maxLength: 255 minLength: 1 type: string jobInfrastructureConfigurationOverrideDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobLogConfigurationOverrideDetails: $ref: '#/components/schemas/JobLogConfigurationDetails' jobNodeConfigurationOverrideDetails: $ref: '#/components/schemas/JobNodeConfigurationDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job run with. maxLength: 255 minLength: 1 type: string required: - projectId - compartmentId - jobId MlApplicationImplementationSummary: description: Summary of the MlApplicationImplementation. properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: The OCID of the compartment where the MlApplicationImplementation is created. maxLength: 255 minLength: 1 type: string configurationSchema: description: Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. items: $ref: '#/components/schemas/ConfigurationPropertySchema' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of ML Application Implementation defined in ML Application package descriptor maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the ML Application Implementation. type: string x-obmcs-enumref: '#/definitions/MlApplicationImplementation/lifecycleState' mlApplicationId: description: The OCID of the ML Application implemented by this ML Application Implementation. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string name: description: ML Application Implementation name which is unique for given ML Application. maxLength: 255 minLength: 1 type: string packageVersion: description: The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the MlApplicationImplementation was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - name - mlApplicationId - mlApplicationName - compartmentId - timeCreated - lifecycleState - freeformTags - definedTags type: object CreateAuthConfigurationDetails: description: AuthN/Z configuration for online prediction discriminator: propertyName: type properties: type: description: Type of AuthN/Z type: string x-obmcs-enumref: '#/definitions/AuthConfiguration/type' required: - type type: object ChangeJobCompartmentDetails: description: Details for changing the compartment of a job. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ModelDeploymentModelStateSummary: description: Status of the model in a model group deployment. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inferenceKey: description: SaaS friendly name for the model OCID. maxLength: 32 minLength: 1 type: string modelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the deployed model in model deployment. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. maxLength: 255 minLength: 1 type: string state: description: The state of the deployed model in model deployment. enum: - SUCCESS - FAILED - INCONSISTENT type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - modelId - inferenceKey - displayName - projectId - state type: object BackupSetting: description: Back up setting details of the model. properties: backupRegion: description: OCI backup region for the model. maxLength: 255 minLength: 1 type: string customerNotificationType: description: Customer notification on backup success/failure events. enum: - NONE - ALL - ON_FAILURE - ON_SUCCESS example: ALL type: string x-obmcs-top-level-enum: '#/definitions/ModelSettingCustomerNotificationType' isBackupEnabled: description: Boolean flag representing whether backup needs to be enabled/disabled for the model. type: boolean required: - isBackupEnabled - backupRegion ModelGroupSummary: description: Summary information for a modelGroup. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the modelGroup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model. enum: - CREATING - ACTIVE - FAILED - INACTIVE - DELETING - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupLifecycleState' modelGroupDetails: $ref: '#/components/schemas/ModelGroupDetails' modelGroupVersionHistoryId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model group version history to which the modelGroup is associated. maxLength: 255 minLength: 1 type: string modelGroupVersionHistoryName: description: The name of the model group version history to which the model group is associated. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the modelGroup. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string versionId: description: Unique identifier assigned to each version of the model group. It would be auto-incremented number generated by service. format: int64 type: integer versionLabel: description: An additional description of the lifecycle state of the model group. maxLength: 400 minLength: 1 type: string required: - id - compartmentId - projectId - displayName - lifecycleState - timeCreated - timeUpdated - createdBy - modelGroupDetails type: object ProjectSummary: description: Summary information for a project. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the project. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the project. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the project. enum: - ACTIVE - DELETING - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ProjectLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - createdBy - compartmentId - lifecycleState ModelProvenance: description: Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained. properties: gitBranch: description: For model reproducibility purposes. Branch of the git repository associated with model training. example: master maxLength: 255 minLength: 1 type: string gitCommit: description: For model reproducibility purposes. Commit ID of the git repository associated with model training. example: 0978b63 maxLength: 255 minLength: 1 type: string repositoryUrl: description: For model reproducibility purposes. URL of the git repository associated with model training. example: http://git-remote.com/my-repo maxLength: 255 minLength: 1 type: string scriptDir: description: For model reproducibility purposes. Path to model artifacts. maxLength: 255 minLength: 1 type: string trainingId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes. example: ocid1.datasciencenotebooksession.oc1.iad.amaaaaaav66vvniaxe2qpktdlwtcvhkuq467mz2n46pf2swol23bmjh3r4wq maxLength: 255 minLength: 1 type: string trainingScript: description: 'For model reproducibility purposes. Path to the python script or notebook in which the model was trained." ' example: model-dev/model1/model-training.ipynb maxLength: 255 minLength: 1 type: string type: object AuthConfiguration: description: AuthN/Z configuration for online prediction discriminator: propertyName: type properties: type: description: Type of AuthN/Z enum: - IDCS - IAM - IDCS_CUSTOM_SERVICE type: string required: - type type: object InstanceComponent: description: Reference to instance component discriminator: propertyName: type properties: componentName: description: Name of instance component maxLength: 255 minLength: 1 type: string name: description: Name of referenced resource (generally resources do not have to have any name but most resources have name exposed as 'name' or 'displayName' field). maxLength: 1024 minLength: 1 type: string type: description: Type of instance component enum: - DATA_SCIENCE_MODEL_DEPLOYMENT - OBJECT_STORAGE_BUCKET - OBJECT_STORAGE_OBJECT - ML_APPLICATION_INSTANCE_INTERNAL_TRIGGER - DATA_SCIENCE_SCHEDULE - GENERIC_OCI_RESOURCE type: string required: - type - componentName ModelDeploymentSystemData: description: Model deployment system data. discriminator: propertyName: systemInfraType properties: modelType: description: The type of the deployed model. enum: - MANAGED_MODEL example: MANAGED_MODEL type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentModelType' systemInfraType: description: The infrastructure type of the model deployment. enum: - INSTANCE_POOL - MANAGED_COMPUTE_CLUSTER type: string PipelineLogConfigurationDetails: description: The pipeline log configuration details. properties: enableAutoLogCreation: default: false description: If automatic on-behalf-of log object creation is enabled for pipeline runs. type: boolean enableLogging: default: false description: If customer logging is enabled for pipeline. type: boolean logGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the log group. type: string logId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the log. type: string type: object ChangePipelineCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object NotebookSessionGitConfigDetails: description: Git configuration Details. properties: notebookSessionGitRepoConfigCollection: description: A collection of Git repository configurations. items: $ref: '#/components/schemas/NotebookSessionGitRepoConfigDetails' maxItems: 3 type: array type: object PredictionEndpointDetails: description: Prediction endpoint related information. properties: basePredictionUri: description: Base URI of prediction router. maxLength: 1024 minLength: 1 type: string predictionUris: description: Array of all prediction URIs per use-case. items: $ref: '#/components/schemas/PredictionUri' type: array required: - basePredictionUri - predictionUris type: object PredictionUri: description: Prediction URI per use-case. properties: uri: description: Prediction URI. maxLength: 1024 minLength: 1 type: string useCase: description: Prediction use-case. maxLength: 255 minLength: 1 type: string required: - useCase - uri type: object CustomMetadata: description: Array of custom metadata details of model group. properties: category: description: Category of the metadata. example: GPU Configuration minLength: 1 type: string description: description: Description of model metadata. example: The GPU configuration specific for the model group minLength: 1 type: string key: description: Key of the metadata. minLength: 1 type: string value: description: Value of the metadata. minLength: 1 type: string type: object UpdateJobDetails: description: Details for updating a job. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the job. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobInfrastructureConfigurationDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobStorageMountConfigurationDetailsList: description: Collection of JobStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array ExportModelArtifactDetails: description: Details required for exporting the model artifact from source to service bucket properties: artifactExportDetails: $ref: '#/components/schemas/ArtifactExportDetails' required: - artifactExportDetails type: object RetentionOperationDetails: description: Retention operation details for the model. properties: archiveState: description: The archival status of model. enum: - PENDING - FAILED - SUCCEEDED example: PENDING type: string x-obmcs-top-level-enum: '#/definitions/ModelSettingActionState' archiveStateDetails: description: The archival state details of the model. maxLength: 255 type: string deleteState: description: The deletion status of the archived model. enum: - PENDING - FAILED - SUCCEEDED example: PENDING type: string x-obmcs-top-level-enum: '#/definitions/ModelSettingActionState' deleteStateDetails: description: The deletion status details of the archived model. maxLength: 255 type: string timeArchivalScheduled: description: The estimated archival time of the model based on the provided retention setting. format: date-time type: string timeDeletionScheduled: description: The estimated deletion time of the model based on the provided retention setting. format: date-time type: string required: - archiveState - archiveStateDetails - timeArchivalScheduled - deleteState - deleteStateDetails - timeDeletionScheduled ChangeMlApplicationInstanceViewCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateMlApplicationImplementationVersionDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object PipelineStepUpdateDetails: description: The details of the step to update. discriminator: propertyName: stepType properties: description: description: A short description of the step. maxLength: 128 minLength: 1 type: string x-default-description: 'null' stepConfigurationDetails: $ref: '#/components/schemas/PipelineStepConfigurationDetails' stepName: description: The name of the step. maxLength: 64 minLength: 1 type: string stepType: description: The type of step. enum: - ML_JOB - CUSTOM_SCRIPT - CONTAINER - DATAFLOW type: string required: - stepType - stepName MlApplicationInstanceView: description: Representation of ML Application Instance which providers use for instance observability. properties: authConfiguration: $ref: '#/components/schemas/AuthConfiguration' compartmentId: description: The OCID of the compartment where the MlApplicationInstanceView is created. maxLength: 255 minLength: 1 type: string configuration: description: This field is a copy from MlApplicationInstance created by the consumer. Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplication. items: $ref: '#/components/schemas/ConfigurationProperty' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of the MlApplicationInstance (created by the consumer) which this MlApplicationInstanceView is mirroring. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationInstanceView. Unique identifier that is immutable after creation maxLength: 255 minLength: 1 type: string instanceComponents: description: References (Identifiers) for components dedicated to this instance. items: $ref: '#/components/schemas/InstanceComponent' type: array isEnabled: description: This field is a copy from MlApplicationInstance created by the consumer. States whether the MlApplicationInstance is supposed to be in ACTIVE lifecycle state. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 1024 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationInstance(View). enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string lifecycleSubstate: description: 'The current substate of the MlApplicationInstance(View). The substate has MlApplicationInstance(View) specific values in comparison with lifecycleState which has standard values common for all OCI resources. The NEEDS_ATTENTION and FAILED substates are deprecated in favor of (NON_)?RECOVERABLE_(PROVIDER|SERVICE)_ISSUE and will be removed in next release. ' enum: - CREATING - UPDATING - UPGRADING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED - NON_RECOVERABLE_PROVIDER_ISSUE - RECOVERABLE_PROVIDER_ISSUE - NON_RECOVERABLE_SERVICE_ISSUE - RECOVERABLE_SERVICE_ISSUE type: string mlApplicationId: description: This field is a copy from MlApplicationInstance created by the consumer. The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: This field is a copy from MlApplicationInstance created by the consumer. The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) maxLength: 255 minLength: 1 type: string mlApplicationImplementationName: description: This field is a copy from MlApplicationInstance created by the consumer. The name of Ml Application Implemenation (based on mlApplicationImplementationId) maxLength: 255 minLength: 1 type: string mlApplicationImplementationVersionId: description: The OCID of the MlApplicationImplementationVersion maxLength: 255 minLength: 1 type: string mlApplicationInstanceId: description: The OCID of the MlApplicationInstance (created by the consumer) which this MlApplicationInstanceView is mirroring. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string packageVersion: description: Version of MlApplication package which is currently used by this MlApplicationInstance. maxLength: 255 minLength: 1 type: string predictionEndpointDetails: $ref: '#/components/schemas/PredictionEndpointDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the MlApplicationInstanceView was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - mlApplicationId - mlApplicationName - mlApplicationInstanceId - mlApplicationImplementationId - mlApplicationImplementationName - packageVersion - mlApplicationImplementationVersionId - isEnabled - compartmentId - timeCreated - lifecycleState - lifecycleSubstate - lifecycleDetails - freeformTags - definedTags type: object ModelGroupDetails: description: The model group details. discriminator: propertyName: type properties: customMetadataList: description: An array of custom metadata details for the model group. items: $ref: '#/components/schemas/CustomMetadata' type: array type: description: The type of the model group. enum: - HOMOGENEOUS - HETEROGENEOUS - STACKED maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupType' required: - type type: object CreateScheduleDetails: description: Creation details for a new schedule. properties: action: $ref: '#/components/schemas/ScheduleAction' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the schedule. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the schedule. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logDetails: $ref: '#/components/schemas/ScheduleLogDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the schedule with. maxLength: 255 minLength: 1 type: string trigger: $ref: '#/components/schemas/ScheduleTrigger' required: - displayName - compartmentId - projectId - trigger - action type: object CreateModelGroupVersionHistoryDetails: description: Parameters that are required to create a new model group version history. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the model group version history in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model version history. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly name for the resource. It must be unique and can''t be modified. Avoid entering confidential information. Example: `My model version history` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object latestModelGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the latest version of the model group to be associated. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model group version history. maxLength: 255 minLength: 1 type: string required: - compartmentId - projectId type: object MlApplicationCollection: description: Results of a mlApplication search. It contains list of MlApplicationSummary items. properties: items: description: List of mlApplications. items: $ref: '#/components/schemas/MlApplicationSummary' type: array required: - items type: object ChangeNotebookSessionCompartmentDetails: description: Details for changing the compartment of a notebook session. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object JobLogConfigurationDetails: description: 'Logging configuration for resource. ' properties: enableAutoLogCreation: default: false description: 'If automatic on-behalf-of log object creation is enabled for job runs. ' type: boolean enableLogging: default: false description: If customer logging is enabled for job runs. type: boolean logGroupId: description: 'The log group id for where log objects are for job runs. ' maxLength: 255 minLength: 1 type: string logId: description: 'The log id the job run will push logs too. ' maxLength: 255 minLength: 1 type: string ChangeComputeTargetCompartmentDetails: description: Details for changing the compartment of a compute target. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateScheduleDetails: description: Update details for a schedule. properties: action: $ref: '#/components/schemas/ScheduleAction' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the schedule. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logDetails: $ref: '#/components/schemas/ScheduleLogDetails' trigger: $ref: '#/components/schemas/ScheduleTrigger' type: object MemberModelDetails: description: Model details which needs to be part of Model Group. properties: inferenceKey: description: SaaS friendly name of the model. maxLength: 32 minLength: 1 type: string modelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model. maxLength: 255 minLength: 1 type: string required: - modelId type: object CreateMlApplicationDetails: description: The information about new MlApplication. properties: compartmentId: description: The OCID of the compartment where the MlApplication is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Optional description of the ML Application maxLength: 1024 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: The name of MlApplication. It is unique in a given tenancy. maxLength: 255 minLength: 1 type: string required: - name - compartmentId type: object WorkRequestLogEntry: description: Log entries related to a specific work request. properties: message: description: The description of an action that occurred. example: error validating payload type: string timestamp: description: The date and time the log entry occurred. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - message - timestamp type: object DataSciencePrivateEndpoint: description: 'Data Science private endpoint. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create private endpoint. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user that created the private endpoint. maxLength: 255 minLength: 1 type: string dataScienceResourceType: description: Data Science resource type. enum: - NOTEBOOK_SESSION - MODEL_DEPLOYMENT example: NOTEBOOK_SESSION maxLength: 50 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/DataScienceResourceType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string fqdn: description: 'Accesing the Data Science resource using FQDN. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details of the state of Data Science private endpoint. maxLength: 400 minLength: 1 type: string lifecycleState: description: State of the Data Science private endpoint. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: ACTIVE maxLength: 50 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/DataSciencePrivateEndpointLifecycleState' nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array subnetId: description: 'The OCID of a subnet. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time that the Data Science private endpoint was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the Data Science private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - definedTags - displayName - freeformTags - id - lifecycleState - createdBy - subnetId - timeCreated - timeUpdated type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request's compartment. example: ocid1.compartment.oc1..aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. example: ocid1.datascienceworkrequest.oc1.iad.aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string operationType: description: The type of work the work request is doing. enum: - NOTEBOOK_SESSION_CREATE - NOTEBOOK_SESSION_DELETE - NOTEBOOK_SESSION_ACTIVATE - NOTEBOOK_SESSION_DEACTIVATE - MODELVERSIONSET_DELETE - EXPORT_MODEL_ARTIFACT - IMPORT_MODEL_ARTIFACT - MODEL_DEPLOYMENT_CREATE - MODEL_DEPLOYMENT_DELETE - MODEL_DEPLOYMENT_ACTIVATE - MODEL_DEPLOYMENT_DEACTIVATE - MODEL_DEPLOYMENT_UPDATE - PROJECT_DELETE - WORKREQUEST_CANCEL - JOB_DELETE - PIPELINE_CREATE - PIPELINE_DELETE - PIPELINE_RUN_CREATE - PIPELINE_RUN_CANCEL - PIPELINE_RUN_DELETE - ML_APPLICATION_PACKAGE_UPLOAD - ML_APPLICATION_TRIGGER_START - ML_APPLICATION_IMPLEMENTATION_DELETE - ML_APPLICATION_IMPLEMENTATION_UPDATE - ML_APPLICATION_IMPLEMENTATION_MOVE - ML_APPLICATION_INSTANCE_CREATE - ML_APPLICATION_INSTANCE_UPDATE - ML_APPLICATION_INSTANCE_DELETE - ML_APPLICATION_INSTANCE_MOVE - ML_APPLICATION_INSTANCE_VIEW_CREATE - ML_APPLICATION_INSTANCE_VIEW_UPDATE - ML_APPLICATION_INSTANCE_VIEW_DELETE - ML_APPLICATION_INSTANCE_VIEW_UPGRADE - ML_APPLICATION_INSTANCE_VIEW_MOVE - PRIVATE_ENDPOINT_CREATE - PRIVATE_ENDPOINT_DELETE - PRIVATE_ENDPOINT_MOVE - PRIVATE_ENDPOINT_UPDATE - SCHEDULE_CREATE - SCHEDULE_UPDATE - SCHEDULE_DELETE - SCHEDULE_MOVE - SCHEDULE_ACTIVATE - SCHEDULE_DEACTIVATE - RESTORE_ARCHIVED_MODEL - COMPUTE_TARGET_CREATE - COMPUTE_TARGET_UPDATE - COMPUTE_TARGET_DELETE - MODEL_GROUP_CREATE - MODEL_GROUP_UPDATE - MODEL_GROUP_DELETE - MODEL_GROUP_VERSION_HISTORY_DELETE example: NOTEBOOK_SESSION_CREATE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' percentComplete: description: Percentage of the request completed. example: 100.0 format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED example: SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: The time the work request was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The time the work request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The time the work request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted type: object UpdateComputeConfigurationDetails: description: Configuration details of the targeted Compute. discriminator: propertyName: computeType properties: computeType: description: The type of compute. enum: - MANAGED_COMPUTE_CLUSTER maxLength: 50 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ComputeType' required: - computeType type: object PipelineRunSummary: description: Summary of the PipelineRun. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline run. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the pipeline run. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the pipeline run. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETING - DELETED example: SUCCEEDED maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/PipelineRunLifecycleState' pipelineId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline for which pipeline run is created. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline run with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeAccepted: description: The date and time the pipeline run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The date and time the pipeline run was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - timeAccepted - createdBy - projectId - compartmentId - pipelineId - displayName - lifecycleState type: object MlApplicationInstance: description: Resource representing instance of ML Application. properties: authConfiguration: $ref: '#/components/schemas/AuthConfiguration' compartmentId: description: The OCID of the compartment where the MlApplicationInstance is created. maxLength: 255 minLength: 1 type: string configuration: description: Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplicationImplementation. items: $ref: '#/components/schemas/ConfigurationProperty' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of MlApplicationInstance. System will generate displayName when not provided during creation. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationInstance. Unique identifier that is immutable after creation maxLength: 255 minLength: 1 type: string isEnabled: description: States whether the MlApplicationInstance is supposed to be in ACTIVE lifecycle state. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 1024 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationInstance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string lifecycleSubstate: description: 'The current substate of the MlApplicationInstance. The substate has MlApplicationInstance specific values in comparison with lifecycleState which has standard values common for all OCI resources. The NEEDS_ATTENTION and FAILED substates are deprecated in favor of (NON_)?RECOVERABLE_(PROVIDER|SERVICE)_ISSUE and will be removed in next release. ' enum: - CREATING - UPDATING - UPGRADING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED - NON_RECOVERABLE_PROVIDER_ISSUE - RECOVERABLE_PROVIDER_ISSUE - NON_RECOVERABLE_SERVICE_ISSUE - RECOVERABLE_SERVICE_ISSUE type: string mlApplicationId: description: The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) maxLength: 255 minLength: 1 type: string mlApplicationImplementationName: description: The name of Ml Application Implementation (based on mlApplicationImplementationId) maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string predictionEndpointDetails: $ref: '#/components/schemas/PredictionEndpointDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the MlApplication was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: Time of last MlApplicationInstance update in the format defined by RFC 3339. format: date-time type: string required: - id - displayName - mlApplicationId - mlApplicationName - mlApplicationImplementationId - mlApplicationImplementationName - compartmentId - isEnabled - timeCreated - timeUpdated - lifecycleState - lifecycleSubstate - lifecycleDetails - freeformTags - definedTags type: object ArtifactImportDetails: description: Details of Artifact source discriminator: propertyName: artifactSourceType properties: artifactSourceType: description: Source type where actually artifact is being stored enum: - ORACLE_OBJECT_STORAGE type: string x-obmcs-top-level-enum: '#/definitions/ArtifactSourceType' required: - artifactSourceType type: object MlApplicationImplementationCollection: description: Results of a MlApplicationImplementation search. It contains list of MlApplicationImplementationSummary items. properties: items: description: List of MlApplicationImplementationSummaries. items: $ref: '#/components/schemas/MlApplicationImplementationSummary' type: array required: - items type: object ModelDeploymentShapeSummary: description: 'The compute shape used to launch a model deployment compute instance. ' properties: coreCount: default: 1 description: 'The number of cores associated with this model deployment shape. ' example: 1 type: integer memoryInGBs: default: 15 description: 'The amount of memory in GBs associated with this model deployment shape. ' example: 15 type: integer name: description: 'The name of the model deployment shape. ' example: VM.STANDARD2.1 type: string shapeSeries: description: 'The family that the compute shape belongs to. ' enum: - AMD_ROME - INTEL_SKYLAKE - NVIDIA_GPU - GENERIC - LEGACY type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentShapeSeries' required: - name - coreCount - memoryInGBs - shapeSeries type: object x-example: "{\n \"name\": \"VM.STANDARD2.1\",\n \"coreCount\": 1,\n \"memoryInGBs\": 15\n ,\"shapeSeries\": INTEL_SKYLAKE\n}\n" MlApplicationPackageArguments: description: List of ML Application package arguments provided during ML Application package upload. properties: arguments: description: Array of the ML Application package arguments items: $ref: '#/components/schemas/MlApplicationPackageArgumentDetails' type: array type: object ComputeTarget: description: A compute target. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with the compute target. maxLength: 255 minLength: 1 type: string computeConfigurationDetails: $ref: '#/components/schemas/ComputeConfigurationDetails' computeTargetSystemData: $ref: '#/components/schemas/ComputeTargetSystemData' createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the compute target. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the compute target. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the compute target. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the compute target. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ComputeTargetLifecycleState' metadata: additionalProperties: type: string description: 'Metadata for the compute target. The size of metadata must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall metadata is limited to 2048 bytes. Key can''t be reserved Compute Target metadata. ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - displayName - timeCreated - createdBy - compartmentId - computeConfigurationDetails - lifecycleState PipelineStepRun: description: Detail of each StepRun. discriminator: propertyName: stepType properties: lifecycleDetails: description: Details of the state of the step run. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the step run. enum: - WAITING - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETED - SKIPPED example: SUCCEEDED maxLength: 25 minLength: 1 type: string stepName: description: The name of the step. maxLength: 64 minLength: 1 type: string stepType: description: The type of step. enum: - ML_JOB - CUSTOM_SCRIPT - CONTAINER - DATAFLOW type: string timeFinished: description: The date and time the pipeline step run finshed executing in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the pipeline step run was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - stepType - timeStarted - stepName PipelineStepConfigurationDetails: description: The configuration details of a step. properties: commandLineArguments: description: The command line arguments to set for step. maxLength: 4000 minLength: 1 type: string environmentVariables: additionalProperties: type: string description: Environment variables to set for step. type: object x-default-description: 'null' maximumRuntimeInMinutes: default: 1440 description: A time bound for the execution of the step. format: int64 maximum: 43200 minimum: 5 type: integer NotebookSession: description: 'Notebook sessions are interactive coding environments for data scientists. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the notebook session. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My NotebookSession` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the notebook session. example: waiting for SSH type: string lifecycleState: description: The state of the notebook session. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE - UPDATING example: CREATING maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/NotebookSessionLifecycleState' notebookSessionConfigDetails: $ref: '#/components/schemas/NotebookSessionConfigDetails' notebookSessionConfigurationDetails: $ref: '#/components/schemas/NotebookSessionConfigurationDetails' notebookSessionRuntimeConfigDetails: $ref: '#/components/schemas/NotebookSessionRuntimeConfigDetails' notebookSessionStorageMountConfigurationDetailsList: description: Collection of NotebookSessionStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array notebookSessionUrl: description: The URL to interact with the notebook session. type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the notebook session. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - projectId - createdBy - compartmentId - lifecycleState NotebookSessionGitRepoConfigDetails: description: Git repository configurations. properties: url: description: The repository URL type: string required: - url type: object CreateMlApplicationInstanceDetails: description: The information about new MlApplicationInstance. properties: authConfiguration: $ref: '#/components/schemas/CreateAuthConfigurationDetails' compartmentId: description: The OCID of the compartment where the MlApplicationInstance is created. maxLength: 255 minLength: 1 type: string configuration: description: Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplicationImplementation. items: $ref: '#/components/schemas/ConfigurationProperty' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of MlApplicationInstance. System will generate displayName when not provided. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: Defines whether the MlApplicationInstance will be created in ACTIVE (true value) or INACTIVE (false value) lifecycle state. type: boolean mlApplicationId: description: The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) maxLength: 255 minLength: 1 type: string required: - mlApplicationId - mlApplicationImplementationId - compartmentId type: object ChangeModelGroupCompartmentDetails: description: Details for changing the compartment of a model group. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PipelineInfrastructureConfigurationDetails: description: The infrastructure configuration details of a pipeline or a step. properties: blockStorageSizeInGBs: description: 'The size of the block storage volume to attach to the instance. ' example: 1024 maximum: 10240 minimum: 50 type: integer shapeConfigDetails: $ref: '#/components/schemas/PipelineShapeConfigDetails' shapeName: description: The shape used to launch the instance for all step runs in the pipeline. example: VM.STANDARD2.4 type: string subnetId: description: 'The subnet to create a secondary vnic in to attach to the instance running the pipeline step. ' maxLength: 255 minLength: 1 type: string x-default-description: 'null' required: - shapeName - blockStorageSizeInGBs ModelDeploymentSummary: description: Summary information for a model deployment. properties: categoryLogDetails: $ref: '#/components/schemas/CategoryLogDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model deployment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model deployment. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the model deployment. enum: - CREATING - ACTIVE - DELETING - FAILED - INACTIVE - UPDATING - DELETED - NEEDS_ATTENTION example: CREATING maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentLifecycleState' modelDeploymentConfigurationDetails: $ref: '#/components/schemas/ModelDeploymentConfigurationDetails' modelDeploymentSystemData: $ref: '#/components/schemas/ModelDeploymentSystemData' modelDeploymentUrl: description: The URL to interact with the model deployment. type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model deployment. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - projectId - createdBy - compartmentId - modelDeploymentUrl - lifecycleState MlApplicationImplementation: description: Resource representing solution for AI/ML use-case defined by ML Application properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array applicationComponents: description: List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package. items: $ref: '#/components/schemas/ApplicationComponent' type: array compartmentId: description: The OCID of the compartment where ML Application Implementation is created. maxLength: 255 minLength: 1 type: string configurationSchema: description: Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. items: $ref: '#/components/schemas/ConfigurationPropertySchema' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of ML Application Implementation defined in ML Application package descriptor maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 1024 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationImplementation. enum: - CREATING - ACTIVE - NEEDS_ATTENTION - FAILED - DELETING - UPDATING type: string logging: $ref: '#/components/schemas/ImplementationLogging' mlApplicationId: description: The OCID of the ML Application implemented by this ML Application Implementation. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId) maxLength: 255 minLength: 1 type: string mlApplicationPackageArguments: $ref: '#/components/schemas/MlApplicationPackageArguments' name: description: ML Application Implementation name which is unique for given ML Application. maxLength: 255 minLength: 1 type: string packageVersion: description: The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation time of MlApplicationImplementation creation in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: Time of last MlApplicationImplementation update in the format defined by RFC 3339. format: date-time type: string required: - id - name - mlApplicationId - mlApplicationName - compartmentId - timeCreated - timeUpdated - lifecycleState - lifecycleDetails - freeformTags - definedTags type: object CreateModelDetails: description: Parameters needed to create a new model. Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifact. properties: backupSetting: $ref: '#/components/schemas/BackupSetting' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the model in. maxLength: 255 minLength: 1 type: string customMetadataList: description: An array of custom metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedMetadataList: description: An array of defined metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My Model` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inputSchema: description: Input schema file content in String format example: '{"predict_arguments":{"sepal_length_(cm)":{"type":"continuous","dtype":"float64"},"sepal_width_(cm)":{"type":"continuous","dtype":"float64"},"petal_length_(cm)":{"type":"continuous","dtype":"float64"},"petal_width_(cm)":{"type":"continuous","dtype":"float64"}},"predict_response":{"target":{"type":"categorical","dtype":"category"}},"problem_type":"multiclass_classification"}' type: string modelVersionSetId: description: The OCID of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string outputSchema: description: Output schema file content in String format example: '{"class":3,"probabilities":[0.1,0.2,0.7]}' type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model. maxLength: 255 minLength: 1 type: string retentionSetting: $ref: '#/components/schemas/RetentionSetting' versionLabel: description: The version label can add an additional description of the lifecycle state of the model or the application using/training the model. maxLength: 255 minLength: 1 type: string required: - compartmentId - projectId type: object CreatePipelineRunDetails: description: The information about new PipelineRun. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline run. maxLength: 255 minLength: 1 type: string configurationOverrideDetails: $ref: '#/components/schemas/PipelineConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string x-default-description: This will be set to a service generated display name freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object infrastructureConfigurationOverrideDetails: $ref: '#/components/schemas/PipelineInfrastructureConfigurationDetails' logConfigurationOverrideDetails: $ref: '#/components/schemas/PipelineLogConfigurationDetails' pipelineId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline for which pipeline run is created. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline run with. maxLength: 255 minLength: 1 type: string stepOverrideDetails: description: Array of step override details. Only Step Configuration is allowed to be overridden. items: $ref: '#/components/schemas/PipelineStepOverrideDetails' maxItems: 30 minItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - compartmentId - pipelineId type: object JobRunSummary: description: Summary information for a job run. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job run. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job run. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run. maxLength: 255 minLength: 1 type: string jobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details of the state of the job run. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the job run. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETED - NEEDS_ATTENTION example: SUCCEEDED maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/JobRunLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job run with. maxLength: 255 minLength: 1 type: string timeAccepted: description: The date and time the job run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The date and time the job run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the job run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - timeAccepted - createdBy - projectId - compartmentId - jobId - lifecycleState WorkRequestResource: description: The properties that define a work request resource. properties: actionType: description: The way in which this resource was affected by the work tracked by the work request. enum: - CREATED - UPDATED - DELETED - RELATED - IN_PROGRESS example: CREATED type: string entityType: description: The resource type the work request affects. example: NOTEBOOK_SESSION type: string entityUri: description: The URI path on which the user can issue a GET request to access the resource metadata. example: /20190101/notebookSessions/ocid1.datasciencenotebooksession.oc1.iad.aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string identifier: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource the work request affects. example: ocid1.datasciencenotebooksession.oc1.iad.aaaaaaaaabbbbbbbbbbbbcccccccccdddddddddeeeeeeeffffffgggggggg type: string required: - actionType - entityType - identifier type: object UpdateModelDetails: description: 'Details for updating a model. ' properties: backupSetting: $ref: '#/components/schemas/BackupSetting' customMetadataList: description: An array of custom metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedMetadataList: description: An array of defined metadata details for the model. items: $ref: '#/components/schemas/Metadata' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model. maxLength: 400 minLength: 1 type: string displayName: description: "A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.\n Example: `My Model`\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object modelVersionSetId: description: The OCID of the model version set that the model is associated to. maxLength: 255 minLength: 1 type: string retentionSetting: $ref: '#/components/schemas/RetentionSetting' versionLabel: description: The version label can add an additional description of the lifecycle state of the model or the application using/training the model. maxLength: 255 minLength: 1 type: string type: object ModelGroupVersionHistorySummary: description: Summary information for a modelGroupVersionHistory. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string latestModelGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the latest version of the model group associated maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model group version history. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the modelGroupVersionHistory. enum: - ACTIVE - DELETED - FAILED - DELETING example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupVersionHistoryLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - compartmentId - projectId - displayName - lifecycleState - timeCreated - timeUpdated - createdBy type: object ConfigurationProperty: description: Property that is used for provisioning of the given MlApplicationInstance. It is validated against configurationSchema defined in referenced MlApplicationImplementation. The value is mandatory with exception for ConfigurationProperty of SECRET type where read operation does not return value field as it contains plain text secret and update operation does not have to contain value field when the secret value should not be updated. properties: key: description: Key of configuration property maxLength: 255 minLength: 1 type: string value: description: Value of configuration property maxLength: 255 minLength: 1 type: string required: - key type: object Metadata: description: Defines properties of each model metadata. properties: category: description: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other". example: Performance maxLength: 255 minLength: 1 type: string description: description: Description of model metadata example: The base model on which the current model was derived maxLength: 255 minLength: 1 type: string key: description: "Key of the model Metadata. The key can either be user defined or OCI defined.\n List of OCI defined keys:\n * useCaseType\n * libraryName\n * libraryVersion\n * estimatorClass\n * hyperParameters\n * testArtifactresults\n" maxLength: 255 minLength: 1 type: string value: description: "Allowed values for useCaseType:\n binary_classification, regression, multinomial_classification, clustering, recommender,\n dimensionality_reduction/representation, time_series_forecasting, anomaly_detection,\n topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other\n\nAllowed values for libraryName:\n scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy,\n prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan,\n bert, gensim, flair, word2vec, ensemble, other\n" example: oci.datasciencemodel.aaa12934190b32g9823589 type: string type: object NotebookSessionRuntimeConfigDetails: description: Notebook Session runtime configuration details. properties: customEnvironmentVariables: additionalProperties: type: string description: Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions. type: object notebookSessionGitConfigDetails: $ref: '#/components/schemas/NotebookSessionGitConfigDetails' type: object CreateModelProvenanceDetails: description: Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained. properties: gitBranch: description: For model reproducibility purposes. Branch of the git repository associated with model training. example: master maxLength: 255 minLength: 1 type: string gitCommit: description: For model reproducibility purposes. Commit ID of the git repository associated with model training. example: 0978b63 maxLength: 255 minLength: 1 type: string repositoryUrl: description: For model reproducibility purposes. URL of the git repository associated with model training. example: http://git-remote.com/my-repo maxLength: 255 minLength: 1 type: string scriptDir: description: For model reproducibility purposes. Path to model artifacts. maxLength: 255 minLength: 1 type: string trainingId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes. example: ocid1.datasciencenotebooksession.oc1.iad.amaaaaaav66vvniaxe2qpktdlwtcvhkuq467mz2n46pf2swol23bmjh3r4wq maxLength: 255 minLength: 1 type: string trainingScript: description: 'For model reproducibility purposes. Path to the python script or notebook in which the model was trained." ' example: model-dev/model1/model-training.ipynb maxLength: 255 minLength: 1 type: string type: object CreateModelVersionSetDetails: description: Parameters that are required to create a new model version set. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the model version set in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model version set. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: 'A user-friendly name for the resource. It must be unique and can''t be modified. Avoid entering confidential information. Example: `My model version set` ' maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model version set. maxLength: 255 minLength: 1 type: string required: - name - compartmentId - projectId type: object MlApplicationImplementationVersionCollection: description: Results of a MlApplicationImplementationVersion search. It contains list of MlApplicationImplementationVersionSummary items. properties: items: description: List of MlApplicationImplementationVersionSummaries. items: $ref: '#/components/schemas/MlApplicationImplementationVersionSummary' type: array required: - items type: object UpdateMlApplicationDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Optional description of the ML Application maxLength: 1024 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object PipelineShapeConfigDetails: description: Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. properties: cpuBaseline: description: "The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`.\nThe following values are supported:\n BASELINE_1_8 - baseline usage is 1/8 of an OCPU.\n BASELINE_1_2 - baseline usage is 1/2 of an OCPU.\n BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance.\n" enum: - BASELINE_1_8 - BASELINE_1_2 - BASELINE_1_1 type: string memoryInGBs: default: 15 description: 'A pipeline step run instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs. ' example: 1024 format: float maximum: 1024 minimum: 1 type: number ocpus: default: 1 description: 'A pipeline step run instance of type VM.Standard.E3.Flex allows the ocpu count to be specified. ' example: 64 format: float maximum: 64 minimum: 1 type: number WorkRequestError: description: Errors related to a specific work request. properties: code: description: A short error code that defines the error, which is meant for programmatic parsing. See [API Errors](/Content/General/References/apierrors.htm). example: UnknownError type: string message: description: A human-readable error string. example: error validating payload type: string timestamp: description: The date and time the error occurred. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - code - message - timestamp type: object DisableMlApplicationInstanceViewTriggerDetails: description: Payload for disable trigger action properties: triggerName: description: Name of trigger maxLength: 255 minLength: 1 type: string required: - triggerName type: object CreateProjectDetails: description: 'Parameters needed to create a new project. Projects enable users to organize their data science work. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the project in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the project. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId UpdateMlApplicationInstanceViewDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object NotebookSessionShapeConfigDetails: description: Details for the notebook session shape configuration. properties: cpuBaseline: description: "The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`.\nThe following values are supported:\n BASELINE_1_8 - baseline usage is 1/8 of an OCPU.\n BASELINE_1_2 - baseline usage is 1/2 of an OCPU.\n BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance.\n" enum: - BASELINE_1_8 - BASELINE_1_2 - BASELINE_1_1 type: string memoryInGBs: default: 15 description: 'The total amount of memory available to the notebook session instance, in gigabytes. ' example: 1024 format: float maximum: 1024 minimum: 1 type: number ocpus: default: 1 description: 'The total number of OCPUs available to the notebook session instance. ' example: 64 format: float maximum: 64 minimum: 1 type: number NotebookSessionConfigurationDetails: description: Details for the notebook session configuration. properties: blockStorageSizeInGBs: default: 100 description: 'A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. ' example: 100 maximum: 10240 minimum: 50 type: integer notebookSessionShapeConfigDetails: $ref: '#/components/schemas/NotebookSessionShapeConfigDetails' privateEndpointId: description: 'The OCID of a Data Science private endpoint. ' maxLength: 255 minLength: 1 type: string shape: description: 'The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. ' example: VM.Standard.E3.Flex type: string subnetId: description: 'A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. ' maxLength: 255 minLength: 1 type: string required: - shape - subnetId ModelDeploymentConfigurationDetails: description: The model deployment configuration details. discriminator: propertyName: deploymentType properties: deploymentType: description: The type of the model deployment. enum: - SINGLE_MODEL - MODEL_GROUP - SINGLE_MODEL_FLEX maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentType' required: - deploymentType type: object MlApplicationSummary: description: Summary of the MlApplication. properties: compartmentId: description: The OCID of the compartment where the MlApplication is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Optional description of the ML Application maxLength: 1024 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplication. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the MlApplication. type: string x-obmcs-enumref: '#/definitions/MlApplication/lifecycleState' name: description: The name of MlApplication. It is unique in a given tenancy. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the MlApplication was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - name - compartmentId - timeCreated - lifecycleState type: object CreateModelDeploymentDetails: description: 'Parameters needed to create a new model deployment. Model deployments are used by data scientists to perform predictions from the model hosted on an HTTP server. ' properties: categoryLogDetails: $ref: '#/components/schemas/CategoryLogDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the model deployment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model deployment. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object modelDeploymentConfigurationDetails: $ref: '#/components/schemas/ModelDeploymentConfigurationDetails' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model deployment. type: string required: - projectId - compartmentId - modelDeploymentConfigurationDetails PipelineStepDetails: description: A step in the pipeline. discriminator: propertyName: stepType properties: dependsOn: description: The list of step names this current step depends on for execution. items: type: string maxItems: 30 minItems: 0 type: array description: description: A short description of the step. maxLength: 128 minLength: 1 type: string x-default-description: 'null' stepConfigurationDetails: $ref: '#/components/schemas/PipelineStepConfigurationDetails' stepName: description: The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. maxLength: 64 minLength: 1 type: string stepType: description: The type of step. enum: - ML_JOB - CUSTOM_SCRIPT - CONTAINER - DATAFLOW type: string required: - stepType - stepName CreateDataSciencePrivateEndpointDetails: description: 'The details required to create a Data Science private endpoint. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the private endpoint. maxLength: 255 minLength: 1 type: string dataScienceResourceType: description: Data Science resource type. enum: - NOTEBOOK_SESSION - MODEL_DEPLOYMENT example: NOTEBOOK_SESSION type: string x-obmcs-top-level-enum: '#/definitions/DataScienceResourceType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array subDomain: description: Subdomain for a private endpoint FQDN. maxLength: 255 type: string subnetId: description: 'The OCID of the subnet. ' maxLength: 255 type: string required: - compartmentId - subnetId - dataScienceResourceType type: object TriggerMlApplicationInstanceViewFlowDetails: description: Payload for trigger request endpoint properties: parameters: description: Parameters provided for given trigger invocation (they must match predefined schema) items: $ref: '#/components/schemas/TriggerParameter' type: array triggerName: description: Name of trigger maxLength: 255 minLength: 1 type: string required: - triggerName type: object FastLaunchJobConfigSummary: description: The shape config to launch a fast launch capable job instance properties: coreCount: description: 'The number of cores associated with this fast launch job shape. ' example: 4 type: integer managedEgressSupport: default: SUPPORTED description: 'The managed egress support ' enum: - REQUIRED - SUPPORTED - UNSUPPORTED type: string memoryInGBs: description: 'The number of cores associated with this fast launch job shape. ' example: 60 type: integer name: description: 'The name of the fast launch job config ' example: VM.STANDARD2.4_C4_M60GB_SUPPORTED type: string shapeName: description: 'The name of the fast launch job shape. ' example: VM.STANDARD2.4 type: string shapeSeries: default: INTEL_SKYLAKE description: 'The family that the compute shape belongs to. ' enum: - AMD_ROME - INTEL_SKYLAKE - NVIDIA_GPU - GENERIC - LEGACY type: string required: - name - shapeName - coreCount - memoryInGBs - shapeSeries - managedEgressSupport type: object x-example: "{\n \"name\": \"VM.STANDARD2.4_C4_M60GB_SUPPORTED\",\n \"shapeName\": \"VM.Standard2.4\",\n \"coreCount\": 4,\n \"memoryInGBs\": 60,\n \"shapeSeries\": INTEL_SKYLAKE,\n \"managedEgressSupport\": SUPPORTED\n}\n" CreateNotebookSessionDetails: description: 'Parameters needed to create a new notebook session. Notebook sessions are interactive coding environments for data scientists. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the notebook session. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My NotebookSession` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object notebookSessionConfigDetails: $ref: '#/components/schemas/NotebookSessionConfigDetails' notebookSessionConfigurationDetails: $ref: '#/components/schemas/NotebookSessionConfigurationDetails' notebookSessionRuntimeConfigDetails: $ref: '#/components/schemas/NotebookSessionRuntimeConfigDetails' notebookSessionStorageMountConfigurationDetailsList: description: Collection of NotebookSessionStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the notebook session. type: string required: - projectId - compartmentId EnableMlApplicationInstanceViewTriggerDetails: description: Payload for enable trigger action properties: triggerName: description: Name of trigger maxLength: 255 minLength: 1 type: string required: - triggerName type: object JobRun: description: A job run. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job run. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job run. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run. maxLength: 255 minLength: 1 type: string jobConfigurationOverrideDetails: $ref: '#/components/schemas/JobConfigurationDetails' jobEnvironmentConfigurationOverrideDetails: $ref: '#/components/schemas/JobEnvironmentConfigurationDetails' jobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. maxLength: 255 minLength: 1 type: string jobInfrastructureConfigurationDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobInfrastructureConfigurationOverrideDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobLogConfigurationOverrideDetails: $ref: '#/components/schemas/JobLogConfigurationDetails' jobNodeConfigurationOverrideDetails: $ref: '#/components/schemas/JobNodeConfigurationDetails' jobStorageMountConfigurationDetailsList: description: Collection of JobStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array lifecycleDetails: description: Details of the state of the job run. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the job run. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETED - NEEDS_ATTENTION example: SUCCEEDED maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/JobRunLifecycleState' logDetails: $ref: '#/components/schemas/JobRunLogDetails' nodeGroupDetailsList: description: Collection of NodeGroupDetails items: $ref: '#/components/schemas/NodeGroupDetails' maxItems: 5 minItems: 1 type: array projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job run with. maxLength: 255 minLength: 1 type: string timeAccepted: description: The date and time the job run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The date and time the job run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The date and time the job run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - timeAccepted - createdBy - projectId - compartmentId - jobId - jobInfrastructureConfigurationDetails - jobConfigurationOverrideDetails - lifecycleState CreateMlApplicationImplementationDetails: description: The information about new MlApplicationImplementation. properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: The OCID of the compartment where ML Application Implementation is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logging: $ref: '#/components/schemas/ImplementationLogging' mlApplicationId: description: The OCID of the ML Application implemented by this ML Application Implementation maxLength: 255 minLength: 1 type: string name: description: ML Application Implementation name which is unique for given ML Application. maxLength: 255 minLength: 1 type: string required: - name - mlApplicationId - compartmentId type: object ComputeTargetSystemData: description: System data of the compute target. discriminator: propertyName: computeType properties: computeType: description: Type of compute target. enum: - MANAGED_COMPUTE_CLUSTER type: string MlApplicationPackageArgumentDetails: description: Represents single argument name value pair. properties: description: description: short description of the argument maxLength: 255 minLength: 1 type: string isMandatory: description: argument is mandatory or not type: boolean name: description: Argument name maxLength: 255 minLength: 1 type: string type: description: type of the argument enum: - STRING - OCID type: string value: description: Argument value maxLength: 255 minLength: 1 type: string required: - name - value - description - type - isMandatory type: object ArtifactExportDetails: description: Details of Artifact source discriminator: propertyName: artifactSourceType properties: artifactSourceType: description: Source type where actually artifact is being stored enum: - ORACLE_OBJECT_STORAGE type: string x-obmcs-top-level-enum: '#/definitions/ArtifactSourceType' required: - artifactSourceType type: object UpdateModelVersionSetDetails: description: 'Details for updating a model version set. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model version set. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object PipelineRunLogDetails: description: Customer logging details for pipeline run. properties: logGroupId: description: The log group id for where log objects will be for pipeline runs. maxLength: 255 minLength: 1 type: string logId: description: The log id of the log object the pipeline run logs will be shipped to. maxLength: 255 minLength: 1 type: string required: - logGroupId - logId BackupOperationDetails: description: Backup operation details of the model. properties: backupState: description: The backup status of the model. enum: - PENDING - FAILED - SUCCEEDED example: PENDING type: string x-obmcs-top-level-enum: '#/definitions/ModelSettingActionState' backupStateDetails: description: The backup execution status details of the model. maxLength: 255 type: string timeLastBackup: description: The last backup execution time of the model. format: date-time type: string required: - backupState - backupStateDetails CreateBaseModelGroupDetails: description: The base create model group details. discriminator: propertyName: createType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the modelGroup in. maxLength: 255 minLength: 1 type: string createType: description: The type of the model group create operation. enum: - CREATE - CLONE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupCreateType' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the modelGroup. maxLength: 255 minLength: 1 type: string required: - createType - compartmentId - projectId type: object ModelGroup: description: Model group is a collection of the models. Model groups are represented by their associated metadata. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup's compartment. maxLength: 255 minLength: 1 type: string createType: description: The type of the model group create operation. maxLength: 25 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the modelGroup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the modelGroup. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the modelGroup. enum: - CREATING - ACTIVE - FAILED - INACTIVE - DELETING - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupLifecycleState' memberModelEntries: $ref: '#/components/schemas/MemberModelEntries' modelGroupDetails: $ref: '#/components/schemas/ModelGroupDetails' modelGroupVersionHistoryId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model group version history to which the modelGroup is associated. maxLength: 255 minLength: 1 type: string modelGroupVersionHistoryName: description: The name of the model group version history to which the model group is associated. maxLength: 255 minLength: 1 type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the modelGroup. maxLength: 255 minLength: 1 type: string sourceModelGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model group used for the clone operation. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string versionId: description: Unique identifier assigned to each version of the model group. It would be auto-incremented number generated by service. format: int64 type: integer versionLabel: description: An additional description of the lifecycle state of the model group. maxLength: 400 minLength: 1 type: string required: - id - compartmentId - projectId - modelGroupDetails - memberModelEntries - lifecycleState - timeCreated - timeUpdated - createdBy type: object Project: description: 'Projects enable users to organize their data science work. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created this project. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the project. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the project. enum: - ACTIVE - DELETING - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ProjectLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - createdBy - compartmentId - lifecycleState ChangeModelDeploymentCompartmentDetails: description: Details for changing the compartment of a model deployment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object JobShapeSummary: description: The compute shape used to launch a job compute instance. properties: coreCount: description: 'The number of cores associated with this job run shape. ' example: 1 type: integer memoryInGBs: description: 'The number of cores associated with this job shape. ' example: 15 type: integer name: description: 'The name of the job shape. ' example: VM.STANDARD2.1 type: string shapeSeries: default: INTEL_SKYLAKE description: 'The family that the compute shape belongs to. ' enum: - AMD_ROME - INTEL_SKYLAKE - NVIDIA_GPU - GENERIC - LEGACY type: string required: - name - coreCount - memoryInGBs - shapeSeries type: object x-example: "{\n \"name\": \"VM.STANDARD2.1\",\n \"coreCount\": 1,\n \"memoryInGBs\": 15,\n \"shapeSeries\": INTEL_SKYLAKE\n}\n" CreateJobDetails: description: 'Parameters needed to create a new job. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the job. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobConfigurationDetails: $ref: '#/components/schemas/JobConfigurationDetails' jobEnvironmentConfigurationDetails: $ref: '#/components/schemas/JobEnvironmentConfigurationDetails' jobInfrastructureConfigurationDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobLogConfigurationDetails: $ref: '#/components/schemas/JobLogConfigurationDetails' jobNodeConfigurationDetails: $ref: '#/components/schemas/JobNodeConfigurationDetails' jobStorageMountConfigurationDetailsList: description: Collection of JobStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job with. maxLength: 255 minLength: 1 type: string required: - projectId - compartmentId ChangeMlApplicationCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Job: description: A job for training models. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the job. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. maxLength: 255 minLength: 1 type: string jobConfigurationDetails: $ref: '#/components/schemas/JobConfigurationDetails' jobEnvironmentConfigurationDetails: $ref: '#/components/schemas/JobEnvironmentConfigurationDetails' jobInfrastructureConfigurationDetails: $ref: '#/components/schemas/JobInfrastructureConfigurationDetails' jobLogConfigurationDetails: $ref: '#/components/schemas/JobLogConfigurationDetails' jobNodeConfigurationDetails: $ref: '#/components/schemas/JobNodeConfigurationDetails' jobStorageMountConfigurationDetailsList: description: Collection of JobStorageMountConfigurationDetails. items: $ref: '#/components/schemas/StorageMountConfigurationDetails' type: array lifecycleDetails: description: The state of the job. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the job. enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/JobLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job with. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - createdBy - projectId - compartmentId - jobConfigurationDetails - jobInfrastructureConfigurationDetails - lifecycleState MlApplicationImplementationVersionSummary: description: Summary of the MlApplicationImplementationVersion. properties: allowedMigrationDestinations: description: List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. items: maxLength: 255 minLength: 1 type: string type: array configurationSchema: description: Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. items: $ref: '#/components/schemas/ConfigurationPropertySchema' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of ML Application Implementation defined in ML Application package descriptor maxLength: 1024 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the MlApplicationImplementationVersion. Unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the MlApplicationImplementationVersion. type: string x-obmcs-enumref: '#/definitions/MlApplicationImplementationVersion/lifecycleState' mlApplicationId: description: The OCID of the ML Application implemented by this ML Application Implementation. maxLength: 255 minLength: 1 type: string mlApplicationImplementationId: description: The OCID of the MlApplicationImplementation for which this resource keeps the historical state. maxLength: 255 minLength: 1 type: string mlApplicationName: description: The name of ML Application (based on mlApplicationId). maxLength: 255 minLength: 1 type: string name: description: ML Application Implementation name which is unique for given ML Application. maxLength: 255 minLength: 1 type: string packageVersion: description: The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation time of MlApplicationImplementationVersion in the format defined by RFC 3339. format: date-time type: string required: - id - mlApplicationImplementationId - name - mlApplicationId - mlApplicationName - timeCreated - lifecycleState - freeformTags - definedTags type: object RetentionSetting: description: Retention setting details of the model. properties: archiveAfterDays: description: Number of days after which the model will be archived. maximum: 540 minimum: 5 type: integer customerNotificationType: default: NONE description: Customer notification options on success/failure of archival, deletion events. enum: - NONE - ALL - ON_FAILURE - ON_SUCCESS example: ALL type: string x-obmcs-top-level-enum: '#/definitions/ModelSettingCustomerNotificationType' deleteAfterDays: default: 30 description: Number of days after which the archived model will be deleted. maximum: 540 minimum: 5 type: integer required: - archiveAfterDays ComputeTargetShapeSummary: description: 'The compute shape used to launch a compute target. ' properties: coreCount: default: 1 description: 'The number of cores associated with this compute target shape. ' example: 1 type: integer memoryInGBs: default: 15 description: 'The amount of memory in GBs associated with this compute target shape. ' example: 15 type: integer name: description: 'The name of the compute target shape. ' example: VM.STANDARD2.1 maxLength: 255 type: string shapeSeries: description: 'The family that the compute shape belongs to. ' enum: - AMD_ROME - INTEL_SKYLAKE - NVIDIA_GPU - GENERIC - LEGACY - ARM maxLength: 255 type: string x-obmcs-top-level-enum: '#/definitions/ComputeTargetShapeSeries' required: - name - coreCount - memoryInGBs - shapeSeries type: object x-example: "{\n \"name\": \"VM.STANDARD2.1\",\n \"coreCount\": 1,\n \"memoryInGBs\": 15\n ,\"shapeSeries\": INTEL_SKYLAKE\n}\n" NodeGroupDetails: description: Details of Node Group properties: lifecycleDetails: description: The state details of the node group. maxLength: 400 minLength: 1 type: string lifecycleState: description: The state of the node group. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/NodeGroupLifecycleState' name: description: node group name. maxLength: 100 minLength: 1 type: string required: - name - lifecycleState type: object UpdatePipelineRunDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Name of the pipeline run. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object ImportModelArtifactDetails: description: Details required for importing the artifact from service bucket properties: artifactImportDetails: $ref: '#/components/schemas/ArtifactImportDetails' required: - artifactImportDetails type: object ModelGroupVersionHistory: description: Model Group Version history to associate different versions of Model Group resource. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the modelGroupVersionHistory. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string latestModelGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the latest version of the model group associated. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the lifecycle state of the model group version history. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the modelGroupVersionHistory. enum: - ACTIVE - DELETED - FAILED - DELETING example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelGroupVersionHistoryLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the modelGroupVersionHistory. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - compartmentId - projectId - displayName - lifecycleState - timeCreated - timeUpdated - createdBy type: object ComputeConfigurationDetails: description: Configuration details of the targeted compute. discriminator: propertyName: computeType properties: computeType: description: The type of compute. enum: - MANAGED_COMPUTE_CLUSTER maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ComputeType' required: - computeType type: object MemberModelEntries: description: List of member models (inferenceKey & modelId) to be associated with the model group. properties: memberModelDetails: description: Each List item contains inference key and model ocid. items: $ref: '#/components/schemas/MemberModelDetails' maxItems: 1000 minItems: 1 type: array type: object PipelineContainerConfigurationDetails: description: Container Details for a step in pipeline. discriminator: propertyName: containerType properties: containerType: description: The type of container. enum: - OCIR_CONTAINER type: string required: - containerType type: object NotebookSessionShapeSummary: description: 'The compute shape used to launch a notebook session compute instance. ' properties: coreCount: default: 1 description: 'The number of cores associated with this notebook session shape. ' example: 1 type: integer memoryInGBs: default: 15 description: 'The amount of memory in GBs associated with this notebook session shape. ' example: 15 type: integer name: description: 'The name of the notebook session shape. ' example: VM.STANDARD2.1 type: string shapeSeries: description: 'The family that the compute shape belongs to. ' enum: - AMD_ROME - INTEL_SKYLAKE - NVIDIA_GPU - GENERIC - LEGACY type: string x-obmcs-top-level-enum: '#/definitions/NotebookSessionShapeSeries' required: - name - coreCount - memoryInGBs - shapeSeries type: object x-example: "{\n \"name\": \"VM.STANDARD2.1\",\n \"coreCount\": 1,\n \"memoryInGBs\": 15\n \"shapeSeries\": INTEL_SKYLAKE\n}\n" ConfigurationPropertySchema: description: Schema for single configuration property properties: defaultValue: description: The default value for the optional configuration property (it must not be specified for mandatory configuration properties) maxLength: 255 type: string description: description: Description of this configuration property maxLength: 1024 minLength: 1 type: string isMandatory: description: If the value is true this configuration property is mandatory and visa versa. If not specified configuration property is optional. type: boolean keyName: description: Name of key (parameter name) maxLength: 255 minLength: 1 type: string sampleValue: description: Sample property value (it must match validationRegexp if it is specified) maxLength: 255 minLength: 1 type: string validationRegexp: description: A regular expression will be used for the validation of property value. maxLength: 255 type: string valueType: description: Type of value enum: - STRING - SECRET - VAULT_SECRET_ID type: string required: - keyName - valueType - description - sampleValue UpdateJobRunDetails: description: Details for updating a job run. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object PipelineSummary: description: Summary of the Pipeline. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the project. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the pipeline. enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED example: ACTIVE maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleState' projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - createdBy - projectId - compartmentId - displayName - lifecycleState type: object StorageMountConfigurationDetails: description: 'The storage mount configuration details ' discriminator: propertyName: storageType properties: destinationDirectoryName: description: The local directory name to be mounted maxLength: 255 minLength: 1 type: string destinationPath: default: / description: The local path of the mounted directory, excluding directory name. maxLength: 1024 minLength: 1 type: string storageType: description: The type of storage. enum: - FILE_STORAGE - OBJECT_STORAGE type: string required: - storageType - destinationDirectoryName type: object ChangeModelCompartmentDetails: description: Details for changing the compartment of a model. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ModelDeployment: description: 'Model deployments are used by data scientists to perform predictions from the model hosted on an HTTP server. ' properties: categoryLogDetails: $ref: '#/components/schemas/CategoryLogDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment's compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model deployment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the model deployment. maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the model deployment. example: waiting for SSH type: string lifecycleState: description: The state of the model deployment. enum: - CREATING - ACTIVE - DELETING - FAILED - INACTIVE - UPDATING - DELETED - NEEDS_ATTENTION example: CREATING maxLength: 25 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ModelDeploymentLifecycleState' modelDeploymentConfigurationDetails: $ref: '#/components/schemas/ModelDeploymentConfigurationDetails' modelDeploymentSystemData: $ref: '#/components/schemas/ModelDeploymentSystemData' modelDeploymentUrl: description: The URL to interact with the model deployment. type: string projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model deployment. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z ' format: date-time type: string required: - id - timeCreated - displayName - projectId - createdBy - compartmentId - modelDeploymentUrl - lifecycleState ChangeDataSciencePrivateEndpointCompartmentDetails: description: 'The details required to change a private endpoint compartment. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create private endpoint. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ScheduleTrigger: description: The trigger of the schedule can be UNIX cron or iCal expression or simple interval discriminator: propertyName: triggerType properties: timeEnd: description: 'The schedule end date time, if null, the schedule will never expire. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' example: '2022-07-21T16:11:29Z' format: date-time type: string timeStart: description: 'The schedule starting date time, if null, System set the time when schedule is created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' example: '2022-07-21T16:11:29Z' format: date-time type: string triggerType: description: The schedule trigger type enum: - CRON - INTERVAL - ICAL type: string required: - triggerType type: object ChangeModelGroupVersionHistoryCompartmentDetails: description: Details for changing the compartment of a model group version history. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the resource should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ScheduleLogDetails: description: Custom logging details for schedule execution. properties: logGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the log group. maxLength: 255 minLength: 1 type: string logId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. maxLength: 255 minLength: 1 type: string required: - logGroupId - logId type: object ImplementationLogging: description: Configuration of Logging for ML Application Implementation. properties: aggregatedInstanceViewLog: $ref: '#/components/schemas/ImplementationLogDetails' implementationLog: $ref: '#/components/schemas/ImplementationLogDetails' triggerLog: $ref: '#/components/schemas/ImplementationLogDetails' CreateComputeTargetDetails: description: 'Parameters needed to create a new compute target. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the compute target. maxLength: 255 minLength: 1 type: string computeConfigurationDetails: $ref: '#/components/schemas/ComputeConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the compute target. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object metadata: additionalProperties: type: string description: 'Metadata for the compute target. The size of metadata must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall metadata is limited to 2048 bytes. Key can''t be reserved Compute Target metadata. ' type: object required: - compartmentId - computeConfigurationDetails parameters: ProjectLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ProjectLifecycleState' schema: type: string enum: - ACTIVE - DELETING - DELETED NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PipelineSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName ProjectIdQueryParam: description: Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project. in: query name: projectId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MlApplicationInstanceViewLifecycleStateQueryParam: description: A filter to return only resources matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MlApplicationInstanceView/lifecycleState' schema: type: string ModelGroupVersionHistorySortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName - lifecycleState CreatedByQueryParam: description: Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. in: query name: createdBy required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MlApplicationImplementationIdRequiredQueryParam: description: unique MlApplicationImplementation identifier in: query name: mlApplicationImplementationId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource''s current `etag` value. ' in: header name: if-match required: false schema: type: string ModelGroupVersionHistoryIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. in: query name: modelGroupVersionHistoryId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ModelLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ModelLifecycleState' schema: type: string enum: - ACTIVE - DELETED - FAILED - INACTIVE NotebookSessionLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/NotebookSessionLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE - UPDATING DeleteRelatedPipelineRunsQueryParam: description: A boolean value to specify whether to delete related PipelineRuns or not. in: query name: deleteRelatedPipelineRuns required: false x-default-description: 'false' schema: type: boolean MlApplicationImplementationVersionSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated SortOrderQueryParam: description: 'Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). ' in: query name: sortOrder required: false x-default-description: For time-based fields, the default sort order is `DESC` (descending). For all others, it is `ASC` (ascending). schema: type: string enum: - ASC - DESC WorkRequestStatusFilterQueryParam: description: Filter results by work request status. in: query name: status required: false x-default-description: 'null' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED ModelVersionSetDeleteRelatedModelsQueryParam: description: 'By default, this parameter is false. A model version set can only be deleted if all the models associate with it are already in the DELETED state. You can optionally specify the deleteRelatedModels boolean query parameters to true, which deletes all associated models for you. ' in: query name: isDeleteRelatedModels required: false schema: type: boolean default: false ComputeTargetLifecycleStateQueryParam: description: "Filter results by the specified lifecycle state. Must be a valid\n state for the resource type.\n" in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ComputeTargetLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION MlApplicationImplementationIdQueryParam: description: unique MlApplicationImplementation identifier in: query name: mlApplicationImplementationId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' in: header name: opc-request-id required: false x-default-description: 'null' schema: type: string ModelIdQueryParam: description: Filter results by the model ocid. in: query name: modelId required: false schema: type: string maxLength: 255 minLength: 1 StepNamePathParam: description: Unique Step identifier in a pipeline. in: path name: stepName required: true schema: type: string ModelGroupVersionHistoryIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. in: path name: modelGroupVersionHistoryId required: true schema: type: string ModelIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model. in: path name: modelId required: true x-default-description: 'null' schema: type: string MlApplicationLifecycleStateQueryParam: description: A filter to return only resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MlApplication/lifecycleState' schema: type: string JobRunIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run. in: path name: jobRunId required: true schema: type: string MlApplicationInstanceViewIdentifierPathParam: description: unique MlApplicationInstanceView identifier in: path name: mlApplicationInstanceViewId required: true schema: type: string maxLength: 255 minLength: 1 ContentLengthHeader: description: The content length of the body. in: header name: content-length required: true schema: type: integer format: int64 NotebookSessionIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session. in: path name: notebookSessionId required: true x-default-description: 'null' schema: type: string PipelineRunSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeAccepted`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeAccepted schema: type: string enum: - timeAccepted - displayName OperationTypeQueryParam: description: Filter results by the type of the operation associated with the work request. in: query name: operationType required: false x-default-description: 'null' schema: type: string enum: - NOTEBOOK_SESSION_CREATE - NOTEBOOK_SESSION_DELETE - NOTEBOOK_SESSION_ACTIVATE - NOTEBOOK_SESSION_DEACTIVATE - MODELVERSIONSET_DELETE - EXPORT_MODEL_ARTIFACT - IMPORT_MODEL_ARTIFACT - MODEL_DEPLOYMENT_CREATE - MODEL_DEPLOYMENT_DELETE - MODEL_DEPLOYMENT_ACTIVATE - MODEL_DEPLOYMENT_DEACTIVATE - MODEL_DEPLOYMENT_UPDATE - PROJECT_DELETE - WORKREQUEST_CANCEL - JOB_DELETE - PIPELINE_CREATE - PIPELINE_DELETE - PIPELINE_RUN_CREATE - PIPELINE_RUN_CANCEL - PIPELINE_RUN_DELETE - ML_APPLICATION_PACKAGE_UPLOAD - ML_APPLICATION_TRIGGER_START - ML_APPLICATION_IMPLEMENTATION_DELETE - ML_APPLICATION_IMPLEMENTATION_UPDATE - ML_APPLICATION_IMPLEMENTATION_MOVE - ML_APPLICATION_INSTANCE_CREATE - ML_APPLICATION_INSTANCE_UPDATE - ML_APPLICATION_INSTANCE_DELETE - ML_APPLICATION_INSTANCE_MOVE - ML_APPLICATION_INSTANCE_VIEW_CREATE - ML_APPLICATION_INSTANCE_VIEW_UPDATE - ML_APPLICATION_INSTANCE_VIEW_DELETE - ML_APPLICATION_INSTANCE_VIEW_UPGRADE - ML_APPLICATION_INSTANCE_VIEW_MOVE - PRIVATE_ENDPOINT_CREATE - PRIVATE_ENDPOINT_DELETE - PRIVATE_ENDPOINT_MOVE - PRIVATE_ENDPOINT_UPDATE - SCHEDULE_CREATE - SCHEDULE_UPDATE - SCHEDULE_DELETE - SCHEDULE_MOVE - SCHEDULE_ACTIVATE - SCHEDULE_DEACTIVATE - RESTORE_ARCHIVED_MODEL - COMPUTE_TARGET_CREATE - COMPUTE_TARGET_UPDATE - COMPUTE_TARGET_DELETE - MODEL_GROUP_CREATE - MODEL_GROUP_UPDATE - MODEL_GROUP_DELETE - MODEL_GROUP_VERSION_HISTORY_DELETE MlApplicationInstanceLifecycleStateQueryParam: description: A filter to return only resources matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MlApplicationInstance/lifecycleState' schema: type: string WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. in: path name: workRequestId required: true schema: type: string ScheduleSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated InferenceKeyQueryParam: description: Filter results by the inference key. in: query name: inferenceKey required: false x-default-description: 'null' schema: type: string maxLength: 32 minLength: 1 JobRunLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/JobRunLifecycleState' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETED - NEEDS_ATTENTION ModelVersionSetLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/ModelVersionSetLifecycleState' schema: type: string enum: - ACTIVE - DELETING - DELETED - FAILED MlApplicationSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated ContentDispositionHeader: description: "This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n" in: header name: content-disposition required: false x-default-description: 'null' schema: type: string PipelineIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. in: query name: pipelineId required: false schema: type: string MlApplicationIdentifierQueryParam: description: unique MlApplication identifier in: query name: mlApplicationId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DisplayNameQueryParam: description: Filter results by its user-friendly name. in: query name: displayName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 NotebookSessionSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName JobLifecycleStateQueryParam: description: "Filter results by the specified lifecycle state. Must be a valid\n state for the resource type.\n" in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/JobLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED ModelDeploymentSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. See [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine). ' in: query name: page required: false x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 ScheduleIdentifierQueryParam: description: unique Schedule identifier in: query name: id x-default-description: 'null' schema: type: string MlApplicationIdentifierPathParam: description: unique MlApplication identifier in: path name: mlApplicationId required: true schema: type: string maxLength: 255 minLength: 1 DataScienceResourceTypeQueryParam: description: 'Resource types in the Data Science service such as notebooks. ' in: query name: dataScienceResourceType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DataScienceResourceType' schema: type: string enum: - NOTEBOOK_SESSION - MODEL_DEPLOYMENT ComputeTargetIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target. in: path name: computeTargetId required: true schema: type: string MlApplicationInstanceIdentifierPathParam: description: unique MlApplicationInstance identifier in: path name: mlApplicationInstanceId required: true schema: type: string maxLength: 255 minLength: 1 ProjectsSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName DataSciencePrivateEndpointLifecycleStateQueryParam: description: 'The lifecycle state of the private endpoint. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DataSciencePrivateEndpointLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION JobIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. in: path name: jobId required: true schema: type: string VersionLabelQueryParam: description: Filter results by version label. in: query name: versionLabel required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 JobSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName ProjectIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project. in: path name: projectId required: true x-default-description: 'null' schema: type: string ModelGroupVersionHistoryLifecycleStateQueryParam: description: A filter to return resources matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ModelGroupVersionHistoryLifecycleState' schema: type: string enum: - ACTIVE - DELETED - FAILED - DELETING ModelDeploymentLifecycleStateQueryParam: description: 'Filter results by the specified lifecycle state. Must be a valid state for the resource type. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ModelDeploymentLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - FAILED - INACTIVE - UPDATING - DELETED - NEEDS_ATTENTION RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 ModelVersionSetSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - name - lifecycleState MlApplicationImplementationIdPathParam: description: unique MlApplicationImplementation identifier in: path name: mlApplicationImplementationId required: true schema: type: string maxLength: 255 minLength: 1 ModelDeploymentIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment. in: path name: modelDeploymentId required: true x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - operationType - status - timeAccepted ModelGroupsSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName - lifecycleState ScheduleLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ScheduleLifecycleState' schema: type: string enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED CompartmentIdInSubtreeQueryParam: description: If it is true search must include all results from descendant compartments. Value true is allowed only if compartmentId refers to root compartment. in: query name: compartmentIdInSubtree x-default-description: Default value is false schema: type: boolean default: false OcidQueryParam: description: 'Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. ' in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PipelineRunLifecycleStateQueryParam: description: The current state of the PipelineRun. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PipelineRunLifecycleState' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETING - DELETED ScheduleIdentifierPathParam: description: unique Schedule identifier in: path name: scheduleId required: true schema: type: string MlApplicationPackageArgumentsHeader: description: 'List of arguments (Json map - argument name to argument value) for ML Application package (available arguments are in ML Application package descriptor). E.g. {"vcnId": "ocid1.vcn.oc1.iad.abcd...", "logId":"ocid1.log.oc1.iad.abcd..."}' in: header name: opc-ml-app-package-args required: false schema: type: string default: '{}' maxLength: 1024 minLength: 1 PipelineRunTerminateGracefullyQueryParam: description: A boolean value to specify whether to terminate pipeline run gracefully. in: query name: terminateGracefully required: false x-default-description: 'false' schema: type: boolean PipelineRunIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run. in: path name: pipelineRunId required: true schema: type: string MlApplicationImplementationSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated CompartmentIdQueryParam: description: Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 JobContentDispositionHeader: description: 'This header is for specifying a filename during upload. It is used to identify the file type and validate if the file type is supported. Example: `--content-disposition "attachment; filename=hello-world.py"` ' in: header name: content-disposition required: false x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit required: false schema: type: integer default: 50 maximum: 100 minimum: 1 PipelineLifecycleStateQueryParam: description: The current state of the Pipeline. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - FAILED - DELETED ModelsSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName - lifecycleState DeleteRelatedJobRunsQueryParam: description: A boolean value to specify whether to delete related jobRuns or not. in: query name: deleteRelatedJobRuns required: false x-default-description: 'false' schema: type: boolean MlApplicationInstanceViewSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated JobIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. in: query name: jobId required: false x-default-description: 'null' schema: type: string MlApplicationInstanceIdQueryParam: description: unique MlApplicationInstance identifier in: query name: mlApplicationInstanceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RestoreModelForHoursSpecifiedParam: description: Duration in hours for which the archived model is available for access. in: query name: restoreModelForHoursSpecified required: false schema: type: integer default: 24 maximum: 240 minimum: 1 ModelGroupIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup. in: path name: modelGroupId required: true schema: type: string MlApplicationInstanceSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated ResourceIdQueryParam: description: Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource associated with the work request. in: query name: resourceId x-default-description: 'null' schema: type: string DataSciencePrivateEndpointSortByQueryParam: description: 'The field used to sort the results. Multiple fields aren''t supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated default: timeCreated ModelGroupLifecycleStateQueryParam: description: A filter to return resources matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ModelGroupLifecycleState' schema: type: string enum: - CREATING - ACTIVE - FAILED - INACTIVE - DELETING - DELETED MlApplicationImplementationVersionIdPathParam: description: unique MlApplicationImplementationVersion identifier in: path name: mlApplicationImplementationVersionId required: true schema: type: string maxLength: 255 minLength: 1 DataSciencePrivateEndpointIdPathParam: description: 'The unique ID for a Data Science private endpoint. ' in: path name: dataSciencePrivateEndpointId required: true schema: type: string MlApplicationImplementationLifecycleStateQueryParam: description: A filter to return only resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MlApplicationImplementation/lifecycleState' schema: type: string RangeRequestHeader: description: 'Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1. Note that only a single range of bytes is supported. ' in: header name: range required: false x-default-description: 'null' schema: type: string PipelineIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. in: path name: pipelineId required: true schema: type: string ModelVersionSetNameQueryParam: description: Filter results by the name of the model version set. in: query name: modelVersionSetName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ModelVersionSetIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set. in: path name: modelVersionSetId required: true schema: type: string MlApplicationImplementationVersionLifecycleStateQueryParam: description: A filter to return only resources matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MlApplicationImplementationVersion/lifecycleState' schema: type: string ComputeTargetSortByQueryParam: description: 'Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive. ' in: query name: sortBy required: false x-default-description: timeCreated schema: type: string enum: - timeCreated - displayName responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. type: string content-length: description: The content size of the body in bytes. format: int64 type: integer content-location: description: 'The URI that identifies the entity described in the response body. ' type: string content-md5: description: 'The base-64 encoded MD5 hash of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. Unavailable for objects uploaded using multipart upload. If the `content-md5` header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message: "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" ' type: string content-range: description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233), section 4.2. type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' type: string last-modified: description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. format: date-time type: string location: description: 'The URI that identifies the entity described in the response body. ' type: string opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' type: string retry-after: description: Indicates the number of seconds to wait before making a follow-up request. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-splat-stuff: x-allowedTenantIdForRestriction: allowedTenancies: - ALLOWED_TENANT_ID_FOR_RESTRICTION x-computeTargetAudit: resourceNameExpression: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetComputeTarget').displayName x-computeTargetResource: existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetComputeTarget').freeformTags.'.splatAuthorizedTagSlug' targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetComputeTarget').compartmentId x-computeTargetResourceExistingTags: existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetComputeTarget').freeformTags.'.splatAuthorizedTagSlug' x-jobInternalEndpointCompartmentId: targetCompartmentId: JOB_INTERNAL_ENDPOINT_COMPARTMENT_ID x-modelDeploymentAdminCompartmentId: targetCompartmentId: MODEL_DEPLOYMENT_ADMIN_COMPARTMENT_OCID x-notebookSessionAudit: resourceNameExpression: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').displayName x-notebookSessionBlockCoreQuota: usage: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails=notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; configDetails?.blockStorageSizeInGBs' x-notebookSessionCoreQuota: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''standard2-core-regional-count'')).split(''-ad-'').join(''-regional-'')' x-notebookSessionCoreQuotaAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''standard2-core-regional-count'')).split(''-ad-'').join(''-regional-'')' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Standard.E2'') || shape.contains(''Standard2'')' x-notebookSessionCoreQuotaUsageAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''standard2-core-regional-count'')).split(''-ad-'').join(''-regional-'')' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Standard.E2'') || shape.contains(''Standard2'')' usage: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FIXED'').param(''shape'', shape).query()?.usage ?: 0' x-notebookSessionExistingTags: additionalContextVariables: target.notebook-session.createdBy: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').createdBy target.notebook-session.id: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').id existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').freeformTags.'.splatAuthorizedTagSlug' x-notebookSessionFlexCoreQuota: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; quotaName=(''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)); quotaName?.contains(''-ad-'') ? quotaName?.split(''-ad'').join(''-regional'') : quotaName?.split(''-count'')[0].plus(''-regional-count'') ?: ''''' x-notebookSessionFlexCoreQuotaAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; quotaName=(''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)); quotaName?.contains(''-ad-'') ? quotaName?.split(''-ad'').join(''-regional'') : quotaName?.split(''-count'')[0].plus(''-regional-count'') ?: ''''' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Flex'') || shape.contains(''Generic'')' x-notebookSessionFlexCoreQuotaUsageAndUpdateConditon: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; quotaName=(''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)); quotaName?.contains(''-ad-'') ? quotaName?.split(''-ad'').join(''-regional'') : quotaName?.split(''-count'')[0].plus(''-regional-count'') ?: ''''' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Flex'') || shape.contains(''Generic'')' usage: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; quotaMapping.buildQuery().adLocal().quotaType(''CORE'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.usage ?: 0' x-notebookSessionFlexMemoryQuota: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''MEMORY'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)) ?: ''''' x-notebookSessionFlexMemoryQuotaAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''MEMORY'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)) ?: ''''' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Flex'') || shape.contains(''Generic'')' x-notebookSessionFlexMemoryQuotaUsageAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; (''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''MEMORY'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.quotaName)) ?: ''''' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''Flex'') || shape.contains(''Generic'')' usage: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); configDetails = notebookSession?.notebookSessionConfigurationDetails ?: notebookSession?.notebookSessionConfigDetails; quotaMapping.buildQuery().adLocal().quotaType(''MEMORY'').shapeType(''FLEXIBLE'') .param(''shape'', configDetails?.shape) .param(''ocpus'', configDetails?.notebookSessionShapeConfigDetails?.ocpus) .param(''memoryInGBs'', configDetails?.notebookSessionShapeConfigDetails?.memoryInGBs) .param(''baselineOcpuUtilization'', configDetails?.notebookSessionShapeConfigDetails?.cpuBaseline) .param(''tenantId'', splat.getTenancyId(request.body?.compartmentId)) .query()?.usage ?: 0' x-notebookSessionGpuCoreQuota: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; ''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''GPU'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''gpu2-count'')' x-notebookSessionGpuCoreQuotaAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; ''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''GPU'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''gpu2-count'')' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''GPU'') ' x-notebookSessionGpuCoreQuotaUsageAndUpdateCondition: quotaName: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; ''ds-'' + (quotaMapping.buildQuery().adLocal().quotaType(''GPU'').shapeType(''FIXED'').param(''shape'', shape).query()?.quotaName ?: ''gpu2-count'')' updateCondition: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; shape.contains(''GPU'') ' usage: 'notebookSession=downstream.fetcher().pathParams(request.resourceId).queryParams([''hash'':request.opcRequestId.hashCode()]).errorMappings([''4xx'': [''NotAuthorizedOrNotFound'', ''NotebookSession ''+request.resourceId+'' not found'']]).fetch(request.serviceName, ''GetNotebookSession''); shape=notebookSession?.notebookSessionConfigurationDetails?.shape ?: notebookSession?.notebookSessionConfigDetails?.shape; quotaMapping.buildQuery().adLocal().quotaType(''GPU'').shapeType(''FIXED'').param(''shape'', shape).query()?.usage ?: 0' x-notebookSessionResource: additionalContextVariables: target.notebook-session.createdBy: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').createdBy target.notebook-session.id: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').id existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').freeformTags.'.splatAuthorizedTagSlug' targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetNotebookSession').compartmentId x-privateEndpointResource: existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetDataSciencePrivateEndpoint').freeformTags.'.splatAuthorizedTagSlug' targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetDataSciencePrivateEndpoint').compartmentId x-privateEndpointResourceExistingTags: existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetDataSciencePrivateEndpoint').freeformTags.'.splatAuthorizedTagSlug' x-projectAudit: resourceNameExpression: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetProject').displayName x-projectResource: targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetProject').compartmentId x-projectResourceExistingTags: existingTags: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetProject').freeformTags.'.splatAuthorizedTagSlug' x-projectResourceForCreate: existingTags: downstream.fetcher().pathParams(request.body.projectId).fetch(request.serviceName, 'GetProject').freeformTags.'.splatAuthorizedTagSlug' targetCompartmentId: downstream.fetcher().pathParams(request.body.projectId).fetch(request.serviceName, 'GetProject').compartmentId x-workRequestResource: targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetWorkRequest').compartmentId x-oracle-package: com.oracle.pic.odsc.client