Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRealtimeLogConfig

Updates a real-time log configuration.

When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:

Call GetRealtimeLogConfig to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.

You cannot update a real-time log configuration's Name or ARN.

Request Syntax


PUT /2020-05-31/realtime-log-config HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<UpdateRealtimeLogConfigRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <ARN>string</ARN>
   <EndPoints>
      <EndPoint>
         <KinesisStreamConfig>
            <RoleARN>string</RoleARN>
            <StreamARN>string</StreamARN>
         </KinesisStreamConfig>
         <StreamType>string</StreamType>
      </EndPoint>
   </EndPoints>
   <Fields>
      <Field>string</Field>
   </Fields>
   <Name>string</Name>
   <SamplingRate>long</SamplingRate>
</UpdateRealtimeLogConfigRequest>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

UpdateRealtimeLogConfigRequest

Root level tag for the UpdateRealtimeLogConfigRequest parameters.

Required: Yes

ARN

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

Type: String

Required: No

EndPoints

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

Type: Array of EndPoint objects

Required: No

Fields

A list of fields to include in each real-time log record.

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

Type: Array of strings

Required: No

Name

The name for this real-time log configuration.

Type: String

Required: No

SamplingRate

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. You must provide an integer between 1 and 100, inclusive.

Type: Long

Required: No

Response Syntax


HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<UpdateRealtimeLogConfigResult>
   <RealtimeLogConfig>
      <ARN>string</ARN>
      <EndPoints>
         <EndPoint>
            <KinesisStreamConfig>
               <RoleARN>string</RoleARN>
               <StreamARN>string</StreamARN>
            </KinesisStreamConfig>
            <StreamType>string</StreamType>
         </EndPoint>
      </EndPoints>
      <Fields>
         <Field>string</Field>
      </Fields>
      <Name>string</Name>
      <SamplingRate>long</SamplingRate>
   </RealtimeLogConfig>
</UpdateRealtimeLogConfigResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

UpdateRealtimeLogConfigResult

Root level tag for the UpdateRealtimeLogConfigResult parameters.

Required: Yes

RealtimeLogConfig

A real-time log configuration.

Type: RealtimeLogConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDenied

Access denied.

HTTP Status Code: 403

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

NoSuchRealtimeLogConfig

The real-time log configuration does not exist.

HTTP Status Code: 404