AnnouncementClient

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

Manage Oracle Cloud Infrastructure console announcements.

__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 is that the client never times out. 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.

get_announcement(announcement_id, **kwargs)

Gets information about an announcement. Gets the details of a specific 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. 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 Announcement

Return type:

Response

get_announcement_user_status(announcement_id, **kwargs)

Gets the read status of an announcement. Gets information about whether a specific announcement was acknowledged by a user.

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. 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 AnnouncementUserStatusDetails

Return type:

Response

list_announcements(compartment_id, **kwargs)

Lists announcements for the tenancy. Gets a list of announcements for the current tenancy.

Parameters:
  • compartment_id (str) -- (required) The OCID of the compartment. Because announcements are specific to a tenancy, this is the OCID of the root 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.
  • 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. 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 AnnouncementsCollection

Return type:

Response

update_announcement_user_status(announcement_id, status_details, **kwargs)

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

Parameters:
  • announcement_id (str) -- (required) The OCID of the announcement.
  • status_details (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. 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