GetRealtimeLogConfigCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFrontClient, GetRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
// const { CloudFrontClient, GetRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
const client = new CloudFrontClient(config);
const input = { // GetRealtimeLogConfigRequest
  Name: "STRING_VALUE",
  ARN: "STRING_VALUE",
};
const command = new GetRealtimeLogConfigCommand(input);
const response = await client.send(command);
// { // GetRealtimeLogConfigResult
//   RealtimeLogConfig: { // RealtimeLogConfig
//     ARN: "STRING_VALUE", // required
//     Name: "STRING_VALUE", // required
//     SamplingRate: Number("long"), // required
//     EndPoints: [ // EndPointList // required
//       { // EndPoint
//         StreamType: "STRING_VALUE", // required
//         KinesisStreamConfig: { // KinesisStreamConfig
//           RoleARN: "STRING_VALUE", // required
//           StreamARN: "STRING_VALUE", // required
//         },
//       },
//     ],
//     Fields: [ // FieldList // required
//       "STRING_VALUE",
//     ],
//   },
// };

GetRealtimeLogConfigCommand Input

See GetRealtimeLogConfigCommandInput for more details

Parameter
Type
Description
ARN
string | undefined

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

Name
string | undefined

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

GetRealtimeLogConfigCommand Output

See GetRealtimeLogConfigCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RealtimeLogConfig
RealtimeLogConfig | undefined

A real-time log configuration.

Throws

Name
Fault
Details
AccessDenied
client

Access denied.

InvalidArgument
client

An argument is invalid.

NoSuchRealtimeLogConfig
client

The real-time log configuration does not exist.

CloudFrontServiceException
Base exception class for all service exceptions from CloudFront service.