Logging Amazon Chime API calls with AWS CloudTrail - Amazon Chime

You must be an Amazon Chime system administrator to complete the steps in this guide. If you need help with the Amazon Chime desktop client, web app, or mobile app, see Getting support in the Amazon Chime User Guide.

Logging Amazon Chime API calls with AWS CloudTrail

Amazon Chime is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amazon Chime. CloudTrail captures all API calls for Amazon Chime as events, including calls from the Amazon Chime console and from code calls to the Amazon Chime APIs. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon Chime. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Amazon Chime, the IP address from which the request was made, who made the request, when it was made, and additional details.

To learn more about CloudTrail, see the AWS CloudTrail User Guide.

Amazon Chime information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When API calls are made from the Amazon Chime administration console, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail event history.

For an ongoing record of events in your AWS account, including events for Amazon Chime, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the : Event data collected in CloudTrail logs. For more information, see:

All Amazon Chime actions are logged by CloudTrail and are documented in the Amazon Chime API Reference. For example, calls to the CreateAccount, InviteUsers and ResetPersonalPIN sections generate entries in the CloudTrail log files. Every event or log entry contains information about who generated the request. The identity information helps you determine the following:

  • Whether the request was made with root or IAM user credentials.

  • Whether the request was made with temporary security credentials for a role, or a federated user.

  • Whether the request was made by another AWS service.

For more information, see the CloudTrail userIdentity element.

Understanding Amazon Chime log file entries

A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files are not an ordered stack trace of the public API calls, so they do not appear in any specific order.

Entries for Amazon Chime are identified by the chime.amazonaws.com event source.

If you have configured Active Directory for your Amazon Chime account, see Logging AWS Directory Service API calls using CloudTrail. This describes how to monitor for issues that might affect your Amazon Chime users’ ability to sign in.

The following example shows a CloudTrail log entry for Amazon Chime:

{"eventVersion":"1.05", "userIdentity":{ "type":"IAMUser", "principalId":" AAAAAABBBBBBBBEXAMPLE", "arn":"arn:aws:iam::123456789012:user/Alice ", "accountId":"0123456789012", "accessKeyId":"AAAAAABBBBBBBBEXAMPLE", "sessionContext":{ "attributes":{ "mfaAuthenticated":"false", "creationDate":"2017-07-24T17:57:43Z" }, "sessionIssuer":{ "type":"Role", "principalId":"AAAAAABBBBBBBBEXAMPLE", "arn":"arn:aws:iam::123456789012:role/Joe", "accountId":"123456789012", "userName":"Joe" } } } , "eventTime":"2017-07-24T17:58:21Z", "eventSource":"chime.amazonaws.com", "eventName":"AddDomain", "awsRegion":"us-east-1", "sourceIPAddress":"", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36", "errorCode":"ConflictException", "errorMessage":"Request could not be completed due to a conflict", "requestParameters":{ "domainName":"example.com", "accountId":"11aaaaaa1-1a11-1111-1a11-aaadd0a0aa00" }, "responseElements":null, "requestID":"be1bee1d-1111-11e1-1eD1-0dc1111f1ac1", "eventID":"00fbeee1-123e-111e-93e3-11111bfbfcc1", "eventType":"AwsApiCall", "recipientAccountId":"123456789012" }