NAME

Paws::CloudTrail - Perl Interface to AWS AWS CloudTrail

SYNOPSIS

  use Paws;
  my $obj = Paws->service('CloudTrail');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page (http://aws.amazon.com/tools/).

See the AWS CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) for information about the data that is included with each AWS API call listed in the log files.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01>

METHODS

AddTags

ResourceId => Str
[TagsList => ArrayRef[Paws::CloudTrail::Tag]]

Each argument is described in detail in: Paws::CloudTrail::AddTags

Returns: a Paws::CloudTrail::AddTagsResponse instance

Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).

CreateTrail

Name => Str
S3BucketName => Str
[CloudWatchLogsLogGroupArn => Str]
[CloudWatchLogsRoleArn => Str]
[EnableLogFileValidation => Bool]
[IncludeGlobalServiceEvents => Bool]
[IsMultiRegionTrail => Bool]
[IsOrganizationTrail => Bool]
[KmsKeyId => Str]
[S3KeyPrefix => Str]
[SnsTopicName => Str]
[TagsList => ArrayRef[Paws::CloudTrail::Tag]]

Each argument is described in detail in: Paws::CloudTrail::CreateTrail

Returns: a Paws::CloudTrail::CreateTrailResponse instance

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

DeleteTrail

Name => Str

Each argument is described in detail in: Paws::CloudTrail::DeleteTrail

Returns: a Paws::CloudTrail::DeleteTrailResponse instance

Deletes a trail. This operation must be called from the region in which the trail was created. "DeleteTrail" cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

DescribeTrails

[IncludeShadowTrails => Bool]
[TrailNameList => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CloudTrail::DescribeTrails

Returns: a Paws::CloudTrail::DescribeTrailsResponse instance

Retrieves settings for one or more trails associated with the current region for your account.

GetEventSelectors

TrailName => Str

Each argument is described in detail in: Paws::CloudTrail::GetEventSelectors

Returns: a Paws::CloudTrail::GetEventSelectorsResponse instance

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the resources on which you are logging data events.

For more information, see Logging Data and Management Events for Trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) in the AWS CloudTrail User Guide.

GetInsightSelectors

TrailName => Str

Each argument is described in detail in: Paws::CloudTrail::GetInsightSelectors

Returns: a Paws::CloudTrail::GetInsightSelectorsResponse instance

Describes the settings for the Insights event selectors that you configured for your trail. "GetInsightSelectors" shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run "GetInsightSelectors" on a trail that does not have Insights events enabled, the operation throws the exception "InsightNotEnabledException"

For more information, see Logging CloudTrail Insights Events for Trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) in the AWS CloudTrail User Guide.

GetTrail

Name => Str

Each argument is described in detail in: Paws::CloudTrail::GetTrail

Returns: a Paws::CloudTrail::GetTrailResponse instance

Returns settings information for a specified trail.

GetTrailStatus

Name => Str

Each argument is described in detail in: Paws::CloudTrail::GetTrailStatus

Returns: a Paws::CloudTrail::GetTrailStatusResponse instance

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

ListPublicKeys

[EndTime => Str]
[NextToken => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::CloudTrail::ListPublicKeys

Returns: a Paws::CloudTrail::ListPublicKeysResponse instance

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

ResourceIdList => ArrayRef[Str|Undef]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudTrail::ListTags

Returns: a Paws::CloudTrail::ListTagsResponse instance

Lists the tags for the trail in the current region.

ListTrails

[NextToken => Str]

Each argument is described in detail in: Paws::CloudTrail::ListTrails

Returns: a Paws::CloudTrail::ListTrailsResponse instance

Lists trails that are in the current account.

LookupEvents

[EndTime => Str]
[EventCategory => Str]
[LookupAttributes => ArrayRef[Paws::CloudTrail::LookupAttribute]]
[MaxResults => Int]
[NextToken => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::CloudTrail::LookupEvents

Returns: a Paws::CloudTrail::LookupEventsResponse instance

Looks up management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events) or CloudTrail Insights events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events) that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:

AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name

Lookup supports the following attributes for Insights events:

Event ID
Event name
Event source

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.

PutEventSelectors

TrailName => Str
[AdvancedEventSelectors => ArrayRef[Paws::CloudTrail::AdvancedEventSelector]]
[EventSelectors => ArrayRef[Paws::CloudTrail::EventSelector]]

