Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeFlowLogs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Synopsis

data DescribeFlowLogs = DescribeFlowLogs' {
- dryRun :: Maybe Bool
- filter' :: Maybe [Filter]
- flowLogIds :: Maybe [Text]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
}
newDescribeFlowLogs :: DescribeFlowLogs
describeFlowLogs_dryRun :: Lens' DescribeFlowLogs (Maybe Bool)
describeFlowLogs_filter :: Lens' DescribeFlowLogs (Maybe [Filter])
describeFlowLogs_flowLogIds :: Lens' DescribeFlowLogs (Maybe [Text])
describeFlowLogs_maxResults :: Lens' DescribeFlowLogs (Maybe Int)
describeFlowLogs_nextToken :: Lens' DescribeFlowLogs (Maybe Text)
data DescribeFlowLogsResponse = DescribeFlowLogsResponse' {
- flowLogs :: Maybe [FlowLog]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeFlowLogsResponse :: Int -> DescribeFlowLogsResponse
describeFlowLogsResponse_flowLogs :: Lens' DescribeFlowLogsResponse (Maybe [FlowLog])
describeFlowLogsResponse_nextToken :: Lens' DescribeFlowLogsResponse (Maybe Text)
describeFlowLogsResponse_httpStatus :: Lens' DescribeFlowLogsResponse Int

Creating a Request

data DescribeFlowLogs Source #

See: newDescribeFlowLogs smart constructor.

Constructors

DescribeFlowLogs'

Fields

dryRun :: Maybe Bool
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' :: Maybe [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 :: Maybe [Text]
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
maxResults :: Maybe Int
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

ToHeaders DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods toHeaders :: DescribeFlowLogs -> [Header] #
ToPath DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods toPath :: DescribeFlowLogs -> ByteString #
ToQuery DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods toQuery :: DescribeFlowLogs -> QueryString #
AWSPager DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods page :: DescribeFlowLogs -> AWSResponse DescribeFlowLogs -> Maybe DescribeFlowLogs #
AWSRequest DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Associated Types type AWSResponse DescribeFlowLogs # Methods request :: (Service -> Service) -> DescribeFlowLogs -> Request DescribeFlowLogs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFlowLogs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFlowLogs))) #
Generic DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Associated Types type Rep DescribeFlowLogs :: Type -> Type # Methods from :: DescribeFlowLogs -> Rep DescribeFlowLogs x # to :: Rep DescribeFlowLogs x -> DescribeFlowLogs #
Read DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods readsPrec :: Int -> ReadS DescribeFlowLogs # readList :: ReadS [DescribeFlowLogs] # readPrec :: ReadPrec DescribeFlowLogs # readListPrec :: ReadPrec [DescribeFlowLogs] #
Show DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods showsPrec :: Int -> DescribeFlowLogs -> ShowS # show :: DescribeFlowLogs -> String # showList :: [DescribeFlowLogs] -> ShowS #
NFData DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods rnf :: DescribeFlowLogs -> () #
Eq DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods (==) :: DescribeFlowLogs -> DescribeFlowLogs -> Bool # (/=) :: DescribeFlowLogs -> DescribeFlowLogs -> Bool #
Hashable DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods hashWithSalt :: Int -> DescribeFlowLogs -> Int # hash :: DescribeFlowLogs -> Int #
type AWSResponse DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs type AWSResponse DescribeFlowLogs = DescribeFlowLogsResponse
type Rep DescribeFlowLogs Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs type Rep DescribeFlowLogs = D1 ('MetaData "DescribeFlowLogs" "Amazonka.EC2.DescribeFlowLogs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeFlowLogs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "flowLogIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeFlowLogs :: DescribeFlowLogs Source #

Create a value of DescribeFlowLogs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeFlowLogs', describeFlowLogs_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.

$sel:filter':DescribeFlowLogs', describeFlowLogs_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.

$sel:flowLogIds:DescribeFlowLogs', describeFlowLogs_flowLogIds - One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

$sel:maxResults:DescribeFlowLogs', describeFlowLogs_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeFlowLogs, describeFlowLogs_nextToken - The token for the next page of results.

Request Lenses

describeFlowLogs_dryRun :: Lens' DescribeFlowLogs (Maybe Bool) Source #

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.

describeFlowLogs_filter :: Lens' DescribeFlowLogs (Maybe [Filter]) Source #

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.

describeFlowLogs_flowLogIds :: Lens' DescribeFlowLogs (Maybe [Text]) Source #

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

describeFlowLogs_maxResults :: Lens' DescribeFlowLogs (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeFlowLogs_nextToken :: Lens' DescribeFlowLogs (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeFlowLogsResponse Source #

See: newDescribeFlowLogsResponse smart constructor.

Constructors

DescribeFlowLogsResponse'
Fields flowLogs :: Maybe [FlowLog] Information about the flow logs. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Associated Types type Rep DescribeFlowLogsResponse :: Type -> Type # Methods from :: DescribeFlowLogsResponse -> Rep DescribeFlowLogsResponse x # to :: Rep DescribeFlowLogsResponse x -> DescribeFlowLogsResponse #
Read DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods readsPrec :: Int -> ReadS DescribeFlowLogsResponse # readList :: ReadS [DescribeFlowLogsResponse] # readPrec :: ReadPrec DescribeFlowLogsResponse # readListPrec :: ReadPrec [DescribeFlowLogsResponse] #
Show DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods showsPrec :: Int -> DescribeFlowLogsResponse -> ShowS # show :: DescribeFlowLogsResponse -> String # showList :: [DescribeFlowLogsResponse] -> ShowS #
NFData DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods rnf :: DescribeFlowLogsResponse -> () #
Eq DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs Methods (==) :: DescribeFlowLogsResponse -> DescribeFlowLogsResponse -> Bool # (/=) :: DescribeFlowLogsResponse -> DescribeFlowLogsResponse -> Bool #
type Rep DescribeFlowLogsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFlowLogs type Rep DescribeFlowLogsResponse = D1 ('MetaData "DescribeFlowLogsResponse" "Amazonka.EC2.DescribeFlowLogs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeFlowLogsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FlowLog])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFlowLogsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeFlowLogsResponse'`
-> DescribeFlowLogsResponse

Create a value of DescribeFlowLogsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:flowLogs:DescribeFlowLogsResponse', describeFlowLogsResponse_flowLogs - Information about the flow logs.

DescribeFlowLogs, describeFlowLogsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeFlowLogsResponse', describeFlowLogsResponse_httpStatus - The response's http status code.

Response Lenses

describeFlowLogsResponse_flowLogs :: Lens' DescribeFlowLogsResponse (Maybe [FlowLog]) Source #

Information about the flow logs.

describeFlowLogsResponse_nextToken :: Lens' DescribeFlowLogsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeFlowLogsResponse_httpStatus :: Lens' DescribeFlowLogsResponse Int Source #

The response's http status code.