Skip to content

list_realtime_log_configs

list_realtime_log_configs(
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    max_items: Optional[integer] = None,
    marker: Optional[string] = None,
) -> ListRealtimeLogConfigsResult

Gets a list of real-time log configurations.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Parameters:

  • max_items (Optional[integer], default: None ) –

    The maximum number of real-time log configurations that you want in the response.

  • marker (Optional[string], default: None ) –

    Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.

Raises:

Source code in docs_src/capo_cloudfront/_services/cloud_front.py
def list_realtime_log_configs(
    self,
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    max_items: Optional["capo_cloudfront.types.integer.integer"] = None,
    marker: Optional["capo_cloudfront.types.string.string"] = None,
) -> "capo_cloudfront.types.list_realtime_log_configs_result.ListRealtimeLogConfigsResult":
    """<p>Gets a list of real-time log configurations.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>

    Args:
        max_items: <p>The maximum number of real-time log configurations that you want in the response.</p>
        marker: <p>Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <code>NextMarker</code> from the current page's response.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
        capo_cloudfront.errors.invalid_argument.InvalidArgument: <p>An argument is invalid.</p>
        capo_cloudfront.errors.no_such_realtime_log_config.NoSuchRealtimeLogConfig: <p>The real-time log configuration does not exist.</p>
        capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront.types.list_realtime_log_configs_request.ListRealtimeLogConfigsRequest]",
    ) -> OperationResponse[
        "capo_cloudfront.types.list_realtime_log_configs_result.ListRealtimeLogConfigsResult"
    ]:
        import capo_cloudfront._operations.cloudfront2020_05_31.list_realtime_log_configs

        output, http_response = (
            capo_cloudfront._operations.cloudfront2020_05_31.list_realtime_log_configs.list_realtime_log_configs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRealtimeLogConfigs")
    )
    input_: capo_cloudfront.types.list_realtime_log_configs_request.ListRealtimeLogConfigsRequest = {}
    if max_items is not None:
        input_["max_items"] = max_items
    if marker is not None:
        input_["marker"] = marker

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