MarketplaceClient

class oci.marketplace.MarketplaceClient(config, **kwargs)

Manage applications in Oracle Cloud Infrastructure Marketplace.

Methods

__init__(config, **kwargs) Creates a new service client
create_accepted_agreement(…) Accepts a terms of use agreement for a specific package version of a listing.
delete_accepted_agreement(…) Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment.
get_accepted_agreement(…) Gets the details of a specific, previously accepted terms of use agreement.
get_agreement(listing_id, package_version, …) Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.
get_listing(listing_id, **kwargs) Gets detailed information about a listing, including the listing’s name, version, description, and resources.
get_package(listing_id, package_version, …) Get the details of the specified version of a package, including information needed to launch the package.
list_accepted_agreements(compartment_id, …) Lists the terms of use agreements that have been accepted in the specified compartment.
list_agreements(listing_id, package_version, …) Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
list_categories(**kwargs) Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace.
list_listings(**kwargs) Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.
list_packages(listing_id, **kwargs) Gets the list of packages for a listing.
list_publishers(**kwargs) Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
list_report_types(compartment_id, **kwargs) Lists available types of reports for the compartment.
list_reports(report_type, date, …) Lists reports in the compartment that match the specified report type and date.
update_accepted_agreement(…) Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.
__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.

create_accepted_agreement(create_accepted_agreement_details, **kwargs)

Accepts a terms of use agreement for a specific package version of a listing. You must accept all terms of use for a package before you can deploy the package.

Parameters:
  • create_accepted_agreement_details (CreateAcceptedAgreementDetails) – (required) Details necessary to accept an agreement.
  • 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.
  • 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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 AcceptedAgreement

Return type:

Response

delete_accepted_agreement(accepted_agreement_id, **kwargs)

Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment. Listings in the Marketplace that require acceptance of the specified terms of use can no longer be deployed, but existing deployments aren’t affected.

Parameters:
  • accepted_agreement_id (str) – (required) The unique identifier for the accepted terms of use agreement.
  • signature (str) – (optional) Deprecated. The signature value is ignored.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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

get_accepted_agreement(accepted_agreement_id, **kwargs)

Gets the details of a specific, previously accepted terms of use agreement.

Parameters:
  • accepted_agreement_id (str) – (required) The unique identifier for the accepted terms of use agreement.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 AcceptedAgreement

Return type:

Response

get_agreement(listing_id, package_version, agreement_id, **kwargs)

Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.

Parameters:
  • listing_id (str) – (required) The unique identifier for the listing.
  • package_version (str) – (required) The version of the package. Package versions are unique within a listing.
  • agreement_id (str) – (required) The unique identifier for the agreement.
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 Agreement

Return type:

Response

get_listing(listing_id, **kwargs)

Gets detailed information about a listing, including the listing’s name, version, description, and resources.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

Parameters:
  • listing_id (str) – (required) The unique identifier for the listing.
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 Listing

Return type:

Response

get_package(listing_id, package_version, **kwargs)

Get the details of the specified version of a package, including information needed to launch the package.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

Parameters:
  • listing_id (str) – (required) The unique identifier for the listing.
  • package_version (str) – (required) The version of the package. Package versions are unique within a listing.
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 ListingPackage

Return type:

Response

list_accepted_agreements(compartment_id, **kwargs)

Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.

Parameters:
  • compartment_id (str) – (required) The unique identifier for the compartment.
  • display_name (str) – (optional) The display name of the resource.
  • listing_id (str) – (optional) The unique identifier for the listing.
  • package_version (str) – (optional) The version of the package. Package versions are unique within a listing.
  • accepted_agreement_id (str) – (optional) The unique identifier for the accepted terms of use agreement.
  • 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. TIMEACCEPTED displays results in descending order by default. You can change your preference by specifying a different sort order.

    Allowed values are: “TIMEACCEPTED”

  • sort_order (str) –

    (optional) The sort order to use, either ASC or DESC.

    Allowed values are: “ASC”, “DESC”

  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of AcceptedAgreementSummary

Return type:

Response

list_agreements(listing_id, package_version, **kwargs)

Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.

Parameters:
  • listing_id (str) – (required) The unique identifier for the listing.
  • package_version (str) – (required) The version of the package. Package versions are unique within a listing.
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of AgreementSummary

Return type:

Response

list_categories(**kwargs)

Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply to the software product provided by the listing.

Parameters:
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of CategorySummary

Return type:

Response

list_listings(**kwargs)

Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

Parameters:
  • name (list[str]) – (optional) The name of the listing.
  • listing_id (str) – (optional) The unique identifier for the listing.
  • publisher_id (str) – (optional) Limit results to just this publisher.
  • package_type (str) – (optional) A filter to return only packages that match the given package type exactly.
  • 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. TIMERELEASED displays results in descending order by default. You can change your preference by specifying a different sort order.

    Allowed values are: “TIMERELEASED”

  • sort_order (str) –

    (optional) The sort order to use, either ASC or DESC.

    Allowed values are: “ASC”, “DESC”

  • category (list[str]) – (optional) Name of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with one or more matching categories.
  • pricing (list[str]) –

    (optional) Name of the pricing type. If multiple pricing types are provided, then any listing 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 listings. If this is set to false or is omitted, then all listings will be returned.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of ListingSummary

Return type:

Response

list_packages(listing_id, **kwargs)

Gets the list of packages for a listing.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

Parameters:
  • listing_id (str) – (required) The unique identifier for the listing.
  • package_version (str) – (optional) The version of the package. Package versions are unique within a listing.
  • package_type (str) – (optional) A filter to return only packages that match the given package type exactly.
  • 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. TIMERELEASED displays results in descending order by default. You can change your preference by specifying a different sort order.

    Allowed values are: “TIMERELEASED”

  • sort_order (str) –

    (optional) The sort order to use, either ASC or DESC.

    Allowed values are: “ASC”, “DESC”

  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of ListingPackageSummary

Return type:

Response

list_publishers(**kwargs)

Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.

Parameters:
  • publisher_id (str) – (optional) Limit results to just this publisher.
  • 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.
  • compartment_id (str) – (optional) The unique identifier for the compartment.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 list of PublisherSummary

Return type:

Response

list_report_types(compartment_id, **kwargs)

Lists available types of reports for the compartment.

Parameters:
  • compartment_id (str) – (required) The unique identifier for the compartment.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 ReportTypeCollection

Return type:

Response

list_reports(report_type, date, compartment_id, **kwargs)

Lists reports in the compartment that match the specified report type and date.

Parameters:
  • report_type (str) – (required) The type of the report.
  • date (datetime) – (required) Date, expressed in YYYYMMDD format, where Y represents the year, M represents the month, and D represents the day.
  • compartment_id (str) – (required) The unique identifier for the compartment.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 ReportCollection

Return type:

Response

update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, **kwargs)

Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.

Parameters:
  • accepted_agreement_id (str) – (required) The unique identifier for the accepted terms of use agreement.
  • update_accepted_agreement_details (UpdateAcceptedAgreementDetails) – (required) Details to update for an accepted agreement.
  • 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.
  • 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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. 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 AcceptedAgreement

Return type:

Response