Skip to content

put_app_instance_retention_settings

put_app_instance_retention_settings(
    app_instance_arn: ChimeArn,
    app_instance_retention_settings: AppInstanceRetentionSettings,
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> PutAppInstanceRetentionSettingsResponse

Sets the amount of time in days that a given AppInstance retains data.

Parameters:

  • app_instance_arn (ChimeArn) –

    The ARN of the AppInstance.

  • app_instance_retention_settings (AppInstanceRetentionSettings) –

    The time in days to retain data. Data type: number.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/chime_sdk_identity.py
def put_app_instance_retention_settings(
    self,
    app_instance_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    app_instance_retention_settings: "capo_chime_sdk_identity.types.app_instance_retention_settings.AppInstanceRetentionSettings",
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> "capo_chime_sdk_identity.types.put_app_instance_retention_settings_response.PutAppInstanceRetentionSettingsResponse":
    """<p>Sets the amount of time in days that a given <code>AppInstance</code> retains data.</p>

    Args:
        app_instance_arn: <p>The ARN of the <code>AppInstance</code>.</p>
        app_instance_retention_settings: <p>The time in days to retain data. Data type: number.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_identity.types.put_app_instance_retention_settings_request.PutAppInstanceRetentionSettingsRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_identity.types.put_app_instance_retention_settings_response.PutAppInstanceRetentionSettingsResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.put_app_instance_retention_settings

        output, http_response = (
            capo_chime_sdk_identity._operations.chime_identity_service.put_app_instance_retention_settings.put_app_instance_retention_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutAppInstanceRetentionSettings")
    )
    input_: capo_chime_sdk_identity.types.put_app_instance_retention_settings_request.PutAppInstanceRetentionSettingsRequest = {
        "app_instance_arn": app_instance_arn,
        "app_instance_retention_settings": app_instance_retention_settings,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output