ListRealtimeLogConfigs - Amazon CloudFront

ListRealtimeLogConfigs

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.

Request Syntax

GET /2020-05-31/realtime-log-config?Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Marker

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.

MaxItems

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <RealtimeLogConfigs> <IsTruncated>boolean</IsTruncated> <Items> <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> </Items> <Marker>string</Marker> <MaxItems>integer</MaxItems> <NextMarker>string</NextMarker> </RealtimeLogConfigs>

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.

RealtimeLogConfigs

Root level tag for the RealtimeLogConfigs parameters.

Required: Yes

IsTruncated

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

Type: Boolean

Items

Contains the list of real-time log configurations.

Type: Array of RealtimeLogConfig objects

Marker

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

Type: String

MaxItems

The maximum number of real-time log configurations requested.

Type: Integer

NextMarker

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.

Type: String

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: