AnnouncementClient

class oci.announcements_service.AnnouncementClient(config, **kwargs)

Manage Oracle Cloud Infrastructure console announcements.

Methods

__init__(config, **kwargs) Creates a new service client
get_announcement(announcement_id, **kwargs) Gets the details of a specific announcement.
get_announcement_compartment(…) Gets the compartment details of an announcement.
get_announcement_user_status(…) Gets information about whether a specific announcement was acknowledged by a user.
list_announcements(compartment_id, **kwargs) Gets a list of announcements for the current tenancy.
update_announcement_user_status(…) Updates the status of the specified announcement with regard to whether it has been marked as read.
__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 uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. 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.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
get_announcement(announcement_id, **kwargs)

Gets the details of a specific announcement.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:
  • announcement_id (str) – (required) The OCID of the announcement.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete 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.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Announcement
Return type:

Response
Example:

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

get_announcement_compartment(announcement_id, **kwargs)

Gets the compartment details of an announcement.

Parameters:
  • announcement_id (str) – (required) The OCID of the announcement.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete 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.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AnnouncementCompartment
Return type:

Response
Example:

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

get_announcement_user_status(announcement_id, **kwargs)

Gets information about whether a specific announcement was acknowledged by a user.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:
  • announcement_id (str) – (required) The OCID of the announcement.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete 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.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AnnouncementUserStatusDetails
Return type:

Response
Example:

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

list_announcements(compartment_id, **kwargs)

Gets a list of announcements for the current tenancy.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • announcement_type (str) – (optional) The type of announcement.
  • lifecycle_state (str) –

    (optional) The announcement’s current lifecycle state.

    Allowed values are: “ACTIVE”, “INACTIVE”

  • is_banner (bool) – (optional) Whether the announcement is displayed as a console banner.
  • sort_by (str) –

    (optional) The criteria to sort by. You can specify only one sort order.

    Allowed values are: “timeOneValue”, “timeTwoValue”, “timeCreated”, “referenceTicketNumber”, “summary”, “announcementType”

  • sort_order (str) –

    (optional) The sort order to use. (Sorting by announcementType orders the announcements list according to importance.)

    Allowed values are: “ASC”, “DESC”

  • time_one_earliest_time (datetime) – (optional) The boundary for the earliest timeOneValue date on announcements that you want to see.
  • time_one_latest_time (datetime) – (optional) The boundary for the latest timeOneValue date on announcements that you want to see.
  • environment_name (str) – (optional) A filter to return only announcements that match a specific environment name.
  • service (str) – (optional) A filter to return only announcements affecting a specific service.
  • platform_type (str) –

    (optional) A filter to return only announcements affecting a specific platform.

    Allowed values are: “IAAS”, “SAAS”, “PAAS”

  • exclude_announcement_types (list[str]) – (optional) Exclude The type of announcement.
  • should_show_only_latest_in_chain (bool) – (optional) A filter to display only the latest announcement in a chain.
  • chain_id (str) – (optional) A filter to return only announcements belonging to the specified announcement chain ID.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete 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.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AnnouncementsCollection
Return type:

Response
Example:

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

update_announcement_user_status(announcement_id, status_details, **kwargs)

Updates the status of the specified announcement with regard to whether it has been marked as read.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:
  • announcement_id (str) – (required) The OCID of the announcement.
  • status_details (oci.announcements_service.models.AnnouncementUserStatusDetails) – (required) The information to use to update the announcement’s read status.
  • if_match (str) – (optional) The locking version, used for optimistic concurrency control.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete 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.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AnnouncementUserStatusDetails
Return type:

Response
Example:

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