ServiceCatalogClient

class oci.service_catalog.ServiceCatalogClient(config, **kwargs)

Manage solutions in Oracle Cloud Infrastructure Service Catalog.

Methods

__init__(config, **kwargs) Creates a new service client
bulk_replace_service_catalog_associations(…) Replace all associations of a given service catalog in one bulk transaction.
change_private_application_compartment(…) Moves the specified private application from one compartment to another.
change_service_catalog_compartment(…) Moves the specified service catalog from one compartment to another.
create_private_application(…) Creates a private application along with a single package to be hosted.
create_service_catalog(…) Creates a brand new service catalog in a given compartment.
create_service_catalog_association(…) Creates an association between service catalog and a resource.
delete_private_application(…) Deletes an existing private application.
delete_service_catalog(service_catalog_id, …) Deletes the specified service catalog from the compartment.
delete_service_catalog_association(…) Removes an association between service catalog and a resource.
get_private_application(…) Gets the details of the specified private application.
get_private_application_action_download_logo(…) Downloads the binary payload of the logo image of the private application.
get_private_application_package(…) Gets the details of a specific package within a given private application.
get_private_application_package_action_download_config(…) Downloads the configuration that was used to create the private application package.
get_service_catalog(service_catalog_id, **kwargs) Gets detailed information about the service catalog including name, compartmentId
get_service_catalog_association(…) Gets detailed information about specific service catalog association.
get_work_request(work_request_id, **kwargs) Gets the status of the work request with the given ID.
list_applications(**kwargs) Lists all the applications in a service catalog or a tenancy.
list_private_application_packages(…) Lists the packages in the specified private application.
list_private_applications(compartment_id, …) Lists all the private applications in a given compartment.
list_service_catalog_associations(**kwargs) Lists all the resource associations for a specific service catalog.
list_service_catalogs(compartment_id, **kwargs) Lists all the service catalogs in the given compartment.
list_work_request_errors(work_request_id, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Return a (paginated) list of logs for a given work request.
list_work_requests(**kwargs) Lists the work requests in a compartment.
update_private_application(…) Updates the details of an existing private application.
update_service_catalog(service_catalog_id, …) Updates the details of a previously created service catalog.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client will not have circuit breakers enabled by default, users can use their own circuit breaker strategy or the convenient DEFAULT_CIRCUIT_BREAKER_STRATEGY provided by the SDK to enable it. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
bulk_replace_service_catalog_associations(service_catalog_id, bulk_replace_service_catalog_associations_details, **kwargs)

Replace all associations of a given service catalog in one bulk transaction.

Parameters:
  • service_catalog_id (str) – (required) The unique identifier for the service catalog.
  • bulk_replace_service_catalog_associations_details (oci.service_catalog.models.BulkReplaceServiceCatalogAssociationsDetails) – (required) Details of the service catalog update operation.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use bulk_replace_service_catalog_associations API.

change_private_application_compartment(private_application_id, change_private_application_compartment_details, **kwargs)

Moves the specified private application from one compartment to another.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • change_private_application_compartment_details (oci.service_catalog.models.ChangePrivateApplicationCompartmentDetails) – (required) The details of the request to change the compartment of a given private application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_private_application_compartment API.

change_service_catalog_compartment(service_catalog_id, change_service_catalog_compartment_details, **kwargs)

Moves the specified service catalog from one compartment to another.

Parameters:
  • service_catalog_id (str) – (required) The unique identifier for the service catalog.
  • change_service_catalog_compartment_details (oci.service_catalog.models.ChangeServiceCatalogCompartmentDetails) – (required) The details of the request to change the compartment of a given service catalog.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_service_catalog_compartment API.

create_private_application(create_private_application_details, **kwargs)

Creates a private application along with a single package to be hosted.

Parameters:
  • create_private_application_details (oci.service_catalog.models.CreatePrivateApplicationDetails) – (required) Private application creation details.
  • opc_retry_token (str) – (optional) 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).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplication

Return type:

Response

Example:

Click here to see an example of how to use create_private_application API.

create_service_catalog(create_service_catalog_details, **kwargs)

Creates a brand new service catalog in a given compartment.

Parameters:
  • create_service_catalog_details (oci.service_catalog.models.CreateServiceCatalogDetails) – (required) The details for creating a service catalog.
  • opc_retry_token (str) – (optional) 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).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalog

Return type:

Response

Example:

Click here to see an example of how to use create_service_catalog API.

create_service_catalog_association(create_service_catalog_association_details, **kwargs)

Creates an association between service catalog and a resource.

Parameters:
  • create_service_catalog_association_details (oci.service_catalog.models.CreateServiceCatalogAssociationDetails) – (required) The details for creating the association between resource and service catalog.
  • opc_retry_token (str) – (optional) 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).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalogAssociation

Return type:

Response

Example:

Click here to see an example of how to use create_service_catalog_association API.

delete_private_application(private_application_id, **kwargs)

Deletes an existing private application.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_private_application API.

delete_service_catalog(service_catalog_id, **kwargs)

Deletes the specified service catalog from the compartment.

Parameters:
  • service_catalog_id (str) – (required) The unique identifier for the service catalog.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_service_catalog API.

delete_service_catalog_association(service_catalog_association_id, **kwargs)

Removes an association between service catalog and a resource.

Parameters:
  • service_catalog_association_id (str) – (required) The unique identifier of the service catalog association.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_service_catalog_association API.

get_private_application(private_application_id, **kwargs)

Gets the details of the specified private application.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplication

Return type:

Response

Example:

Click here to see an example of how to use get_private_application API.

Downloads the binary payload of the logo image of the private application.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_private_application_action_download_logo API.

get_private_application_package(private_application_package_id, **kwargs)

Gets the details of a specific package within a given private application.

