GetRealtimeLogConfig - Amazon CloudFront

GetRealtimeLogConfig

Gets a real-time log configuration.

To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.

Request Syntax

POST /2020-05-31/get-realtime-log-config/ HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <GetRealtimeLogConfigRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/"> <ARN>string</ARN> <Name>string</Name> </GetRealtimeLogConfigRequest>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

GetRealtimeLogConfigRequest

Root level tag for the GetRealtimeLogConfigRequest parameters.

Required: Yes

ARN

The Amazon Resource Name (ARN) of the real-time log configuration to get.

Type: String

Required: No

Name

The name of the real-time log configuration to get.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetRealtimeLogConfigResult> <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> </GetRealtimeLogConfigResult>

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.

GetRealtimeLogConfigResult

Root level tag for the GetRealtimeLogConfigResult 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

See Also

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