Logging Amazon Launch Wizard API calls using Amazon CloudTrail - Amazon Launch Wizard
Launch Wizard information in CloudTrailUnderstanding Launch Wizard log file entries
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Logging Amazon Launch Wizard API calls using Amazon CloudTrail

Amazon Launch Wizard is integrated with Amazon CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon service in Launch Wizard. CloudTrail captures all API calls for Launch Wizard as events. The calls captured include calls from the Launch Wizard console and code calls to the Launch Wizard API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Launch Wizard. 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 Launch Wizard, 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 Amazon CloudTrail User Guide.

Launch Wizard information in CloudTrail

CloudTrail is enabled on your Amazon Web Services account when you create the account. When activity occurs in Launch Wizard, that activity is recorded in a CloudTrail event along with other Amazon service events in Event history. You can view, search, and download recent events in your Amazon Web Services account. For more information, see Viewing events with CloudTrail Event history.

For an ongoing record of events in your Amazon Web Services account, including events for Launch Wizard, 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 Amazon Web Services Regions. The trail logs events from all Regions in the Amazon partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other Amazon services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following:

All Launch Wizard actions are logged by CloudTrail and are documented in the Amazon Launch Wizard API Reference. For example, calls to the CreateDeployment, ListDeployments and GetWorkload actions 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 Amazon Identity and Access Management (IAM) user credentials.

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

  • Whether the request was made by another Amazon service.

For more information, see the CloudTrail userIdentity element.

Understanding Launch Wizard 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 aren't an ordered stack trace of the public API calls, so they don't appear in any specific order.

Example: CreateDeployment

The following example shows a CloudTrail log entry that demonstrates the CreateDeployment operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-05T17:45:27Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "CreateDeployment",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "errorCode": "InternalServerException",
    "requestParameters": {
        "workloadName": "SAP",
        "name": "Example",
        "specifications": "Example",
        "deploymentPatternName": "SapHanaSingle"
    },
    "responseElements": $null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": false,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: DeleteDeployment

The following example shows a CloudTrail log entry that demonstrates the DeleteDeployment operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T16:42:53Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "DeleteDeployment",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/lw.delete-deployment",
    "errorCode": "ValidationException",
    "requestParameters": {
        "deploymentId": "DeploymentIdExample"
    },
    "responseElements": {
        "message": "Example Message."
    },
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": false,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: GetDeployment

The following example shows a CloudTrail log entry that demonstrates the GetDeployment operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:39:02Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "GetDeployment",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": {
        "deploymentId": "DeploymentIdExample"
    },
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: GetWorkload

The following example shows a CloudTrail log entry that demonstrates the GetWorkload operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:59:32Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "GetWorkload",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": {
        "workloadName": "SAP"
    },
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: ListDeploymentEvents

The following example shows a CloudTrail log entry that demonstrates the ListDeploymentEvents operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:38:02Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "ListDeploymentEvents",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": {
        "deploymentId": "DeploymentIdExample"
    },
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: ListDeployments

The following example shows a CloudTrail log entry that demonstrates the ListDeployments operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:38:02Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "ListDeployments",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": {
        "maxResults": 100
    },
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: ListWorkloadDeploymentPattern

The following example shows a CloudTrail log entry that demonstrates the ListWorkloadDeploymentPattern operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:59:32Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "ListWorkloadDeploymentPatterns",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": {
        "workloadName": "SAP",
        "maxResults": 10
    },
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less

Example: ListWorkloads

The following example shows a CloudTrail log entry that demonstrates the ListWorkloads operation.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AIDAQRSTUVWXYZEXAMPLE:ExampleAssumedRoleSessionName",
        "arn": "arn:aws:sts::123456789012:assumed-role/ExampleAssumedRole/ExampleRoleSessionName",
        "accountId": "123456789012",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AIDAQRSTUVWXYZEXAMPLE",
                "arn": "arn:aws:iam::123456789012:role/ExampleAssumedRole",
                "accountId": "123456789012",
                "userName": "ExampleAssumedRole"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-09-05T17:45:15Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-09-06T03:59:32Z",
    "eventSource": "launchwizard.amazonaws.com",
    "eventName": "ListWorkloads",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "192.0.2.0",
    "userAgent": "aws-cli/2.2.17 Python/3.8.8 Darwin/21.6.0 exe/x86_64 prompt/off command/example",
    "requestParameters": null,
    "responseElements": null,
    "requestID": "86168559-75e9-11e4-8cf8-75d18EXAMPLE",
    "eventID": "832b82d5-d474-44e8-a51d-093ccEXAMPLE",
    "readOnly": true,
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "123456789012",
    "eventCategory": "Management"
}
Show moreShow less