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.
See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
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 10. Tags must be
unique per trail. Overwrites an existing tag's value when a new value
is specified for an existing tag key. 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 regions only from the
region in which the trail was created (that is, from its home region).CreateTrail(Name => Str, S3BucketName => Str, [CloudWatchLogsLogGroupArn => Str, CloudWatchLogsRoleArn => Str, EnableLogFileValidation => Bool, IncludeGlobalServiceEvents => Bool, IsMultiRegionTrail => Bool, KmsKeyId => Str, S3KeyPrefix => Str, SnsTopicName => Str])
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. A maximum of five trails can exist in a region,
irrespective of the region in which they were created.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. C<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]])
Each argument is described in detail in: Paws::CloudTrail::DescribeTrails
Returns: a Paws::CloudTrail::DescribeTrailsResponse instance
Retrieves settings for the trail associated with the current region for
your account.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.
ListTags(ResourceIdList => ArrayRef[Str], [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.LookupEvents([EndTime => 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 API activity events captured by CloudTrail that create,
update, or delete resources in your account. Events for a region can be
looked up for the times in which you had CloudTrail turned on in that
region during the last seven days. Lookup supports five different
attributes: time range (defined by a start time and end time), user
name, event name, resource type, and resource name. All attributes are
optional. The maximum number of attributes that can be specified in any
one lookup request are time range and one other attribute. The default
number of results returned is 10, 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 one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
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 C<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, 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. C<UpdateTrail> must be called from the
region in which the trail was created; otherwise, an
C<InvalidHomeRegionException> is thrown.SEE ALSO
This service class forms part of Paws
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