Class LogRecordIterator
The Aws\CloudTrail\LogRecordIterator provides an easy way to
iterate over log records from log files generated by AWS CloudTrail. CloudTrail
log files contain data about your AWS API calls and are stored in Amazon S3 at a
predictable path based on a bucket name, a key prefix, an account ID, a region,
and date information. The files are gzipped and contain structured data in JSON
format. This class allows you to specify options via its factory methods,
including a date range, and emits each log record from any log files that match
the provided options.
- Aws\CloudTrail\LogRecordIterator implements OuterIterator
Yields: Collection A log record containing data about an AWS API call is yielded for each iteration on this object
Located at Aws/CloudTrail/LogRecordIterator.php
Methods summary
-
public staticforTrail ( Aws\S3\S3Client $s3Client, Aws\CloudTrail\CloudTrailClient $cloudTrailClient, array $options = array() ) -
public staticforBucket ( Aws\S3\S3Client $s3Client, string $s3BucketName, array $options = array() ) -
public staticforFile ( Aws\S3\S3Client $s3Client, string $s3BucketName, string $s3ObjectKey ) -
public__construct ( Aws\CloudTrail\LogFileReader $logFileReader, Iterator $logFileIterator ) -
publiccurrent ( )Returns the current log record as a Guzzle Collection object. This object behaves like an associative array except that it returns
nullon non-existent keys instead of causing an error. See the linked resources for the schema of the log record data and how to work with Guzzle Collections. -
publicnext ( ) -
publickey ( ) -
publicvalid ( ) -
publicrewind ( ) -
publicgetInnerIterator ( )
Methods detail
public static
Aws\CloudTrail\LogRecordIterator
forTrail( Aws\S3\S3Client $s3Client, Aws\CloudTrail\CloudTrailClient $cloudTrailClient, array $options = array() )
Parameters
- $s3Client
Aws\S3\S3Client
$s3Client- $cloudTrailClient
Aws\CloudTrail\CloudTrailClient
$cloudTrailClient- $options
array
$options
Returns
public static
Aws\CloudTrail\LogRecordIterator
forBucket( Aws\S3\S3Client $s3Client, string $s3BucketName, array $options = array() )
Parameters
- $s3Client
Aws\S3\S3Client
$s3Client- $s3BucketName
string
$s3BucketName- $options
array
$options
Returns
public static
Aws\CloudTrail\LogRecordIterator
forFile( Aws\S3\S3Client $s3Client, string $s3BucketName, string $s3ObjectKey )
Parameters
- $s3Client
Aws\S3\S3Client
$s3Client- $s3BucketName
string
$s3BucketName- $s3ObjectKey
string
$s3ObjectKey
Returns
Parameters
- $logFileReader
Aws\CloudTrail\LogFileReader
$logFileReader- $logFileIterator
Iterator
$logFileIterator
Returns the current log record as a Guzzle Collection object. This object
behaves like an associative array except that it returns null on
non-existent keys instead of causing an error. See the linked resources for the
schema of the log record data and how to work with Guzzle Collections.
Returns
Link
http://api.guzzlephp.org/class-Guzzle.Common.Collection.html