Parameters:
  • private_application_package_id (str) – (required) The unique identifier for the private application package.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplicationPackage

Return type:

Response

Example:

Click here to see an example of how to use get_private_application_package API.

get_private_application_package_action_download_config(private_application_package_id, **kwargs)

Downloads the configuration that was used to create the private application package.

Parameters:
  • private_application_package_id (str) – (required) The unique identifier for the private application package.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_private_application_package_action_download_config API.

get_service_catalog(service_catalog_id, **kwargs)

Gets detailed information about the service catalog including name, compartmentId

Parameters:
  • service_catalog_id (str) – (required) The unique identifier for the service catalog.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalog

Return type:

Response

Example:

Click here to see an example of how to use get_service_catalog API.

get_service_catalog_association(service_catalog_association_id, **kwargs)

Gets detailed information about specific service catalog association.

Parameters:
  • service_catalog_association_id (str) – (required) The unique identifier of the service catalog association.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalogAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_service_catalog_association API.

get_work_request(work_request_id, **kwargs)

Gets the status of the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_applications(**kwargs)

Lists all the applications in a service catalog or a tenancy. If no parameter is specified, all catalogs from all compartments in the tenancy will be scanned for any type of content.

Parameters:
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • service_catalog_id (str) – (optional) The unique identifier for the service catalog.
  • entity_type (str) – (optional) The type of the application in the service catalog.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • display_name (str) – (optional) Exact match name filter.
  • entity_id (str) – (optional) The unique identifier of the entity associated with service catalog.
  • publisher_id (list[str]) – (optional) Limit results to just this publisher.
  • package_type (list[str]) –

    (optional) Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned.

    Allowed values are: “STACK”

  • pricing (list[str]) –

    (optional) Name of the pricing type. If multiple pricing types are provided, then any resource with one or more matching pricing models will be returned.

    Allowed values are: “FREE”, “BYOL”, “PAYGO”

  • is_featured (bool) – (optional) Indicates whether to show only featured resources. If this is set to false or is omitted, then all resources will be returned.
  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ApplicationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_applications API.

list_private_application_packages(private_application_id, **kwargs)

Lists the packages in the specified private application.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • private_application_package_id (str) – (optional) The unique identifier for the private application package.
  • package_type (list[str]) –

    (optional) Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned.

    Allowed values are: “STACK”

  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

    (optional) The field to use to sort listed results. You can only specify one field to sort by. TIMECREATED displays results in descending order by default. You can change your preference by specifying a different sort order.

    Allowed values are: “TIMECREATED”, “VERSION”

  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) Exact match name filter.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplicationPackageCollection

Return type:

Response

Example:

Click here to see an example of how to use list_private_application_packages API.

list_private_applications(compartment_id, **kwargs)

Lists all the private applications in a given compartment.

Parameters:
  • compartment_id (str) – (required) The unique identifier for the compartment.
  • private_application_id (str) – (optional) The unique identifier for the private application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • sort_by (str) –

    (optional) The field to use to sort listed results. You can only specify one field to sort by. Default is TIMECREATED.

    Allowed values are: “TIMECREATED”, “LIFECYCLESTATE”

  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) Exact match name filter.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplicationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_private_applications API.

list_service_catalog_associations(**kwargs)

Lists all the resource associations for a specific service catalog.

Parameters:
  • service_catalog_association_id (str) – (optional) The unique identifier for the service catalog association.
  • service_catalog_id (str) – (optional) The unique identifier for the service catalog.
  • entity_id (str) – (optional) The unique identifier of the entity associated with service catalog.
  • entity_type (str) – (optional) The type of the application in the service catalog.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) Default is TIMECREATED

    Allowed values are: “TIMECREATED”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalogAssociationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_service_catalog_associations API.

list_service_catalogs(compartment_id, **kwargs)

Lists all the service catalogs in the given compartment.

Parameters:
  • compartment_id (str) – (required) The unique identifier for the compartment.
  • service_catalog_id (str) – (optional) The unique identifier for the service catalog.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • sort_by (str) –

    (optional) Default is TIMECREATED

    Allowed values are: “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) Exact match name filter.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalogCollection

Return type:

Response

Example:

Click here to see an example of how to use list_service_catalogs API.

list_work_request_errors(work_request_id, **kwargs)

Return a (paginated) list of errors for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

    Allowed values are: “timeAccepted”

  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

Return a (paginated) list of logs for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

    Allowed values are: “timeAccepted”

  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(**kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • work_request_id (str) – (optional) The ID of the asynchronous work request.
  • status (str) –

    (optional) A filter to return only resources their lifecycleState matches the given OperationStatus.

    Allowed values are: “ACCEPTED”, “FAILED”, “SUCCEEDED”

  • resource_id (str) – (optional) The ID of the resource affected by the work request
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
  • sort_order (str) –

    (optional) The sort order to apply, either ASC or DESC. Default is ASC.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

    Allowed values are: “timeAccepted”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

update_private_application(private_application_id, update_private_application_details, **kwargs)

Updates the details of an existing private application.

Parameters:
  • private_application_id (str) – (required) The unique identifier for the private application.
  • update_private_application_details (oci.service_catalog.models.UpdatePrivateApplicationDetails) – (required) The details for updating the private application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateApplication

Return type:

Response

Example:

Click here to see an example of how to use update_private_application API.

update_service_catalog(service_catalog_id, update_service_catalog_details, **kwargs)

Updates the details of a previously created service catalog.

Parameters:
  • service_catalog_id (str) – (required) The unique identifier for the service catalog.
  • update_service_catalog_details (oci.service_catalog.models.UpdateServiceCatalogDetails) – (required) Details to update for a service catalog.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceCatalog

Return type:

Response

Example:

Click here to see an example of how to use update_service_catalog API.