Skip to content

EC2  >  Operations  >  get_flow_logs_integration_template

get_flow_logs_integration_template

Operation

get_flow_logs_integration_template async 

get_flow_logs_integration_template(input: GetFlowLogsIntegrationTemplateInput, plugins: list[Plugin] | None = None) -> GetFlowLogsIntegrationTemplateOutput

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:

  • Create a table in Athena that maps fields to a custom log format

  • Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis

  • Create a table partitioned between two timestamps in the past

  • Create a set of named queries in Athena that you can use to get started quickly

Note

GetFlowLogsIntegrationTemplate does not support integration between Amazon Web Services Transit Gateway Flow Logs or Amazon Web Services Cloud WAN Flow Logs and Amazon Athena.

Parameters:

Name Type Description Default
input GetFlowLogsIntegrationTemplateInput

An instance of GetFlowLogsIntegrationTemplateInput.

 required
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
GetFlowLogsIntegrationTemplateOutput

An instance of GetFlowLogsIntegrationTemplateOutput.

Input

GetFlowLogsIntegrationTemplateInput dataclass

Bases: _SerdeShape

Dataclass for GetFlowLogsIntegrationTemplateInput structure.

Attributes

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

To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

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.

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

The ID of the flow log.

integrate_services class-attribute instance-attribute 
integrate_services: IntegrateServices | None = ...

Information about the service integration.

Output

GetFlowLogsIntegrationTemplateOutput dataclass

Bases: _SerdeShape

Dataclass for GetFlowLogsIntegrationTemplateOutput structure.

Attributes

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.

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

The generated CloudFormation template.