Each argument is described in detail in: Paws::CloudTrail::PutEventSelectors

Returns: a Paws::CloudTrail::PutEventSelectorsResponse instance

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

1.: You create an event selector for a trail and specify that you want write-only events.
2.: The EC2 "GetConsoleOutput" and "RunInstances" API operations occur in your account.
3.: CloudTrail evaluates whether the events match your event selectors.
4.: The "RunInstances" is a write-only event and it matches your event selector. The trail logs the event.
5.: The "GetConsoleOutput" is a read-only event that doesn't match your event selector. The trail doesn't log the event.

The "PutEventSelectors" operation must be called from the region in which the trail was created; otherwise, an "InvalidHomeRegionException" exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) and Quotas in AWS CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the AWS CloudTrail User Guide.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either "AdvancedEventSelectors" or "EventSelectors", but not both. If you apply "AdvancedEventSelectors" to a trail, any existing "EventSelectors" are overwritten. For more information about advanced event selectors, see Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the AWS CloudTrail User Guide.

PutInsightSelectors

InsightSelectors => ArrayRef[Paws::CloudTrail::InsightSelector]
TrailName => Str

Each argument is described in detail in: Paws::CloudTrail::PutInsightSelectors

Returns: a Paws::CloudTrail::PutInsightSelectorsResponse instance

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use "PutInsightSelectors" to turn off Insights event logging, by passing an empty list of insight types. In this release, only "ApiCallRateInsight" is supported as an Insights selector.

RemoveTags

ResourceId => Str
[TagsList => ArrayRef[Paws::CloudTrail::Tag]]

Each argument is described in detail in: Paws::CloudTrail::RemoveTags

Returns: a Paws::CloudTrail::RemoveTagsResponse instance

Removes the specified tags from a trail.

StartLogging

Name => Str

Each argument is described in detail in: Paws::CloudTrail::StartLogging

Returns: a Paws::CloudTrail::StartLoggingResponse instance

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

StopLogging

Name => Str

Each argument is described in detail in: Paws::CloudTrail::StopLogging

Returns: a Paws::CloudTrail::StopLoggingResponse instance

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an "InvalidHomeRegionException" will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

UpdateTrail

Name => Str
[CloudWatchLogsLogGroupArn => Str]
[CloudWatchLogsRoleArn => Str]
[EnableLogFileValidation => Bool]
[IncludeGlobalServiceEvents => Bool]
[IsMultiRegionTrail => Bool]
[IsOrganizationTrail => Bool]
[KmsKeyId => Str]
[S3BucketName => Str]
[S3KeyPrefix => Str]
[SnsTopicName => Str]

Each argument is described in detail in: Paws::CloudTrail::UpdateTrail

Returns: a Paws::CloudTrail::UpdateTrailResponse instance

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. "UpdateTrail" must be called from the region in which the trail was created; otherwise, an "InvalidHomeRegionException" is thrown.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllPublicKeys(sub { },[EndTime => Str, NextToken => Str, StartTime => Str])

ListAllPublicKeys([EndTime => Str, NextToken => Str, StartTime => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - PublicKeyList, passing the object as the first parameter, and the string 'PublicKeyList' as the second parameter

If not, it will return a a Paws::CloudTrail::ListPublicKeysResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTags(sub { },ResourceIdList => ArrayRef[Str|Undef], [NextToken => Str])

ListAllTags(ResourceIdList => ArrayRef[Str|Undef], [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ResourceTagList, passing the object as the first parameter, and the string 'ResourceTagList' as the second parameter

If not, it will return a a Paws::CloudTrail::ListTagsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTrails(sub { },[NextToken => Str])

ListAllTrails([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Trails, passing the object as the first parameter, and the string 'Trails' as the second parameter

If not, it will return a a Paws::CloudTrail::ListTrailsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

LookupAllEvents(sub { },[EndTime => Str, EventCategory => Str, LookupAttributes => ArrayRef[Paws::CloudTrail::LookupAttribute], MaxResults => Int, NextToken => Str, StartTime => Str])

LookupAllEvents([EndTime => Str, EventCategory => Str, LookupAttributes => ArrayRef[Paws::CloudTrail::LookupAttribute], MaxResults => Int, NextToken => Str, StartTime => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Events, passing the object as the first parameter, and the string 'Events' as the second parameter

If not, it will return a a Paws::CloudTrail::LookupEventsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>