CloudWatchLogs / Client / list_syslog_configurations

list_syslog_configurations

CloudWatchLogs.Client.list_syslog_configurations(**kwargs)

Returns a list of syslog configurations. You can optionally filter the results by log group or VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.list_syslog_configurations(
    logGroupIdentifier='string',
    vpcEndpointId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • logGroupIdentifier (string) – The name or ARN of the log group to filter syslog configurations for.

  • vpcEndpointId (string) – The ID of the VPC endpoint to filter syslog configurations for.

  • nextToken (string) – The token for the next set of items to return. You received this token from a previous call.

  • maxResults (integer) – The maximum number of syslog configurations to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'syslogConfigurations': [
        {
            'logGroupArn': 'string',
            'sourceType': 'VPCE',
            'vpcEndpointId': 'string',
            'createdAt': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • syslogConfigurations (list) –

      The list of syslog configurations.

      • (dict) –

        Contains information about a syslog configuration associated with a log group.

        • logGroupArn (string) –

          The ARN of the log group associated with this syslog configuration.

        • sourceType (string) –

          The source type for the syslog configuration.

        • vpcEndpointId (string) –

          The ID of the VPC endpoint used for syslog ingestion.

        • createdAt (integer) –

          The time when the syslog configuration was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

    • nextToken (string) –

      The token for the next set of items to return. The token expires after 24 hours.

Exceptions