CloudFront / Client / list_realtime_log_configs

list_realtime_log_configs#

CloudFront.Client.list_realtime_log_configs(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_realtime_log_configs(
    MaxItems='string',
    Marker='string'
)
Parameters:

  • MaxItems (string) – The maximum number of real-time log configurations that you want in the response.

  • Marker (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'RealtimeLogConfigs': {
        'MaxItems': 123,
        'Items': [
            {
                'ARN': 'string',
                'Name': 'string',
                'SamplingRate': 123,
                'EndPoints': [
                    {
                        'StreamType': 'string',
                        'KinesisStreamConfig': {
                            'RoleARN': 'string',
                            'StreamARN': 'string'
                        }
                    },
                ],
                'Fields': [
                    'string',
                ]
            },
        ],
        'IsTruncated': True|False,
        'Marker': 'string',
        'NextMarker': 'string'
    }
}

Response Structure

  • (dict) –

    • RealtimeLogConfigs (dict) –

      A list of real-time log configurations.

      • MaxItems (integer) –

        The maximum number of real-time log configurations requested.

      • Items (list) –

        Contains the list of real-time log configurations.

        • (dict) –

          A real-time log configuration.

          • ARN (string) –

            The Amazon Resource Name (ARN) of this real-time log configuration.

          • Name (string) –

            The unique name of this real-time log configuration.

          • SamplingRate (integer) –

            The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

          • EndPoints (list) –

            Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

            • (dict) –

              Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.

              • StreamType (string) –

                The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

              • KinesisStreamConfig (dict) –

                Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

                • RoleARN (string) –

                  The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

                  For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide.

                • StreamARN (string) –

                  The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

          • Fields (list) –

            A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

            For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

            • (string) –

      • IsTruncated (boolean) –

        A flag that indicates whether there are more real-time log configurations than are contained in this list.

      • Marker (string) –

        This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.

      • NextMarker (string) –

        If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.

Exceptions