Skip to content

Describe Flow Logs

ec2_describe_flow_logs R Documentation

Describes one or more flow logs

Description

Describes one or more flow logs.

To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

Usage

ec2_describe_flow_logs(DryRun, Filter, FlowLogIds, MaxResults,
  NextToken)

Arguments

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Filter

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

  • tag:\<key\> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

FlowLogIds

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

Value

A list with the following syntax: 

list(
  FlowLogs = list(
    list(
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      DeliverLogsErrorMessage = "string",
      DeliverLogsPermissionArn = "string",
      DeliverCrossAccountRole = "string",
      DeliverLogsStatus = "string",
      FlowLogId = "string",
      FlowLogStatus = "string",
      LogGroupName = "string",
      ResourceId = "string",
      TrafficType = "ACCEPT"|"REJECT"|"ALL",
      LogDestinationType = "cloud-watch-logs"|"s3"|"kinesis-data-firehose",
      LogDestination = "string",
      LogFormat = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      MaxAggregationInterval = 123,
      DestinationOptions = list(
        FileFormat = "plain-text"|"parquet",
        HiveCompatiblePartitions = TRUE|FALSE,
        PerHourPartition = TRUE|FALSE
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_flow_logs(
  DryRun = TRUE|FALSE,
  Filter = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  FlowLogIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)