Skip to content

EC2  >  Operations  >  describe_flow_logs

describe_flow_logs

Operation

describe_flow_logs async

describe_flow_logs(request: DescribeFlowLogsInput | DescribeFlowLogsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeFlowLogsOutput
describe_flow_logs(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeFlowLogsInputDict]) -> DescribeFlowLogsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeFlowLogsOutput

An instance of DescribeFlowLogsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeFlowLogsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeFlowLogsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
filter: list[Filter] | None = ...

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.

flow_log_ids class-attribute instance-attribute
flow_log_ids: list[str] | None = ...

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

Dictionaries

DescribeFlowLogsInputDict

Bases: TypedDict

Dictionary form of DescribeFlowLogsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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 instance-attribute
filter: Sequence[Filter | FilterDict] | None

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.

flow_log_ids instance-attribute
flow_log_ids: Sequence[str] | None

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

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

Output

DescribeFlowLogsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeFlowLogsOutput structure.

Attributes

flow_logs class-attribute instance-attribute
flow_logs: list[FlowLog] | None = ...

Information about the flow logs.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to request the next page of items. This value is null when there are no more items to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.