Skip to content
AWS for Query.Farm

aws.cloudfront.list_realtime_log_configs

Example SQL Queries

SELECT * FROM
aws.cloudfront.list_realtime_log_configs;

Description

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.

Table Definition

Column NameColumn Data Type
marker Input Column

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.

VARCHAR
max_items Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

realtime_log_configs

A list of real-time log configurations.

STRUCT(
    "max_items" BIGINT,
    "items" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR,
        "sampling_rate" BIGINT,
        "end_points" STRUCT(
            "stream_type" VARCHAR,
            "kinesis_stream_config" STRUCT(
                "role_arn" VARCHAR,
                "stream_arn" VARCHAR
            )
        )[],
        "fields" VARCHAR[]
    )[],
    "is_truncated" BOOLEAN,
    "marker" VARCHAR,
    "next_marker" VARCHAR
)
Show child fields
realtime_log_configs.is_truncated

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

realtime_log_configs.items[]
Show child fields
realtime_log_configs.items[].arn

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

realtime_log_configs.items[].end_points[]
Show child fields
realtime_log_configs.items[].end_points[].kinesis_stream_config

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

Show child fields
realtime_log_configs.items[].end_points[].kinesis_stream_config.role_arn

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.

realtime_log_configs.items[].end_points[].kinesis_stream_config.stream_arn

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

realtime_log_configs.items[].end_points[].stream_type

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

realtime_log_configs.items[].fields[]
realtime_log_configs.items[].name

The unique name of this real-time log configuration.

realtime_log_configs.items[].sampling_rate

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.

realtime_log_configs.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.

realtime_log_configs.max_items

The maximum number of real-time log configurations requested.

realtime_log_configs.next_marker

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.