Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
Parameters:
Raises:
Source code in docs_src/capo_chime/_services/async_chime.py
| async def put_retention_settings(
self,
account_id: "capo_chime.types.non_empty_string.NonEmptyString",
retention_settings: "capo_chime.types.retention_settings.RetentionSettings",
*,
config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> (
"capo_chime.types.put_retention_settings_response.PutRetentionSettingsResponse"
):
"""<p> Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see <a href="https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html">Logging Amazon Chime API Calls with AWS CloudTrail</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p> To turn off existing retention settings, remove the number of days from the corresponding <b>RetentionDays</b> field in the <b>RetentionSettings</b> object. For more information about retention settings, see <a href="https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html">Managing Chat Retention Policies</a> in the <i>Amazon Chime Administration Guide</i>.</p>
Args:
account_id: <p>The Amazon Chime account ID.</p>
retention_settings: <p>The retention settings.</p>
Raises:
capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
capo_chime.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_chime.types.put_retention_settings_request.PutRetentionSettingsRequest]",
) -> AsyncOperationResponse[
"capo_chime.types.put_retention_settings_response.PutRetentionSettingsResponse"
]:
import capo_chime._operations.uc_buzz_console_service.put_retention_settings
(
output,
http_response,
) = await capo_chime._operations.uc_buzz_console_service.put_retention_settings.async_put_retention_settings(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("PutRetentionSettings")
)
input_: capo_chime.types.put_retention_settings_request.PutRetentionSettingsRequest = {
"account_id": account_id,
"retention_settings": retention_settings,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|