2022/09/08 - Amazon Elastic Compute Cloud - 2 updated api methods
Changes This release adds support to send VPC Flow Logs to kinesis-data-firehose as new destination type
{'DeliverCrossAccountRole': 'string',
'LogDestinationType': {'kinesis-data-firehose'}}
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide .
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
client.create_flow_logs(
DryRun=True|False,
ClientToken='string',
DeliverLogsPermissionArn='string',
DeliverCrossAccountRole='string',
LogGroupName='string',
ResourceIds=[
'string',
],
ResourceType='VPC'|'Subnet'|'NetworkInterface'|'TransitGateway'|'TransitGatewayAttachment',
TrafficType='ACCEPT'|'REJECT'|'ALL',
LogDestinationType='cloud-watch-logs'|'s3'|'kinesis-data-firehose',
LogDestination='string',
LogFormat='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'vpn-connection-device-type',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MaxAggregationInterval=123,
DestinationOptions={
'FileFormat': 'plain-text'|'parquet',
'HiveCompatiblePartitions': True|False,
'PerHourPartition': True|False
}
)
boolean
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 .
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
string
The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.
string
The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
string
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs .
list
[REQUIRED]
The IDs of the resources to monitor. For example, if the resource type is VPC , specify the IDs of the VPCs.
Constraints: Maximum of 1000 resources
(string) --
string
[REQUIRED]
The type of resource to monitor.
string
The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
string
The type of destination for the flow log data.
Default: cloud-watch-logs
string
The destination for the flow log data. The meaning of this parameter depends on the destination type.
If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example: arn:aws:logs:region :account_id :log-group:my_group Alternatively, use the LogGroupName parameter.
If the destination type is s3 , specify the ARN of an S3 bucket. For example: arn:aws:s3:::my_bucket /my_subfolder / The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example: arn:aws:firehose:region :account_id :deliverystream:my_stream
string
The fields to include in the flow log record. List the fields in the order in which they should appear. For more information about the available fields, see Flow log records . If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
list
The tags to apply to the flow logs.
(dict) --
The tags to apply to a resource when the resource is being created.
Note
The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
integer
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
dict
The destination options.
FileFormat (string) --
The format for the flow log. The default is plain-text .
HiveCompatiblePartitions (boolean) --
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false .
PerHourPartition (boolean) --
Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false .
dict
Response Syntax
{
'ClientToken': 'string',
'FlowLogIds': [
'string',
],
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
FlowLogIds (list) --
The IDs of the flow logs.
(string) --
Unsuccessful (list) --
Information about the flow logs that could not be created successfully.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
{'FlowLogs': {'DeliverCrossAccountRole': 'string',
'LogDestinationType': {'kinesis-data-firehose'}}}
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.
See also: AWS API Documentation
Request Syntax
client.describe_flow_logs(
DryRun=True|False,
Filter=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
FlowLogIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
boolean
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 .
list
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.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
list
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'FlowLogs': [
{
'CreationTime': datetime(2015, 1, 1),
'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': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaxAggregationInterval': 123,
'DestinationOptions': {
'FileFormat': 'plain-text'|'parquet',
'HiveCompatiblePartitions': True|False,
'PerHourPartition': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FlowLogs (list) --
Information about the flow logs.
(dict) --
Describes a flow log.
CreationTime (datetime) --
The date and time the flow log was created.
DeliverLogsErrorMessage (string) --
Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
DeliverLogsPermissionArn (string) --
The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
DeliverCrossAccountRole (string) --
The ARN of the IAM role that allows the service to publish flow logs across accounts.
DeliverLogsStatus (string) --
The status of the logs delivery (SUCCESS | FAILED ).
FlowLogId (string) --
The ID of the flow log.
FlowLogStatus (string) --
The status of the flow log (ACTIVE ).
LogGroupName (string) --
The name of the flow log group.
ResourceId (string) --
The ID of the resource being monitored.
TrafficType (string) --
The type of traffic captured for the flow log.
LogDestinationType (string) --
The type of destination for the flow log data.
LogDestination (string) --
The Amazon Resource Name (ARN) of the destination for the flow log data.
LogFormat (string) --
The format of the flow log record.
Tags (list) --
The tags for the flow log.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
MaxAggregationInterval (integer) --
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
DestinationOptions (dict) --
The destination options.
FileFormat (string) --
The format for the flow log.
HiveCompatiblePartitions (boolean) --
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
PerHourPartition (boolean) --
Indicates whether to partition the flow log per hour.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.