CloudTrail

public struct CloudTrail

Client object for interacting with AWS CloudTrail service.

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 AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

Member variables

Initialization

  • Initialize the CloudTrail client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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).

    Declaration

    Swift

    public func addTags(_ input: AddTagsRequest) -> EventLoopFuture<AddTagsResponse>

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

    Declaration

    Swift

    public func createTrail(_ input: CreateTrailRequest) -> EventLoopFuture<CreateTrailResponse>

  • 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.

    Declaration

    Swift

    public func deleteTrail(_ input: DeleteTrailRequest) -> EventLoopFuture<DeleteTrailResponse>

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

    Declaration

    Swift

    public func describeTrails(_ input: DescribeTrailsRequest) -> EventLoopFuture<DescribeTrailsResponse>

  • 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 Amazon S3 objects or AWS Lambda functions that you are logging for data events. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

    Declaration

    Swift

    public func getEventSelectors(_ input: GetEventSelectorsRequest) -> EventLoopFuture<GetEventSelectorsResponse>

  • 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 in the AWS CloudTrail User Guide.

    Declaration

    Swift

    public func getInsightSelectors(_ input: GetInsightSelectorsRequest) -> EventLoopFuture<GetInsightSelectorsResponse>

  • Returns settings information for a specified trail.

    Declaration

    Swift

    public func getTrail(_ input: GetTrailRequest) -> EventLoopFuture<GetTrailResponse>

  • 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.

    Declaration

    Swift

    public func getTrailStatus(_ input: GetTrailStatusRequest) -> EventLoopFuture<GetTrailStatusResponse>

  • 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.

    Declaration

    Swift

    public func listPublicKeys(_ input: ListPublicKeysRequest) -> EventLoopFuture<ListPublicKeysResponse>

  • Lists the tags for the trail in the current region.

    Declaration

    Swift

    public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResponse>

  • Lists trails that are in the current account.

    Declaration

    Swift

    public func listTrails(_ input: ListTrailsRequest) -> EventLoopFuture<ListTrailsResponse>

  • Looks up management events or CloudTrail 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. If this limit is exceeded, a throttling error occurs.

    Declaration

    Swift

    public func lookupEvents(_ input: LookupEventsRequest) -> EventLoopFuture<LookupEventsResponse>

  • Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be 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 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 You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event but it 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 is thrown. You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.

    Declaration

    Swift

    public func putEventSelectors(_ input: PutEventSelectorsRequest) -> EventLoopFuture<PutEventSelectorsResponse>

  • 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.

    Declaration

    Swift

    public func putInsightSelectors(_ input: PutInsightSelectorsRequest) -> EventLoopFuture<PutInsightSelectorsResponse>

  • Removes the specified tags from a trail.

    Declaration

    Swift

    public func removeTags(_ input: RemoveTagsRequest) -> EventLoopFuture<RemoveTagsResponse>

  • 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.

    Declaration

    Swift

    public func startLogging(_ input: StartLoggingRequest) -> EventLoopFuture<StartLoggingResponse>

  • 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.

    Declaration

    Swift

    public func stopLogging(_ input: StopLoggingRequest) -> EventLoopFuture<StopLoggingResponse>

  • 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.

    Declaration

    Swift

    public func updateTrail(_ input: UpdateTrailRequest) -> EventLoopFuture<UpdateTrailResponse>

Paginators

  • 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.

    Declaration

    Swift

    public func listPublicKeysPaginator(_ input: ListPublicKeysRequest, onPage: @escaping (ListPublicKeysResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists the tags for the trail in the current region.

    Declaration

    Swift

    public func listTagsPaginator(_ input: ListTagsRequest, onPage: @escaping (ListTagsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists trails that are in the current account.

    Declaration

    Swift

    public func listTrailsPaginator(_ input: ListTrailsRequest, onPage: @escaping (ListTrailsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Looks up management events or CloudTrail 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. If this limit is exceeded, a throttling error occurs.

    Declaration

    Swift

    public func lookupEventsPaginator(_ input: LookupEventsRequest, onPage: @escaping (LookupEventsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum EventCategory : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum InsightType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LookupAttributeKey : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ReadWriteType : String, CustomStringConvertible, Codable