{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cloudtrail#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceAccessDenied", "httpResponseCode": 403 }, "smithy.api#documentation": "\n You do not have sufficient access to perform this action.\n
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#AccountHasOngoingImportException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "AccountHasOngoingImport", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when you start a new import and a previous import is still in\n progress.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 16 }, "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.cloudtrail#AccountNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "AccountNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is thrown when the specified account is not found or not part of an\n organization.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#AccountNotRegisteredException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "AccountNotRegistered", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#AccountRegisteredException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "AccountRegistered", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the account is already registered as the CloudTrail\n delegated administrator.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#AddTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#AddTagsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#AddTagsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50. Overwrites an\n existing tag's value when a new value is specified for an existing tag key. Tag key names\n must be unique; you cannot have two keys with the same name but different\n values. If you specify a key without a value, the tag will be created with the specified\n key and a value of null. You can tag a trail or event data store that applies to all\n Amazon Web Services Regions only from the Region in which the trail or event data store\n was created (also known as its home Region).
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#AddTagsRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail, event data store, dashboard, or channel to which one or more tags will be\n added.
\nThe format of a trail ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
The format of an event data store ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
The format of a dashboard ARN is: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
The format of a channel ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
Contains a list of tags, up to a limit of 50
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the tags to add to a trail, event data store, dashboard, or channel.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#AddTagsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the objects or data if successful. Otherwise, returns an error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#AdvancedEventSelector": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#SelectorName", "traits": { "smithy.api#documentation": "An optional, descriptive name for an advanced event selector, such as \"Log data events\n for only two S3 buckets\".
" } }, "FieldSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedFieldSelectors", "traits": { "smithy.api#documentation": "Contains all selector statements in an advanced event selector.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those\n events that are important to you. For more information about configuring advanced event selectors, see\n the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.
\nYou cannot apply both event selectors and advanced event selectors to a trail.
\nFor information about configurable advanced event selector fields, see \n AdvancedEventSelector \n in the CloudTrail API Reference.
" } }, "com.amazonaws.cloudtrail#AdvancedEventSelectors": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelector" } }, "com.amazonaws.cloudtrail#AdvancedFieldSelector": { "type": "structure", "members": { "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { "smithy.api#documentation": "A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.
\nFor more information, see \n AdvancedFieldSelector \n in the CloudTrail API Reference.
\nSelectors don't support the use of wildcards like * . To match multiple values with a single condition, \n you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the event field.
An operator that includes events that match the exact value of the event record field\n specified as the value of Field. This is the only valid operator that you can\n use with the readOnly, eventCategory, and\n resources.type fields.
An operator that includes events that match the first few characters of the event record\n field specified as the value of Field.
An operator that includes events that match the last few characters of the event record\n field specified as the value of Field.
An operator that excludes events that match the exact value of the event record field\n specified as the value of Field.
An operator that excludes events that match the first few characters of the event\n record field specified as the value of Field.
An operator that excludes events that match the last few characters of the event record\n field specified as the value of Field.
A single selector statement in an advanced event selector.
" } }, "com.amazonaws.cloudtrail#AdvancedFieldSelectors": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#AdvancedFieldSelector" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudtrail#AggregationConfiguration": { "type": "structure", "members": { "Templates": { "target": "com.amazonaws.cloudtrail#Templates", "traits": { "smithy.api#documentation": "A list of aggregation templates that can be used to configure event aggregation.
", "smithy.api#required": {} } }, "EventCategory": { "target": "com.amazonaws.cloudtrail#EventCategoryAggregation", "traits": { "smithy.api#documentation": "Specifies the event category for which aggregation should be performed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains configuration settings for aggregating events.
" } }, "com.amazonaws.cloudtrail#AggregationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#AggregationConfiguration" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.cloudtrail#BillingMode": { "type": "enum", "members": { "EXTENDABLE_RETENTION_PRICING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXTENDABLE_RETENTION_PRICING" } }, "FIXED_RETENTION_PRICING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIXED_RETENTION_PRICING" } } } }, "com.amazonaws.cloudtrail#Boolean": { "type": "boolean" }, "com.amazonaws.cloudtrail#ByteBuffer": { "type": "blob" }, "com.amazonaws.cloudtrail#CancelQuery": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#CancelQueryRequest" }, "output": { "target": "com.amazonaws.cloudtrail#CancelQueryResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InactiveQueryException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.
The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query is running.
" } }, "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the query that you want to cancel. The QueryId comes from the\n response of a StartQuery operation.
\nThe account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#CancelQueryResponse": { "type": "structure", "members": { "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the canceled query.
", "smithy.api#required": {} } }, "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { "smithy.api#documentation": "Shows the status of a query after a CancelQuery request. Typically, the\n values shown are either RUNNING or CANCELLED.
\n The account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CannotDelegateManagementAccount", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the management account of an organization is registered as\n the CloudTrail delegated administrator.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#Channel": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a channel.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#ChannelName", "traits": { "smithy.api#documentation": " The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix created by the\n Amazon Web Services service.
Contains information about a returned CloudTrail channel.
" } }, "com.amazonaws.cloudtrail#ChannelARNInvalidException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChannelARNInvalid", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified value of ChannelARN is not\n valid.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChannelAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when the provided channel already exists.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ChannelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, "com.amazonaws.cloudtrail#ChannelExistsForEDSException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChannelExistsForEDS", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified event data store cannot yet be deleted because it \n is in use by a channel.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChannelMaxLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when the maximum number of channels limit is exceeded.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ChannelName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" } }, "com.amazonaws.cloudtrail#ChannelNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChannelNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is thrown when CloudTrail cannot find the specified channel.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#Channels": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Channel" } }, "com.amazonaws.cloudtrail#CloudTrailARNInvalidException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CloudTrailARNInvalid", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when an operation is called with an ARN that is not valid.
\nThe following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
The following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CloudTrailAccessNotEnabled", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CloudTrailInvalidClientTokenId", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when a call results in the InvalidClientTokenId\n error code. This can occur when you are creating or updating a trail to send notifications\n to an Amazon SNS topic that is in a suspended Amazon Web Services account.
This is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response\n elements returned by the service.
\nAs an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
\nSee the CloudTrail\n User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
", "smithy.api#title": "AWS CloudTrail", "smithy.api#xmlNamespace": { "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-east-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-west-1" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 15, "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABQX14QoF9eELAAAABAAAAAwAAAAJAAAABgAAAAoF9eEJAAAABwX14QYAAAALAAAACAX14QcF9eEIAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-east-1" ] } ], "endpoint": { "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-west-1" ] } ], "endpoint": { "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudtrail-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CloudWatchLogsDeliveryUnavailable", "httpResponseCode": 400 }, "smithy.api#documentation": "Cannot set a CloudWatch Logs delivery for this Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ConcurrentModification", "httpResponseCode": 400 }, "smithy.api#documentation": "\n You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request. \n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ConflictException", "httpResponseCode": 409 }, "smithy.api#documentation": "This exception is thrown when the specified resource is not ready for an operation. This\n can occur when you try to run an operation on a resource before CloudTrail has time\n to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the\n operation again.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudtrail#ContextKeySelector": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudtrail#Type", "traits": { "smithy.api#documentation": "Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.
", "smithy.api#required": {} } }, "Equals": { "target": "com.amazonaws.cloudtrail#OperatorTargetList", "traits": { "smithy.api#documentation": "A list of keys defined by Type to be included in CloudTrail enriched events.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains information types to be included in CloudTrail enriched events.
" } }, "com.amazonaws.cloudtrail#ContextKeySelectors": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#ContextKeySelector" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.cloudtrail#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#CreateChannelRequest" }, "output": { "target": "com.amazonaws.cloudtrail#CreateChannelResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" }, { "target": "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidSourceException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCreates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.
" } }, "com.amazonaws.cloudtrail#CreateChannelRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#ChannelName", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.cloudtrail#Source", "traits": { "smithy.api#documentation": "The name of the partner or external event source. You cannot change this name after you create the \n channel. A maximum of one channel is allowed per source.
\n\n A source can be either Custom for all valid non-Amazon Web Services\n events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.\n
One or more event data stores to which events arriving through a channel will be logged.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudtrail#TagsList" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#CreateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new channel.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#ChannelName", "traits": { "smithy.api#documentation": "The name of the new channel.
" } }, "Source": { "target": "com.amazonaws.cloudtrail#Source", "traits": { "smithy.api#documentation": "The partner or external event source name.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#Destinations", "traits": { "smithy.api#documentation": "The event data stores that log the events arriving through the channel.
" } }, "Tags": { "target": "com.amazonaws.cloudtrail#TagsList" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#CreateDashboard": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#CreateDashboardRequest" }, "output": { "target": "com.amazonaws.cloudtrail#CreateDashboardResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nCreates a custom dashboard or the Highlights dashboard.\n
\n\n Custom dashboards - Custom dashboards allow you to query \n events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
\n\n Highlights dashboard - You can create\n the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. \n CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
\n\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#CreateDashboardRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#DashboardName", "traits": { "smithy.api#documentation": "\n The name of the dashboard. The name must be unique to your account.\n
\nTo create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.
\n The refresh schedule configuration for the dashboard.\n
\nTo create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS \n and the Value must be 6.
\n Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.\n
" } }, "Widgets": { "target": "com.amazonaws.cloudtrail#RequestWidgetList", "traits": { "smithy.api#documentation": "\nAn array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.\n
\nYou do not need to specify widgets for the Highlights dashboard.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#CreateDashboardResponse": { "type": "structure", "members": { "DashboardArn": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\nThe ARN for the dashboard.\n
" } }, "Name": { "target": "com.amazonaws.cloudtrail#DashboardName", "traits": { "smithy.api#documentation": "\nThe name of the dashboard.\n
" } }, "Type": { "target": "com.amazonaws.cloudtrail#DashboardType", "traits": { "smithy.api#documentation": "\nThe dashboard type.\n
" } }, "Widgets": { "target": "com.amazonaws.cloudtrail#WidgetList", "traits": { "smithy.api#documentation": "\nAn array of widgets for the dashboard.\n
" } }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList" }, "RefreshSchedule": { "target": "com.amazonaws.cloudtrail#RefreshSchedule", "traits": { "smithy.api#documentation": "\nThe refresh schedule for the dashboard, if configured.\n
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "\n Indicates whether termination protection is enabled for the dashboard.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#CreateEventDataStore": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest" }, "output": { "target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#KmsException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCreates a new event data store.
" } }, "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
", "smithy.api#required": {} } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.
\nFor more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.
\nFor more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.
\nFor more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the event data store includes events from all Regions, or only from\n the Region in which the event data store is created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether an event data store collects events logged for an organization in\n Organizations.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#documentation": "The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.
CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you plan to copy trail events to this event data store, we recommend \n that you consider both the age of the events that you\n want to copy as well as how long you want to keep the copied events\n in your event data store. For example, if you copy trail events that are 5 years old \n and specify a retention period of 7 years, the event data store \n will retain those events for two years.
\nSpecifies whether termination protection is enabled for the event data store. If\n termination protection is enabled, you cannot delete the event data store until termination\n protection is disabled.
" } }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList" }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", "traits": { "smithy.api#documentation": "Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.
Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.
\nCloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.
\nExamples:
\n\n alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
\n 12345678-1234-1234-1234-123456789012\n
Specifies whether the event data store should start ingesting live events. The default is true.
" } }, "BillingMode": { "target": "com.amazonaws.cloudtrail#BillingMode", "traits": { "smithy.api#documentation": "The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.
\nThe following are the possible values:
\n\n EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). \n The default retention period for this billing mode is 366 days.
\n FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). \n The default retention period for this billing mode is 2557 days.
The default value is EXTENDABLE_RETENTION_PRICING.
For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN of the event data store.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { "smithy.api#documentation": "The status of event data store creation.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors that were used to select the events for the data\n store.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the event data store collects events from all Regions, or only from\n the Region in which it was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in\n Organizations.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#documentation": "The retention period of an event data store, in days.
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "Indicates whether termination protection is enabled for the event data store.
" } }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList" }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp that shows when the event data store was created.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#CreateTrail": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#CreateTrailRequest" }, "output": { "target": "com.amazonaws.cloudtrail#CreateTrailResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" }, { "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" }, { "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" }, { "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#KmsException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, { "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" }, { "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#CreateTrailRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the trail. The name must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nSpecifies the name of the Amazon S3 bucket designated for publishing log files. \n For information about bucket naming rules, see Bucket naming rules \n in the Amazon Simple Storage Service User Guide.\n
", "smithy.api#required": {} } }, "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.
" } }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name or ARN of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.
" } }, "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the\n log files. Setting this value to true only delivers global service events to\n the trail if the trail is multi-Region or if the trail's home Region is the partition leader\n Region (for example, us-east-1).
Specifies whether the trail is created in the current Region or in all Regions. The\n default is false, which creates a trail only in the Region where you are signed in. As a\n best practice, consider creating trails that log events in all Regions.
" } }, "EnableLogFileValidation": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether log file integrity validation is enabled. The default is false.
\nWhen you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.
\nSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.
\nNot required unless you specify CloudWatchLogsRoleArn.
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the KMS key ID to use to encrypt the logs and digest files delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully\n specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.
CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.
\nExamples:
\n\n alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
\n 12345678-1234-1234-1234-123456789012\n
Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations.
" } }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList" }, "RecursiveLogging": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
Specifies the settings for each trail.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#CreateTrailResponse": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the trail.
" } }, "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the Amazon S3 bucket designated for publishing log\n files.
" } }, "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.
" } }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The format of a topic ARN is:
\n\n arn:aws:sns:us-east-2:123456789012:MyTopic\n
Specifies whether the trail is publishing events from global services such as IAM to the\n log files. Setting this value to true only delivers global service events to\n the trail if the trail is multi-Region or if the trail's home Region is the partition leader\n Region (for example, us-east-1).
Specifies whether the trail exists in one Region or in all Regions.
" } }, "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail that was created. The format of a trail ARN is:
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies whether log file integrity validation is enabled.
" } }, "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs will be delivered.
" } }, "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
Specifies whether the trail is an organization trail.
" } }, "RecursiveLogging": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail.
" } } }, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DashboardArn": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, "com.amazonaws.cloudtrail#DashboardDetail": { "type": "structure", "members": { "DashboardArn": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\nThe ARN for the dashboard.\n
" } }, "Type": { "target": "com.amazonaws.cloudtrail#DashboardType", "traits": { "smithy.api#documentation": "\nThe type of dashboard.\n
" } } }, "traits": { "smithy.api#documentation": "\nProvides information about a CloudTrail Lake dashboard.\n
" } }, "com.amazonaws.cloudtrail#DashboardName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" } }, "com.amazonaws.cloudtrail#DashboardStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.cloudtrail#DashboardType": { "type": "enum", "members": { "MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } } } }, "com.amazonaws.cloudtrail#Dashboards": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#DashboardDetail" } }, "com.amazonaws.cloudtrail#DataResource": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
Additional resource types are available through advanced\n event selectors. For more\n information, see AdvancedEventSelector.
" } }, "Values": { "target": "com.amazonaws.cloudtrail#DataResourceValues", "traits": { "smithy.api#documentation": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n resource type.
\nTo log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.
This also enables logging of data event activity performed by any user or role\n in your Amazon Web Services account, even if that activity is performed on a bucket\n that belongs to another Amazon Web Services account.
\nTo log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/. The trail logs data\n events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix\n such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images. The trail logs data events\n for objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.
This also enables logging of Invoke activity performed by any user\n or role in your Amazon Web Services account, even if that activity is performed on\n a function that belongs to another Amazon Web Services account.
To log data events for a specific Lambda function, specify the\n function ARN.
\nLambda function ARNs are exact. For example, if you specify a\n function ARN\n arn:aws:lambda:us-west-2:111111111111:function:helloworld,\n data events will only be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld.\n They will not be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
\nTo log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.
You can configure the DataResource in an EventSelector to log data events for the following three resource types:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
To log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.
Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.
The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.
\nThe following example demonstrates how logging works when you configure logging of all\n data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.
A user uploads an image file to amzn-s3-demo-bucket1.
The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.
A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::amzn-s3-demo-bucket1.
The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn\u2019t log\n the event.
The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.
\nA user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.
\nThe Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.
The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn\u2019t log the event.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "DelegatedAdminAccountLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the maximum number of CloudTrail delegated\n administrators is reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DeleteChannelRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DeleteChannelResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nDeletes a channel.
" } }, "com.amazonaws.cloudtrail#DeleteChannelRequest": { "type": "structure", "members": { "Channel": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The ARN or the UUID value of the channel that you want to delete.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nDeletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#DeleteDashboardRequest": { "type": "structure", "members": { "DashboardId": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\nThe name or ARN for the dashboard.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DeleteDashboardResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DeleteEventDataStore": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelExistsForEDSException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nDisables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store and the FederationStatus must be DISABLED. \n You cannot delete an event data store if TerminationProtectionEnabled \n is True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.
The ARN (or the ID suffix of the ARN) of the event data store to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "\n Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudtrail#ResourceArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel you're deleting the resource-based policy from.
\nExample event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
Deletes a trail. This operation must be called from the Region in which the trail was\n created. DeleteTrail cannot be called on the shadow trails (replicated trails\n in other Regions) of a trail that is enabled in all Regions.
\n While deleting a CloudTrail trail is an irreversible action, CloudTrail does not\n delete log files in the Amazon S3 bucket for that trail, the Amazon S3 bucket itself, or the\n CloudWatchlog group to which the trail delivers events. Deleting a multi-Region trail\n will stop logging of events in all Amazon Web Services Regions enabled in your Amazon Web Services account. Deleting a\n single-Region trail will stop logging of events in that Region only. It will not stop\n logging of events in other Regions even if the trails in those other Regions have\n identical names to the deleted trail.\n
\nFor information about account closure and deletion of CloudTrail trails, see https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-account-closure.html.
\nSpecifies the name or the CloudTrail ARN of the trail to be deleted. The\n following is the format of a trail ARN.\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
The request that specifies the name of a trail to delete.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DeleteTrailResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DeliveryS3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.cloudtrail#DeliveryStatus": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "FAILED_SIGNING_FILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_SIGNING_FILE" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_NOT_FOUND" } }, "ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_DENIED" } }, "ACCESS_DENIED_SIGNING_FILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_DENIED_SIGNING_FILE" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } } } }, "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#AccountNotFoundException" }, { "target": "com.amazonaws.cloudtrail#AccountNotRegisteredException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Removes CloudTrail delegated administrator permissions from a member account in\n an organization.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest": { "type": "structure", "members": { "DelegatedAdminAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "A delegated administrator account ID. This is a member account in an organization that\n is currently designated as a delegated administrator.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Removes CloudTrail delegated administrator permissions from a specified member\n account in an organization that is currently designated as a delegated\n administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the following response if successful. Otherwise, returns an error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DescribeQuery": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.
\nYou must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter \n returns information about the last query run for the alias. You can provide \n RefreshId along with QueryAlias to view the query results \n of a dashboard query for the specified RefreshId.
The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query was run.
" } }, "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The query ID.
" } }, "QueryAlias": { "target": "com.amazonaws.cloudtrail#QueryAlias", "traits": { "smithy.api#documentation": "\n The alias that identifies a query template.\n
" } }, "RefreshId": { "target": "com.amazonaws.cloudtrail#RefreshId", "traits": { "smithy.api#documentation": "\nThe ID of the dashboard refresh.\n
" } }, "EventDataStoreOwnerAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "\nThe account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DescribeQueryResponse": { "type": "structure", "members": { "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the query.
" } }, "QueryString": { "target": "com.amazonaws.cloudtrail#QueryStatement", "traits": { "smithy.api#documentation": "The SQL code of a query.
" } }, "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { "smithy.api#documentation": "The status of a query. Values for QueryStatus include QUEUED,\n RUNNING, FINISHED, FAILED,\n TIMED_OUT, or CANCELLED\n
Metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.
" } }, "ErrorMessage": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "The error message returned if a query failed.
" } }, "DeliveryS3Uri": { "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", "traits": { "smithy.api#documentation": "The URI for the S3 bucket where CloudTrail delivered query results, if\n applicable.
" } }, "DeliveryStatus": { "target": "com.amazonaws.cloudtrail#DeliveryStatus", "traits": { "smithy.api#documentation": "The delivery status.
" } }, "Prompt": { "target": "com.amazonaws.cloudtrail#Prompt", "traits": { "smithy.api#documentation": "\n The prompt used for a generated query. For information about generated queries, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.\n
" } }, "EventDataStoreOwnerAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "\n The account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#DescribeTrails": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Retrieves settings for one or more trails associated with the current Region for your\n account.
", "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DescribeTrailsSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.cloudtrail#DescribeTrailsRequest": { "type": "structure", "members": { "trailNameList": { "target": "com.amazonaws.cloudtrail#TrailNameList", "traits": { "smithy.api#documentation": "Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The\n format of a trail ARN is:
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
If an empty list is specified, information for the trail in the current Region is\n returned.
\nIf an empty list is specified and IncludeShadowTrails is false, then\n information for all trails in the current Region is returned.
If an empty list is specified and IncludeShadowTrails is null or true, then\n information for all trails in the current Region and any associated shadow trails in\n other Regions is returned.
\nIf one or more trail names are specified, information is returned only if the names\n match the names of trails belonging only to the current Region and current account. To\n return information about a trail in another Region, you must specify its trail\n ARN.
\nSpecifies whether to include shadow trails in the response. A shadow trail is the\n replication in a Region of a trail that was created in a different Region, or in the case\n of an organization trail, the replication of an organization trail in member accounts. If\n you do not include shadow trails, organization trails in a member account and Region\n replication trails will not be returned. The default is true.
" } } }, "traits": { "smithy.api#documentation": "Returns information about the trail.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DescribeTrailsResponse": { "type": "structure", "members": { "trailList": { "target": "com.amazonaws.cloudtrail#TrailList", "traits": { "smithy.api#documentation": "The list of trail objects. Trail objects with string values are only returned if values\n for the objects exist in a trail's configuration. For example, SNSTopicName\n and SNSTopicARN are only returned in results if a trail is configured to send\n SNS notifications. Similarly, KMSKeyId only appears in results if a trail's\n log files are encrypted with KMS\n customer managed keys.
Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#Destination": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudtrail#DestinationType", "traits": { "smithy.api#documentation": "The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, \n the value is AWS_SERVICE.
For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. \n For service-linked channels, the location is the name of the Amazon Web Services service.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the destination receiving events.
" } }, "com.amazonaws.cloudtrail#DestinationType": { "type": "enum", "members": { "EVENT_DATA_STORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVENT_DATA_STORE" } }, "AWS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_SERVICE" } } } }, "com.amazonaws.cloudtrail#Destinations": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Destination" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.cloudtrail#DisableFederation": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#DisableFederationRequest" }, "output": { "target": "com.amazonaws.cloudtrail#DisableFederationResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#AccessDeniedException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConcurrentModificationException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables \n the integration with Glue, Lake Formation, and Amazon Athena. \n After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
\nNo CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
" } }, "com.amazonaws.cloudtrail#DisableFederationRequest": { "type": "structure", "members": { "EventDataStore": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "\n The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#DisableFederationResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "\n The ARN of the event data store for which you disabled Lake query federation.\n
" } }, "FederationStatus": { "target": "com.amazonaws.cloudtrail#FederationStatus", "traits": { "smithy.api#documentation": "\n The federation status.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#Double": { "type": "double" }, "com.amazonaws.cloudtrail#EnableFederation": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#EnableFederationRequest" }, "output": { "target": "com.amazonaws.cloudtrail#EnableFederationResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#AccessDeniedException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConcurrentModificationException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.
\nWhen you enable Lake query federation, CloudTrail\n creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for allowing fine-grained access control \n of the federated resources in the Glue Data Catalog.
For more information about Lake query federation, see Federate an event data store.
" } }, "com.amazonaws.cloudtrail#EnableFederationRequest": { "type": "structure", "members": { "EventDataStore": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.
", "smithy.api#required": {} } }, "FederationRoleArn": { "target": "com.amazonaws.cloudtrail#FederationRoleArn", "traits": { "smithy.api#documentation": "\n The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event \n data store. The federation role must exist in your account and provide the required minimum permissions.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#EnableFederationResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "\n The ARN of the event data store for which you enabled Lake query federation.\n
" } }, "FederationStatus": { "target": "com.amazonaws.cloudtrail#FederationStatus", "traits": { "smithy.api#documentation": "\n The federation status.\n
" } }, "FederationRoleArn": { "target": "com.amazonaws.cloudtrail#FederationRoleArn", "traits": { "smithy.api#documentation": "\n The ARN of the federation role.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ErrorCode": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^[\\w\\d\\s_.,\\-:\\[\\]]+$" } }, "com.amazonaws.cloudtrail#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 1000 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudtrail#Event": { "type": "structure", "members": { "EventId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The CloudTrail ID of the event returned.
" } }, "EventName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of the event returned.
" } }, "ReadOnly": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Information about whether the event is a write event or a read event.
" } }, "AccessKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Web Services access key ID that was used to sign the request. If the request\n was made with temporary security credentials, this is the access key ID of the temporary\n credentials.
" } }, "EventTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The date and time of the event returned.
" } }, "EventSource": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Web Services service to which the request was made.
" } }, "Username": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "A user name or role name of the requester that called the API in the event\n returned.
" } }, "Resources": { "target": "com.amazonaws.cloudtrail#ResourceList", "traits": { "smithy.api#documentation": "A list of resources referenced by the event returned.
" } }, "CloudTrailEvent": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "A JSON string that contains a representation of the event returned.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an event that was returned by a lookup request. The result\n includes a representation of a CloudTrail event.
" } }, "com.amazonaws.cloudtrail#EventCategory": { "type": "enum", "members": { "Insight": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "insight" } } }, "traits": { "smithy.api#documentation": "Specifies the event category for which aggregation configuration is enabled. Valid value is Data.
" } }, "com.amazonaws.cloudtrail#EventCategoryAggregation": { "type": "enum", "members": { "Data": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Data" } } } }, "com.amazonaws.cloudtrail#EventDataStore": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN of the event data store.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#deprecated": { "message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "Indicates whether the event data store is protected from\n termination.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { "smithy.api#deprecated": { "message": "Status is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "The status of an event data store.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#deprecated": { "message": "AdvancedEventSelectors is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "The advanced event selectors that were used to select\n events for the data store.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#deprecated": { "message": "MultiRegionEnabled is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "Indicates whether the event data store includes events\n from all Regions, or only from the Region in which it was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#deprecated": { "message": "OrganizationEnabled is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "Indicates that an event data store is collecting logged\n events for an organization.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#deprecated": { "message": "RetentionPeriod is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "The retention period, in days.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#deprecated": { "message": "CreatedTimestamp is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "The timestamp of the event data store's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#deprecated": { "message": "UpdatedTimestamp is no longer returned by ListEventDataStores" }, "smithy.api#documentation": "The timestamp showing when an event data store was\n updated, if applicable. UpdatedTimestamp is always either the same or newer\n than the time shown in CreatedTimestamp.
A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account. To select events for an event data\n store, use advanced event selectors.
" } }, "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreARNInvalid", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified event data store ARN is not valid or does not map to an event data store\n in your account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "An event data store with that name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#EventDataStoreArn": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreFederationEnabled", "httpResponseCode": 400 }, "smithy.api#documentation": "\n You cannot delete the event data store because Lake query federation is enabled. To delete the event data store, run the DisableFederation operation to \n disable Lake query federation on the event data store. \n
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreHasOngoingImport", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when you try to update or delete an event data store that\n currently has an import in progress.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 350 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, "com.amazonaws.cloudtrail#EventDataStoreList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreMaxLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "Your account has used the maximum number of event data stores.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#EventDataStoreName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" } }, "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified event data store was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#EventDataStoreStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "PENDING_DELETION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETION" } }, "STARTING_INGESTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTING_INGESTION" } }, "STOPPING_INGESTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING_INGESTION" } }, "STOPPED_INGESTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED_INGESTION" } } } }, "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "EventDataStoreTerminationProtectedException", "httpResponseCode": 400 }, "smithy.api#documentation": "The event data store cannot be deleted because termination protection is enabled for\n it.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#EventDataStores": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#EventDataStore" } }, "com.amazonaws.cloudtrail#EventName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9_]+$" } }, "com.amazonaws.cloudtrail#EventSelector": { "type": "structure", "members": { "ReadWriteType": { "target": "com.amazonaws.cloudtrail#ReadWriteType", "traits": { "smithy.api#documentation": "Specify if you want your trail to log read-only events, write-only events, or all. For\n example, the EC2 GetConsoleOutput is a read-only API operation and\n RunInstances is a write-only API operation.
By default, the value is All.
Specify if you want your event selector to include management events for your\n trail.
\nFor more information, see Management Events in the CloudTrail User\n Guide.
\nBy default, the value is true.
The first copy of management events is free. You are charged for additional copies of\n management events that you are logging on any subsequent trail in the same Region. For more\n information about CloudTrail pricing, see CloudTrail Pricing.
" } }, "DataResources": { "target": "com.amazonaws.cloudtrail#DataResources", "traits": { "smithy.api#documentation": "CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.
\nFor more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.
\nTo log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.
An optional list of service event sources from which you do not want management events\n to be logged on your trail. In this release, the list can be empty (disables the filter),\n or it can filter out Key Management Service or Amazon RDS Data API events by\n containing kms.amazonaws.com or rdsdata.amazonaws.com. By\n default, ExcludeManagementEventSources is empty, and KMS and\n Amazon RDS Data API events are logged to your trail. You can exclude management\n event sources only in Regions that support the event source.
Use event selectors to further specify the management and data event settings for your\n trail. By default, trails created without specific event selectors will be configured to\n log all read and write management events, and no data events. When an event occurs in your\n account, CloudTrail evaluates the event selector for all trails. For each trail, if\n the event matches any event selector, the trail processes and logs the event. If the event\n doesn't match any event selector, the trail doesn't log the event.
\nYou can configure up to five event selectors for a trail.
\nYou cannot apply both event selectors and advanced event selectors to a trail.
" } }, "com.amazonaws.cloudtrail#EventSelectors": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#EventSelector" } }, "com.amazonaws.cloudtrail#EventSource": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-z0-9_-]+\\.amazonaws\\.com$" } }, "com.amazonaws.cloudtrail#EventsList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Event" } }, "com.amazonaws.cloudtrail#ExcludeManagementEventSources": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#String" } }, "com.amazonaws.cloudtrail#FederationRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 125 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:@=\\+,\\.]+$" } }, "com.amazonaws.cloudtrail#FederationStatus": { "type": "enum", "members": { "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLING" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.cloudtrail#GenerateQuery": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GenerateQueryRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GenerateQueryResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#GenerateResponseException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Generates a query from a natural language prompt. This operation uses generative artificial intelligence\n (generative AI) to produce a ready-to-use SQL query from the prompt.\n
\nThe prompt can be a question or a statement about the event data\n in your event data store. For example, you can enter prompts like \"What are my\n top errors in the past month?\" and \u201cGive me a list of users that used SNS.\u201d
\nThe prompt must be in English. For information about limitations, permissions, and supported Regions, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.
\nDo not include any personally identifying, confidential, or sensitive information\n in your prompts.
\nThis feature uses generative AI large language models (LLMs); we recommend double-checking the\n LLM response.
\n\n The ARN (or ID suffix of the ARN) of the event data store\n that you want to query. You can only specify one event data store.\n
", "smithy.api#required": {} } }, "Prompt": { "target": "com.amazonaws.cloudtrail#Prompt", "traits": { "smithy.api#documentation": "\n The prompt that you want to use to generate the query. The prompt must be in English. For example prompts, see \n Example prompts \n in the CloudTrail user guide.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GenerateQueryResponse": { "type": "structure", "members": { "QueryStatement": { "target": "com.amazonaws.cloudtrail#QueryStatement", "traits": { "smithy.api#documentation": "\n The SQL query statement generated from the prompt.\n
" } }, "QueryAlias": { "target": "com.amazonaws.cloudtrail#QueryAlias", "traits": { "smithy.api#documentation": "\n An alias that identifies the prompt. When you run the StartQuery operation, you can pass in either the QueryAlias or \n QueryStatement parameter.\n
\n The account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GenerateResponseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "GenerateResponse", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when a valid query could not be generated for the provided prompt. \n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#GetChannel": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetChannelRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetChannelResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about a specific channel.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetChannelRequest": { "type": "structure", "members": { "Channel": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The ARN or UUID of a channel.
The ARN of an channel returned by a GetChannel request.
The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix generated by the\n Amazon Web Services service.
The source for the CloudTrail channel.
" } }, "SourceConfig": { "target": "com.amazonaws.cloudtrail#SourceConfig", "traits": { "smithy.api#documentation": "Provides information about the advanced event selectors configured for the channel, and\n whether the channel applies to all Regions or a single Region.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#Destinations", "traits": { "smithy.api#documentation": "The destinations for the channel. For channels created for integrations, \n the destinations are the event data stores that log events arriving through the channel. \n For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.
" } }, "IngestionStatus": { "target": "com.amazonaws.cloudtrail#IngestionStatus", "traits": { "smithy.api#documentation": "A table showing information about the most recent successful and failed attempts \n to ingest events.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetDashboard": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetDashboardRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetDashboardResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nReturns the specified dashboard.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetDashboardRequest": { "type": "structure", "members": { "DashboardId": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\nThe name or ARN for the dashboard.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetDashboardResponse": { "type": "structure", "members": { "DashboardArn": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\n The ARN for the dashboard.\n
" } }, "Type": { "target": "com.amazonaws.cloudtrail#DashboardType", "traits": { "smithy.api#documentation": "\nThe type of dashboard.\n
" } }, "Status": { "target": "com.amazonaws.cloudtrail#DashboardStatus", "traits": { "smithy.api#documentation": "\nThe status of the dashboard.\n
" } }, "Widgets": { "target": "com.amazonaws.cloudtrail#WidgetList", "traits": { "smithy.api#documentation": "\nAn array of widgets for the dashboard.\n
" } }, "RefreshSchedule": { "target": "com.amazonaws.cloudtrail#RefreshSchedule", "traits": { "smithy.api#documentation": "\nThe refresh schedule for the dashboard, if configured.\n
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "\n The timestamp that shows when the dashboard was created.\n
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "\n The timestamp that shows when the dashboard was last updated.\n
" } }, "LastRefreshId": { "target": "com.amazonaws.cloudtrail#RefreshId", "traits": { "smithy.api#documentation": "\nThe ID of the last dashboard refresh.\n
" } }, "LastRefreshFailureReason": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "\nProvides information about failures for the last scheduled refresh.\n
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "\nIndicates whether termination protection is enabled for the dashboard.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetEventConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetEventConfigurationRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetEventConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetEventConfigurationRequest": { "type": "structure", "members": { "TrailName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of the trail for which you want to retrieve event configuration settings.
" } }, "EventDataStore": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which you want to retrieve event configuration settings.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetEventConfigurationResponse": { "type": "structure", "members": { "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trail for which the event configuration settings are returned.
" } }, "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings are returned.
" } }, "MaxEventSize": { "target": "com.amazonaws.cloudtrail#MaxEventSize", "traits": { "smithy.api#documentation": "The maximum allowed size for events stored in the specified event data store.
" } }, "ContextKeySelectors": { "target": "com.amazonaws.cloudtrail#ContextKeySelectors", "traits": { "smithy.api#documentation": "The list of context key selectors that are configured for the event data store.
" } }, "AggregationConfigurations": { "target": "com.amazonaws.cloudtrail#AggregationConfigurations", "traits": { "smithy.api#documentation": "The list of aggregation configurations that are configured for the trail.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetEventDataStore": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about an event data store specified as either an ARN or the ID\n portion of the ARN.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { "type": "structure", "members": { "EventDataStore": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN (or ID suffix of the ARN) of the event data store about which you want\n information.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The event data store Amazon Resource Number (ARN).
" } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { "smithy.api#documentation": "The status of an event data store.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors used to select events for the data store.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in\n Organizations.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#documentation": "The retention period of the event data store, in days.
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "Indicates that termination protection is enabled.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the event data store's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Shows the time that an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" } }, "FederationStatus": { "target": "com.amazonaws.cloudtrail#FederationStatus", "traits": { "smithy.api#documentation": "\n Indicates the Lake query federation status. The status is \n ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.\n
\n If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\n
" } }, "PartitionKeys": { "target": "com.amazonaws.cloudtrail#PartitionKeyList", "traits": { "smithy.api#documentation": "The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes \n event data into partitions based on values derived from partition keys.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetEventSelectors": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetEventSelectorsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetEventSelectorsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:
\nIf your event selector includes read-only events, write-only events, or all\n events. This applies to management events, data events, and network activity events.
\nIf your event selector includes management events.
\nIf your event selector includes network activity events, the event sources \n for which you are logging network activity events.
\nIf your event selector includes data events, the resources on which you are\n logging data events.
\nFor more information about logging management, data, and network activity events, see the following topics\n in the CloudTrail User Guide:
\n\n Logging data events\n
\nSpecifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nIf you specify a trail ARN, it must be in the format:
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
The specified trail ARN that has the event selectors.
" } }, "EventSelectors": { "target": "com.amazonaws.cloudtrail#EventSelectors", "traits": { "smithy.api#documentation": "The event selectors that are configured for the trail.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors that are configured for the trail.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetImport": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetImportRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetImportResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ImportNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about a specific import.
" } }, "com.amazonaws.cloudtrail#GetImportRequest": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID for the import.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetImportResponse": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the import.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#ImportDestinations", "traits": { "smithy.api#documentation": "The ARN of the destination event data store.
" } }, "ImportSource": { "target": "com.amazonaws.cloudtrail#ImportSource", "traits": { "smithy.api#documentation": "The source S3 bucket.
" } }, "StartEventTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": " Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
The status of the import.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of when the import was updated.
" } }, "ImportStatistics": { "target": "com.amazonaws.cloudtrail#ImportStatistics", "traits": { "smithy.api#documentation": " Provides statistics for the import. CloudTrail does not update import statistics\n in real-time. Returned values for parameters such as EventsCompleted may be\n lower than the actual value, because CloudTrail updates statistics incrementally\n over the course of the import.
Describes the settings for the Insights event selectors that you configured for your\n trail or event data store. GetInsightSelectors shows if CloudTrail Insights logging is enabled \n and which Insights types are configured with corresponding event categories. If you run\n GetInsightSelectors on a trail or event data store that does not have Insights events enabled,\n the operation throws the exception InsightNotEnabledException\n
Specify either the EventDataStore parameter to get Insights event selectors for an event data store, \n or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.
For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetInsightSelectorsRequest": { "type": "structure", "members": { "TrailName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nIf you specify a trail ARN, it must be in the format:
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
You cannot use this parameter with the EventDataStore parameter.
\n Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights\n selectors.\n
\nYou cannot use this parameter with the TrailName parameter.
The Amazon Resource Name (ARN) of a trail for which you want to get Insights\n selectors.
" } }, "InsightSelectors": { "target": "com.amazonaws.cloudtrail#InsightSelectors", "traits": { "smithy.api#documentation": "Contains the Insights types that are enabled on a trail or event data store. It also specifies the event categories on which a particular Insight type is enabled. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can log Insights for management events only.
\n The ARN of the source event data store that enabled Insights events.\n
" } }, "InsightsDestination": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "\n The ARN of the destination event data store that logs Insights events.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetQueryResults": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetQueryResultsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetQueryResultsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" }, { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nGets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.
The ARN (or ID suffix of the ARN) of the event data store against which the query was\n run.
" } }, "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the query for which you want to get results.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of query results.
" } }, "MaxQueryResults": { "target": "com.amazonaws.cloudtrail#MaxQueryResults", "traits": { "smithy.api#documentation": "The maximum number of query results to display on a single page.
" } }, "EventDataStoreOwnerAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "\nThe account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetQueryResultsResponse": { "type": "structure", "members": { "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { "smithy.api#documentation": "The status of the query. Values include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
Shows the count of query results.
" } }, "QueryResultRows": { "target": "com.amazonaws.cloudtrail#QueryResultRows", "traits": { "smithy.api#documentation": "Contains the individual event results of the query.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of query results.
" } }, "ErrorMessage": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "The error message returned if a query failed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "\n Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudtrail#ResourceArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
\nExample event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to resource-based policy. \n
\nExample event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
\n A JSON-formatted string that contains the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n
" } }, "DelegatedAdminResourcePolicy": { "target": "com.amazonaws.cloudtrail#ResourcePolicy", "traits": { "smithy.api#documentation": "\n The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. \n This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, \n see Default resource policy for delegated administrators.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetTrail": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetTrailRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetTrailResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Returns settings information for a specified trail.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetTrailRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve\n settings information.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetTrailResponse": { "type": "structure", "members": { "Trail": { "target": "com.amazonaws.cloudtrail#Trail" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#GetTrailStatus": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#GetTrailStatusRequest" }, "output": { "target": "com.amazonaws.cloudtrail#GetTrailStatusResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Returns a JSON-formatted list of information about the specified trail. Fields include\n information on delivery errors, Amazon SNS and Amazon S3 errors, and start\n and stop logging times for each trail. This operation returns trail status from a single\n Region. To return trail status from all Regions, you must call the operation on each\n Region.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#GetTrailStatusRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name or the CloudTrail ARN of the trail for which you are\n requesting status. To get the status of a shadow trail (a replication of the trail in\n another Region), you must specify its ARN.
\n\n The following is the format of a trail\n ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
If the trail is an organization trail and you are a member account in the organization in Organizations, you must provide the full ARN of that trail, and not just the name.
\nThe name of a trail about which you want the current status.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#GetTrailStatusResponse": { "type": "structure", "members": { "IsLogging": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Whether the CloudTrail trail is currently logging Amazon Web Services API\n calls.
" } }, "LatestDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.
\nThis error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.
Displays any Amazon SNS error that CloudTrail encountered when attempting\n to send a notification. For more information about Amazon SNS errors, see the\n Amazon SNS\n Developer Guide.
" } }, "LatestDeliveryTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies the date and time that CloudTrail last delivered log files to an\n account's Amazon S3 bucket.
" } }, "LatestNotificationTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies the date and time of the most recent Amazon SNS notification that\n CloudTrail has written a new log file to an account's Amazon S3\n bucket.
" } }, "StartLoggingTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies the most recent date and time when CloudTrail started recording API\n calls for an Amazon Web Services account.
" } }, "StopLoggingTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies the most recent date and time when CloudTrail stopped recording API\n calls for an Amazon Web Services account.
" } }, "LatestCloudWatchLogsDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Displays any CloudWatch Logs error that CloudTrail encountered when attempting\n to deliver logs to CloudWatch Logs.
" } }, "LatestCloudWatchLogsDeliveryTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
" } }, "LatestDigestDeliveryTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies the date and time that CloudTrail last delivered a digest file to an\n account's Amazon S3 bucket.
" } }, "LatestDigestDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.
\nThis error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.
This field is no longer in use.
" } }, "LatestNotificationAttemptTime": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "This field is no longer in use.
" } }, "LatestNotificationAttemptSucceeded": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "This field is no longer in use.
" } }, "LatestDeliveryAttemptSucceeded": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "This field is no longer in use.
" } }, "TimeLoggingStarted": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "This field is no longer in use.
" } }, "TimeLoggingStopped": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "This field is no longer in use.
" } } }, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ImportDestinations": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.cloudtrail#ImportFailureList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#ImportFailureListItem" } }, "com.amazonaws.cloudtrail#ImportFailureListItem": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The location of the failure in the S3 bucket.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#ImportFailureStatus", "traits": { "smithy.api#documentation": "The status of the import.
" } }, "ErrorType": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The type of import error.
" } }, "ErrorMessage": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Provides the reason the import failed.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "When the import was last updated.
" } } }, "traits": { "smithy.api#documentation": "Provides information about an import failure.
" } }, "com.amazonaws.cloudtrail#ImportFailureStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "RETRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRY" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } } } }, "com.amazonaws.cloudtrail#ImportNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ImportNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified import was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#ImportSource": { "type": "structure", "members": { "S3": { "target": "com.amazonaws.cloudtrail#S3ImportSource", "traits": { "smithy.api#documentation": "The source S3 bucket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The import source.
" } }, "com.amazonaws.cloudtrail#ImportStatistics": { "type": "structure", "members": { "PrefixesFound": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of S3 prefixes found for the import.
" } }, "PrefixesCompleted": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of S3 prefixes that completed import.
" } }, "FilesCompleted": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of log files that completed import.
" } }, "EventsCompleted": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of trail events imported into the event data store.
" } }, "FailedEntries": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of failed entries.
" } } }, "traits": { "smithy.api#documentation": " Provides statistics for the specified ImportID. CloudTrail does not\n update import statistics in real-time. Returned values for parameters such as\n EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.
The ID of the import.
" } }, "ImportStatus": { "target": "com.amazonaws.cloudtrail#ImportStatus", "traits": { "smithy.api#documentation": "The status of the import.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#ImportDestinations", "traits": { "smithy.api#documentation": "The ARN of the destination event data store.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's last update.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an import that was returned by a lookup request.
" } }, "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InactiveEventDataStore", "httpResponseCode": 400 }, "smithy.api#documentation": "The event data store is inactive.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InactiveQueryException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InactiveQuery", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified query cannot be canceled because it is in the FINISHED,\n FAILED, TIMED_OUT, or CANCELLED state.
The time stamp of the most recent successful ingestion of events for the channel.
" } }, "LatestIngestionSuccessEventID": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The event ID of the most recent successful ingestion of events.
" } }, "LatestIngestionErrorCode": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "The error code for the most recent failure to ingest events.
" } }, "LatestIngestionAttemptTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The time stamp of the most recent attempt to ingest events on the channel.
" } }, "LatestIngestionAttemptEventID": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The event ID of the most recent attempt to ingest events.
" } } }, "traits": { "smithy.api#documentation": "A table showing information about the most recent successful and failed attempts \n to ingest events.
" } }, "com.amazonaws.cloudtrail#InsightNotEnabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsightNotEnabled", "httpResponseCode": 400 }, "smithy.api#documentation": "If you run GetInsightSelectors on a trail or event data store that does not have Insights\n events enabled, the operation throws the exception\n InsightNotEnabledException.
The type of Insights events to log on a trail or event data store. ApiCallRateInsight and\n ApiErrorRateInsight are valid Insight types.
The ApiCallRateInsight Insights type analyzes write-only\n management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.
The ApiErrorRateInsight Insights type analyzes management and data \n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.
Select the event category on which Insights should be enabled.
\nIf EventCategories is not provided, the specified Insights types are enabled on management API calls by default.
\nIf EventCategories is provided, the given event categories will overwrite the existing ones. For example, \n if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.\n
\nA JSON string that contains a list of Insights types that are logged on a trail or event data store.
" } }, "com.amazonaws.cloudtrail#InsightSelectors": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#InsightSelector" } }, "com.amazonaws.cloudtrail#InsightType": { "type": "enum", "members": { "ApiCallRateInsight": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApiCallRateInsight" } }, "ApiErrorRateInsight": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApiErrorRateInsight" } } } }, "com.amazonaws.cloudtrail#InsightsMetricDataType": { "type": "enum", "members": { "FILL_WITH_ZEROS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FillWithZeros" } }, "NON_ZERO_DATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NonZeroData" } } } }, "com.amazonaws.cloudtrail#InsightsMetricMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 21600 } } }, "com.amazonaws.cloudtrail#InsightsMetricNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5000 } } }, "com.amazonaws.cloudtrail#InsightsMetricPeriod": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 3600 } } }, "com.amazonaws.cloudtrail#InsightsMetricValues": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Double" } }, "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientDependencyServiceAccessPermission", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the IAM identity that is used to create\n the organization resource lacks one or more required permissions for creating an\n organization resource in a required service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientEncryptionPolicy", "httpResponseCode": 400 }, "smithy.api#documentation": "For the CreateTrail\n PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown \n when the policy on the S3 bucket or KMS key does\n not have sufficient permissions for the operation.
For all other operations, this exception is thrown when the policy for the KMS key does\n not have sufficient permissions for the operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientIAMAccessPermission", "httpResponseCode": 400 }, "smithy.api#documentation": "The task can't be completed because you are signed in with an account that lacks permissions to view or create a service-linked role. Sign in with an account that has the required permissions and then try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientS3BucketPolicy", "httpResponseCode": 403 }, "smithy.api#documentation": "This exception is thrown when the policy on the S3 bucket is not sufficient.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientSnsTopicPolicy", "httpResponseCode": 403 }, "smithy.api#documentation": "This exception is thrown when the policy on the Amazon SNS topic is not\n sufficient.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#Integer": { "type": "integer" }, "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCloudWatchLogsLogGroupArn", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided CloudWatch Logs log group is not\n valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCloudWatchLogsRoleArn", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided role is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidDateRangeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidDateRange", "httpResponseCode": 400 }, "smithy.api#documentation": "A date range for the query was specified that is not valid. Be sure that the start time\n is chronologically before the end time. For more information about writing a query, see\n Create or edit a query in the CloudTrail User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidEventCategoryException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidEventCategory", "httpResponseCode": 400 }, "smithy.api#documentation": "Occurs if an event category that is not valid is specified as a value of\n EventCategory.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidEventDataStoreCategory", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when event categories of specified event data stores are not\n valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidEventDataStoreStatus", "httpResponseCode": 400 }, "smithy.api#documentation": "The event data store is not in a status that supports the operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidEventSelectors", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the PutEventSelectors operation is called\n with a number of event selectors, advanced event selectors, or data resources that is not\n valid. The combination of event selectors or advanced event selectors and data resources is\n not valid. A trail can have up to 5 event selectors. If a trail uses advanced event\n selectors, a maximum of 500 total values for all conditions in all advanced event selectors\n is allowed. A trail is limited to 250 data resources. These data resources can be\n distributed across event selectors, but the overall total cannot exceed 250.
You can:
\nSpecify a valid number of event selectors (1 to 5) for a trail.
\nSpecify a valid number of data resources (1 to 250) for an event selector. The\n limit of number of resources on an individual event selector is configurable up to\n 250. However, this upper limit is allowed only if the total number of data resources\n does not exceed 250 across all event selectors for a trail.
\nSpecify up to 500 values for all conditions in all advanced event selectors for a\n trail.
\nSpecify a valid value for a parameter. For example, specifying the\n ReadWriteType parameter with a value of read-only is not\n valid.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidHomeRegion", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when an operation is called on a trail from a Region other than\n the Region in which the trail was created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidImportSourceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidImportSource", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided source S3 bucket is not valid for import.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidInsightSelectorsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidInsightSelectors", "httpResponseCode": 400 }, "smithy.api#documentation": "For PutInsightSelectors, this exception is thrown when the formatting or syntax of the InsightSelectors JSON statement is not\n valid, or the specified InsightType in the InsightSelectors statement is not\n valid. Valid values for InsightType are ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data store, the destination event data store specified by the \n InsightsDestination parameter must log Insights events and the source event data \n store specified by the EventDataStore parameter must log management events.
For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data store and the updated \n advanced event selectors are not compatible with the configured InsightSelectors. \n If the InsightSelectors includes an InsightType of ApiCallRateInsight, the source event data store must log write management events. \n If the InsightSelectors includes an InsightType of ApiErrorRateInsight, the source event data store must log management events.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidKmsKeyId", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the KMS key ARN is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidLookupAttributesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidLookupAttributes", "httpResponseCode": 400 }, "smithy.api#documentation": "Occurs when a lookup attribute is specified that is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidMaxResultsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidMaxResults", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown if the limit specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidNextToken", "httpResponseCode": 400 }, "smithy.api#documentation": "A token that is not valid, or a token that was previously used in a request with\n different parameters. This exception is thrown if the token is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidParameterCombinationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidParameterCombinationError", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the combination of parameters provided is not\n valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidParameterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidParameter", "httpResponseCode": 400 }, "smithy.api#documentation": "The request includes a parameter that is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidQueryStatementException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidQueryStatement", "httpResponseCode": 400 }, "smithy.api#documentation": "The query that was submitted has validation errors, or uses incorrect syntax or\n unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User\n Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidQueryStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidQueryStatus", "httpResponseCode": 400 }, "smithy.api#documentation": "The query status is not valid for the operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidS3BucketName", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided S3 bucket name is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidS3PrefixException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidS3Prefix", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided S3 prefix is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidSnsTopicNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSnsTopicName", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided SNS topic name is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidSourceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSource", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified value of Source is not valid.
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidTagParameter", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified tag key or values are not valid. It can also\n occur if there are duplicate tags or too many tags on the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidTimeRangeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidTimeRange", "httpResponseCode": 400 }, "smithy.api#documentation": "Occurs if the timestamp values are not valid. Either the start time occurs after the end\n time, or the time range is outside the range of possible values.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidToken", "httpResponseCode": 400 }, "smithy.api#documentation": "Reserved for future use.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#InvalidTrailNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidTrailName", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the provided trail name is not valid. Trail names must\n meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nBrief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "KmsException", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when there is an issue with the specified KMS\n key and the trail or event data store can't be updated.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#KmsKeyDisabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "KmsKeyDisabled", "httpResponseCode": 400 }, "smithy.api#deprecated": {}, "smithy.api#documentation": "This exception is no longer in use.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#KmsKeyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "KmsKeyNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the KMS key does not exist, when the S3\n bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is\n not in the same Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListChannelsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListChannelsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nLists the channels in the current account, and their source names. \n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.cloudtrail#ListChannelsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount", "traits": { "smithy.api#documentation": "The maximum number of CloudTrail channels to display on a single page.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListChannelsResponse": { "type": "structure", "members": { "Channels": { "target": "com.amazonaws.cloudtrail#Channels", "traits": { "smithy.api#documentation": "The list of channels in the account.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListDashboards": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListDashboardsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListDashboardsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Returns information about all dashboards in the account, in the current Region.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#ListDashboardsMaxResultsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.cloudtrail#ListDashboardsRequest": { "type": "structure", "members": { "NamePrefix": { "target": "com.amazonaws.cloudtrail#DashboardName", "traits": { "smithy.api#documentation": "\nSpecify a name prefix to filter on.\n
" } }, "Type": { "target": "com.amazonaws.cloudtrail#DashboardType", "traits": { "smithy.api#documentation": "\nSpecify a dashboard type to filter on: CUSTOM or MANAGED.\n
\n A token you can use to get the next page of dashboard results.\n
" } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#ListDashboardsMaxResultsCount", "traits": { "smithy.api#documentation": "\n The maximum number of dashboards to display on a single page.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListDashboardsResponse": { "type": "structure", "members": { "Dashboards": { "target": "com.amazonaws.cloudtrail#Dashboards", "traits": { "smithy.api#documentation": "\n Contains information about dashboards in the account, in the current Region that match the applied filters.\n
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "\n A token you can use to get the next page of dashboard results.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListEventDataStores": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" }, { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about all event data stores in the account, in the current\n Region.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of event data store results.
" } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount", "traits": { "smithy.api#documentation": "The maximum number of event data stores to display on a single page.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { "type": "structure", "members": { "EventDataStores": { "target": "com.amazonaws.cloudtrail#EventDataStores", "traits": { "smithy.api#documentation": "Contains information about event data stores in the account, in the current\n Region.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListImportFailures": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListImportFailuresRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListImportFailuresResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns a list of failures for the specified import.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Failures", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.cloudtrail#ListImportFailuresRequest": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the import.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount", "traits": { "smithy.api#documentation": "The maximum number of failures to display on a single page.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of import failures.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListImportFailuresResponse": { "type": "structure", "members": { "Failures": { "target": "com.amazonaws.cloudtrail#ImportFailureList", "traits": { "smithy.api#documentation": "Contains information about the import failures.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListImports": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListImportsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListImportsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.
The maximum number of imports to display on a single page.
" } }, "Destination": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN of the destination event data store.
" } }, "ImportStatus": { "target": "com.amazonaws.cloudtrail#ImportStatus", "traits": { "smithy.api#documentation": "The status of the import.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of import results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListImportsResponse": { "type": "structure", "members": { "Imports": { "target": "com.amazonaws.cloudtrail#ImportsList", "traits": { "smithy.api#documentation": "The list of returned imports.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of import results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListInsightsData": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListInsightsDataRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListInsightsDataResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.
\nListInsightsData supports the following Dimensions for Insights events:
\nEvent ID
\nEvent name
\nEvent source
\nAll dimensions are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.
\nThe rate of ListInsightsData requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.
\nFor data event Insights on organization trails, only the management account and delegated\n administrator accounts can call ListInsightsData. For these callers, the API returns\n Insights events only for the caller's own account. Member accounts cannot call this API on\n organization trails.
The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.
", "smithy.api#required": {} } }, "DataType": { "target": "com.amazonaws.cloudtrail#ListInsightsDataType", "traits": { "smithy.api#documentation": "Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType\n
Contains a map of dimensions. Currently the map can contain only one item.
" } }, "StartTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
" } }, "EndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
" } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#ListInsightsDataMaxResultsCount", "traits": { "smithy.api#documentation": "The number of events to return. Possible values are 1 through 50. The default is 50.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. \n For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.\n
A list of events returned based on the InsightSource, DataType or Dimensions specified. The events list is sorted by time. The most recent event is listed first.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. \n For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.\n
Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, \n EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 90 days.
\nTo use ListInsightsMetricData operation, you must have the following permissions:
If ListInsightsMetricData is invoked with TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action and cloudtrail:ListInsightsData. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents and cloudtrail:ListInsightsData action on the specific trail.
If ListInsightsMetricData is invoked without TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action only. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents action.
For data event Insights on organization trails, only the management account and delegated\n administrator accounts can call ListInsightsMetricData. For these callers, the API returns\n Insights metrics only for the caller's own account. Member accounts cannot call this API on\n organization trails.
The Amazon Resource Name(ARN) or name of the trail for which you want to retrieve Insights metrics data. \n This parameter should only be provided to fetch Insights metrics data generated on trails logging data events. \n This parameter is not required for Insights metric data generated on trails logging management events.
" } }, "EventSource": { "target": "com.amazonaws.cloudtrail#EventSource", "traits": { "smithy.api#documentation": "The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
", "smithy.api#required": {} } }, "InsightType": { "target": "com.amazonaws.cloudtrail#InsightType", "traits": { "smithy.api#documentation": "The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.
Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.
If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.
Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.
\nThe default is 90 days before the time of request.
" } }, "EndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies, in UTC, the end time for time-series data. The value specified is exclusive; \n results include data points up to the specified time stamp.
\nThe default is the time of request.
" } }, "Period": { "target": "com.amazonaws.cloudtrail#InsightsMetricPeriod", "traits": { "smithy.api#documentation": "Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. \n If you specify any other value, you will get an error. The default is 3600 seconds.
Type of data points to return. Valid values are NonZeroData and \n FillWithZeros. The default is NonZeroData.
The maximum number of data points to return. Valid values are integers from 1 to 21600. \n The default value is 21600.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#InsightsMetricNextToken", "traits": { "smithy.api#documentation": "Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.
Add this parameter to the request to continue retrieving results starting from the last evaluated point.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListInsightsMetricDataResponse": { "type": "structure", "members": { "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail. This is only returned when Insights is enabled on a trail logging data events.
" } }, "EventSource": { "target": "com.amazonaws.cloudtrail#EventSource", "traits": { "smithy.api#documentation": "The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
" } }, "InsightType": { "target": "com.amazonaws.cloudtrail#InsightType", "traits": { "smithy.api#documentation": "The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.
Only returned if InsightType parameter was set to ApiErrorRateInsight.
If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.
List of timestamps at intervals corresponding to the specified time period.
" } }, "Values": { "target": "com.amazonaws.cloudtrail#InsightsMetricValues", "traits": { "smithy.api#documentation": "List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#InsightsMetricNextToken", "traits": { "smithy.api#documentation": "Only returned if the full results could not be returned in a single query. You can set the NextToken parameter \n in the next request to this value to continue retrieval.
Returns all public keys whose private keys were used to sign the digest files within the\n specified time range. The public key is needed to validate digest files that were signed\n with its corresponding private key.
\nCloudTrail uses different private and public key pairs per Region. Each digest\n file is signed with a private key unique to its Region. When you validate a digest file\n from a specific Region, you must look in the same Region for its corresponding public\n key.
\nOptionally specifies, in UTC, the start of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used, and the\n current public key is returned.
" } }, "EndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Optionally specifies, in UTC, the end of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Reserved for future use.
" } } }, "traits": { "smithy.api#documentation": "Requests the public keys for a specified time range.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListPublicKeysResponse": { "type": "structure", "members": { "PublicKeyList": { "target": "com.amazonaws.cloudtrail#PublicKeyList", "traits": { "smithy.api#documentation": "Contains an array of PublicKey objects.
\nThe returned public keys may have validity time ranges that overlap.
\nReserved for future use.
" } } }, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListQueries": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListQueriesRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListQueriesResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" }, { "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" }, { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
The ARN (or the ID suffix of the ARN) of an event data store on which queries were\n run.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of results.
" } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount", "traits": { "smithy.api#documentation": "The maximum number of queries to show on a page.
" } }, "StartTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Use with EndTime to bound a ListQueries request, and limit its\n results to only those queries run within a specified time period.
Use with StartTime to bound a ListQueries request, and limit\n its results to only those queries run within a specified time period.
The status of queries that you want to return in results. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
Lists matching query results, and shows query ID, status, and creation time of each\n query.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "A token you can use to get the next page of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListTagsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListTagsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ResourceTagList" } } }, "com.amazonaws.cloudtrail#ListTagsRequest": { "type": "structure", "members": { "ResourceIdList": { "target": "com.amazonaws.cloudtrail#ResourceIdList", "traits": { "smithy.api#documentation": "Specifies a list of trail, event data store, dashboard, or channel ARNs whose tags will be listed. The list\n has a limit of 20 ARNs.
\n Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
Reserved for future use.
" } } }, "traits": { "smithy.api#documentation": "Specifies a list of tags to return.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListTagsResponse": { "type": "structure", "members": { "ResourceTagList": { "target": "com.amazonaws.cloudtrail#ResourceTagList", "traits": { "smithy.api#documentation": "A list of resource tags.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Reserved for future use.
" } } }, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ListTrails": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#ListTrailsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#ListTrailsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Lists trails that are in the current account.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Trails" } } }, "com.amazonaws.cloudtrail#ListTrailsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#ListTrailsResponse": { "type": "structure", "members": { "Trails": { "target": "com.amazonaws.cloudtrail#Trails", "traits": { "smithy.api#documentation": "Returns the name, ARN, and home Region of trails in the current account.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#Location": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 1024 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:*]+$" } }, "com.amazonaws.cloudtrail#Long": { "type": "long" }, "com.amazonaws.cloudtrail#LookupAttribute": { "type": "structure", "members": { "AttributeKey": { "target": "com.amazonaws.cloudtrail#LookupAttributeKey", "traits": { "smithy.api#documentation": "Specifies an attribute on which to filter the events returned.
", "smithy.api#required": {} } }, "AttributeValue": { "target": "com.amazonaws.cloudtrail#LookupAttributeValue", "traits": { "smithy.api#documentation": "Specifies a value for the specified AttributeKey.
The maximum length for the AttributeValue is 2000 characters. The\n following characters ('_', ' ', ',',\n '\\\\n') count as two characters towards the 2000 character limit.
Specifies an attribute and value that filter the events returned.
" } }, "com.amazonaws.cloudtrail#LookupAttributeKey": { "type": "enum", "members": { "EVENT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EventId" } }, "EVENT_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EventName" } }, "READ_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReadOnly" } }, "USERNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Username" } }, "RESOURCE_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceType" } }, "RESOURCE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceName" } }, "EVENT_SOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EventSource" } }, "ACCESS_KEY_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccessKeyId" } } } }, "com.amazonaws.cloudtrail#LookupAttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.cloudtrail#LookupAttributesList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#LookupAttribute" } }, "com.amazonaws.cloudtrail#LookupEvents": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#LookupEventsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#LookupEventsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidEventCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidLookupAttributesException" }, { "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" }, { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, { "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Looks up management events or CloudTrail Insights events that are captured by CloudTrail. \n You can look up events that occurred in a Region within the last 90 days.
\n\n LookupEvents returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your \n Insights event data store, and you can also view the Lake dashboard for Insights.
Lookup supports the following attributes for management events:
\nAmazon Web Services access key
\nEvent ID
\nEvent name
\nEvent source
\nRead only
\nResource name
\nResource type
\nUser name
\nLookup supports the following attributes for Insights events:
\nEvent ID
\nEvent name
\nEvent source
\nAll attributes are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.
\nThe rate of lookup requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.
\nContains a list of lookup attributes. Currently the list can contain only one\n item.
" } }, "StartTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies that only events that occur after or at the specified time are returned. If\n the specified start time is after the specified end time, an error is returned.
" } }, "EndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "Specifies that only events that occur before or at the specified time are returned. If\n the specified end time is before the specified start time, an error is returned.
" } }, "EventCategory": { "target": "com.amazonaws.cloudtrail#EventCategory", "traits": { "smithy.api#documentation": "Specifies the event category. If you do not specify an event category, events of the\n category are not returned in the response. For example, if you do not specify\n insight as the value of EventCategory, no Insights events are\n returned.
The number of events to return. Possible values are 1 through 50. The default is\n 50.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#NextToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.
" } } }, "traits": { "smithy.api#documentation": "Contains a request for LookupEvents.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#LookupEventsResponse": { "type": "structure", "members": { "Events": { "target": "com.amazonaws.cloudtrail#EventsList", "traits": { "smithy.api#documentation": "A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed\n first.
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#NextToken", "traits": { "smithy.api#documentation": "The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.
" } } }, "traits": { "smithy.api#documentation": "Contains a response to a LookupEvents action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "MaxConcurrentQueries", "httpResponseCode": 429 }, "smithy.api#documentation": "You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some\n queries to finish, and then run the query again.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.cloudtrail#MaxEventSize": { "type": "enum", "members": { "Standard": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Standard" } }, "Large": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Large" } } } }, "com.amazonaws.cloudtrail#MaxQueryResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.cloudtrail#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "MaximumNumberOfTrailsExceeded", "httpResponseCode": 403 }, "smithy.api#documentation": "This exception is thrown when the maximum number of trails is reached.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#NextToken": { "type": "string" }, "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "NoManagementAccountSLRExists", "httpResponseCode": 403 }, "smithy.api#documentation": "This exception is thrown when the management account does not have a service-linked\n role.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "NotOrganizationManagementAccount", "httpResponseCode": 403 }, "smithy.api#documentation": "This exception is thrown when the account making the request is not the organization's\n management account.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "NotOrganizationMasterAccount", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#OperationNotPermittedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationNotPermitted", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the requested operation is not permitted.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#Operator": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#OperatorValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudtrail#OperatorTargetList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#OperatorTargetListMember" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudtrail#OperatorTargetListMember": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudtrail#OperatorValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "OrganizationNotInAllFeaturesMode", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when Organizations is not configured to support all\n features. All features must be enabled in Organizations to support creating an\n organization trail or event data store.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#OrganizationsNotInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "OrganizationsNotInUse", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is thrown when the request is made from an Amazon Web Services account\n that is not a member of an organization. To make this request, sign in using the\n credentials of an account that belongs to an organization.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 1000 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudtrail#PartitionKey": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#PartitionKeyName", "traits": { "smithy.api#documentation": "The name of the partition key.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.cloudtrail#PartitionKeyType", "traits": { "smithy.api#documentation": "The data type of the partition key. For example, bigint or string.
Contains information about a partition key for an event data store.
" } }, "com.amazonaws.cloudtrail#PartitionKeyList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#PartitionKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.cloudtrail#PartitionKeyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.cloudtrail#PartitionKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.cloudtrail#Prompt": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 500 }, "smithy.api#pattern": "^[ -~\\n]*$" } }, "com.amazonaws.cloudtrail#PublicKey": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.cloudtrail#ByteBuffer", "traits": { "smithy.api#documentation": "The DER encoded public key value in PKCS#1 format.
" } }, "ValidityStartTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The starting time of validity of the public key.
" } }, "ValidityEndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The ending time of validity of the public key.
" } }, "Fingerprint": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The fingerprint of the public key.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a returned public key.
" } }, "com.amazonaws.cloudtrail#PublicKeyList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#PublicKey" } }, "com.amazonaws.cloudtrail#PutEventConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#PutEventConfigurationRequest" }, "output": { "target": "com.amazonaws.cloudtrail#PutEventConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#PutEventConfigurationRequest": { "type": "structure", "members": { "TrailName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of the trail for which you want to update event configuration settings.
" } }, "EventDataStore": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which event configuration settings are updated.
" } }, "MaxEventSize": { "target": "com.amazonaws.cloudtrail#MaxEventSize", "traits": { "smithy.api#documentation": "The maximum allowed size for events to be stored in the specified event data store. If you are using context key selectors, MaxEventSize must be set to Large.
" } }, "ContextKeySelectors": { "target": "com.amazonaws.cloudtrail#ContextKeySelectors", "traits": { "smithy.api#documentation": "A list of context key selectors that will be included to provide enriched event data.
" } }, "AggregationConfigurations": { "target": "com.amazonaws.cloudtrail#AggregationConfigurations", "traits": { "smithy.api#documentation": "The list of aggregation configurations that you want to configure for the trail.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#PutEventConfigurationResponse": { "type": "structure", "members": { "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trail that has aggregation enabled.
" } }, "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings were updated.
" } }, "MaxEventSize": { "target": "com.amazonaws.cloudtrail#MaxEventSize", "traits": { "smithy.api#documentation": "The maximum allowed size for events stored in the specified event data store.
" } }, "ContextKeySelectors": { "target": "com.amazonaws.cloudtrail#ContextKeySelectors", "traits": { "smithy.api#documentation": "The list of context key selectors that are configured for the event data store.
" } }, "AggregationConfigurations": { "target": "com.amazonaws.cloudtrail#AggregationConfigurations", "traits": { "smithy.api#documentation": "A list of aggregation configurations that are configured for the trail.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#PutEventSelectors": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#PutEventSelectorsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#PutEventSelectorsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten.
You can use AdvancedEventSelectors to \n log management events, data events for all resource types, and network activity events.
You can use EventSelectors to log management events and data events for the following resource types:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
You can't use EventSelectors to log network activity events.
If you want your trail to log Insights events, be sure the event selector or advanced event selector enables \n logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Working with CloudTrail Insights in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events or network activity events.
\nWhen an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.
\nExample
\nYou create an event selector for a trail and specify that you want to log write-only\n events.
\nThe EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.
CloudTrail evaluates whether the events match your event selectors.
\nThe RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.
The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.
You can configure up to five event selectors for each trail.
\nYou can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see\n Logging management events, Logging\n data events, Logging\n network activity events, and Quotas in CloudTrail in the CloudTrail User\n Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#PutEventSelectorsRequest": { "type": "structure", "members": { "TrailName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nIf you specify a trail ARN, it must be in the following format.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
You can't use event selectors to log network activity events.
\nYou can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.
Specifies the settings for advanced event selectors. You can use advanced event selectors to \n log management events, data events for all resource types, and network activity events.
\nYou can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events and \n Logging network activity events\n in the CloudTrail User Guide.
Specifies the ARN of the trail that was updated with event selectors. The following is\n the format of a trail ARN.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies the event selectors configured for your trail.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "Specifies the advanced event selectors configured for your trail.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#PutInsightSelectors": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#PutInsightSelectorsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#PutInsightSelectorsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#KmsException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Lets you enable Insights event logging on specific event categories by specifying the Insights selectors that you\n want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn\n off Insights event logging, by passing an empty list of Insights types. The valid Insights\n event types are ApiErrorRateInsight and\n ApiCallRateInsight, and valid EventCategories are Management and Data.
\n Insights on data events are not supported on event data stores. For event data stores, you can only enable Insights on management events.\n
\nTo enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (EventDataStore) and the destination event data store (InsightsDestination). The source event data store logs management events and enables Insights. \n The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.
To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail for which you want to change or add Insights\n selectors.
\n For Management events Insights: To log CloudTrail Insights on the API call rate, the trail or event data store must log write management events. \n To log CloudTrail Insights on the API error rate, the trail or event data store must log read or write management events.\n
\n For Data events Insights: To log CloudTrail Insights on the API call rate or API error rate, the trail must log read or write data events. Data events Insights are not supported on event data store. \n
To log CloudTrail Insights events on API call volume, the trail or event data store\n must log write management events. To log CloudTrail\n Insights events on API error rate, the trail or event data store must log read or\n write management events. You can call GetEventSelectors on a trail \n to check whether the trail logs management events. You can call GetEventDataStore on an \n event data store to check whether the event data store logs management events.
For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#PutInsightSelectorsRequest": { "type": "structure", "members": { "TrailName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of the CloudTrail trail for which you want to change or add Insights\n selectors.
\nYou cannot use this parameter with the EventDataStore and InsightsDestination parameters.
Contains the Insights types you want to log on a specific category of events on a trail or event data store. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can log Insights for management events only.
The ApiCallRateInsight Insights type analyzes write-only management\n\t API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.
The ApiErrorRateInsight Insights type analyzes management and data \n\t API calls that result in error codes. The error is shown if the API call is\n\t unsuccessful.
The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights\n selectors. To enable Insights on an event data store, you must provide both the \n EventDataStore and InsightsDestination parameters.
You cannot use this parameter with the TrailName parameter.
\n The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the \n EventDataStore and InsightsDestination parameters.\n
You cannot use this parameter with the TrailName parameter.
The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights\n selectors.
" } }, "InsightSelectors": { "target": "com.amazonaws.cloudtrail#InsightSelectors", "traits": { "smithy.api#documentation": "Contains the Insights types you want to log on a specific category of events in a trail or event data store. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can only log Insights for management events only.
The Amazon Resource Name (ARN) of the source event data store for which you want to change or add Insights\n selectors.
" } }, "InsightsDestination": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "\n The ARN of the destination event data store that logs Insights events.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudtrail#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourcePolicyNotValidException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "\n Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#PutResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudtrail#ResourceArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
\nExample event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
\n A JSON-formatted string for an Amazon Web Services resource-based policy.\n
\nFor example resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#PutResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudtrail#ResourceArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.\n
\nExample event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
\n The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n
" } }, "DelegatedAdminResourcePolicy": { "target": "com.amazonaws.cloudtrail#ResourcePolicy", "traits": { "smithy.api#documentation": "\n The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. \n This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, \n see Default resource policy for delegated administrators.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#Queries": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Query" } }, "com.amazonaws.cloudtrail#Query": { "type": "structure", "members": { "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of a query.
" } }, "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { "smithy.api#documentation": "The status of the query. This can be QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
The creation time of a query.
" } } }, "traits": { "smithy.api#documentation": "A SQL string of criteria about events that you want to collect in an event data\n store.
" } }, "com.amazonaws.cloudtrail#QueryAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9._\\-]*$" } }, "com.amazonaws.cloudtrail#QueryIdNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "QueryIdNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The query ID does not exist or does not map to a query.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#QueryParameter": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudtrail#QueryParameterKey": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:$]+$" } }, "com.amazonaws.cloudtrail#QueryParameterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, "com.amazonaws.cloudtrail#QueryParameterValues": { "type": "map", "key": { "target": "com.amazonaws.cloudtrail#QueryParameterKey" }, "value": { "target": "com.amazonaws.cloudtrail#QueryParameterValue" } }, "com.amazonaws.cloudtrail#QueryParameters": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#QueryParameter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.cloudtrail#QueryResultColumn": { "type": "map", "key": { "target": "com.amazonaws.cloudtrail#QueryResultKey" }, "value": { "target": "com.amazonaws.cloudtrail#QueryResultValue" } }, "com.amazonaws.cloudtrail#QueryResultKey": { "type": "string" }, "com.amazonaws.cloudtrail#QueryResultRow": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#QueryResultColumn" } }, "com.amazonaws.cloudtrail#QueryResultRows": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#QueryResultRow" } }, "com.amazonaws.cloudtrail#QueryResultValue": { "type": "string" }, "com.amazonaws.cloudtrail#QueryStatement": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.cloudtrail#QueryStatistics": { "type": "structure", "members": { "ResultsCount": { "target": "com.amazonaws.cloudtrail#Integer", "traits": { "smithy.api#documentation": "The number of results returned.
" } }, "TotalResultsCount": { "target": "com.amazonaws.cloudtrail#Integer", "traits": { "smithy.api#documentation": "The total number of results returned by a query.
" } }, "BytesScanned": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.
" } } }, "traits": { "smithy.api#documentation": "Metadata about a query, such as the number of results.
" } }, "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { "type": "structure", "members": { "EventsMatched": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of events that matched a query.
" } }, "EventsScanned": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The number of events that the query scanned in the event data store.
" } }, "BytesScanned": { "target": "com.amazonaws.cloudtrail#Long", "traits": { "smithy.api#documentation": "The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.
" } }, "ExecutionTimeInMillis": { "target": "com.amazonaws.cloudtrail#Integer", "traits": { "smithy.api#documentation": "The query's run time, in milliseconds.
" } }, "CreationTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The creation time of the query.
" } } }, "traits": { "smithy.api#documentation": "Gets metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.
" } }, "com.amazonaws.cloudtrail#QueryStatus": { "type": "enum", "members": { "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "FINISHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FINISHED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } } } }, "com.amazonaws.cloudtrail#ReadWriteType": { "type": "enum", "members": { "ReadOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReadOnly" } }, "WriteOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WriteOnly" } }, "All": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "All" } } } }, "com.amazonaws.cloudtrail#RefreshId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 20 }, "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.cloudtrail#RefreshSchedule": { "type": "structure", "members": { "Frequency": { "target": "com.amazonaws.cloudtrail#RefreshScheduleFrequency", "traits": { "smithy.api#documentation": "\nThe frequency at which you want the dashboard refreshed.\n
" } }, "Status": { "target": "com.amazonaws.cloudtrail#RefreshScheduleStatus", "traits": { "smithy.api#documentation": "\nSpecifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.\n
\n The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.\n
" } } }, "traits": { "smithy.api#documentation": "\nThe schedule for a dashboard refresh.\n
" } }, "com.amazonaws.cloudtrail#RefreshScheduleFrequency": { "type": "structure", "members": { "Unit": { "target": "com.amazonaws.cloudtrail#RefreshScheduleFrequencyUnit", "traits": { "smithy.api#documentation": "\n The unit to use for the refresh.\n
\nFor custom dashboards, the unit can be HOURS or DAYS.
For the Highlights dashboard, the Unit must be HOURS.
\nThe value for the refresh schedule.\n
\n\n For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24\n
For custom dashboards, the only valid value when the unit is DAYS is 1.
For the Highlights dashboard, the Value must be 6.
\nSpecifies the frequency for a dashboard refresh schedule.\n
\n\n For a custom dashboard, you can schedule a refresh for every 1, 6, 12, or 24 hours, or every day.\n
" } }, "com.amazonaws.cloudtrail#RefreshScheduleFrequencyUnit": { "type": "enum", "members": { "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURS" } }, "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } } } }, "com.amazonaws.cloudtrail#RefreshScheduleFrequencyValue": { "type": "integer" }, "com.amazonaws.cloudtrail#RefreshScheduleStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest" }, "output": { "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#AccountNotFoundException" }, { "target": "com.amazonaws.cloudtrail#AccountRegisteredException" }, { "target": "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Registers an organization\u2019s member account as the CloudTrail delegated administrator.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest": { "type": "structure", "members": { "MemberAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "An organization member account ID that you want to designate as a delegated\n administrator.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies an organization member account ID as a CloudTrail delegated\n administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the following response if successful. Otherwise, returns an error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#RemoveTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#RemoveTagsRequest" }, "output": { "target": "com.amazonaws.cloudtrail#RemoveTagsResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from a trail, event data store, dashboard, or channel.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#RemoveTagsRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail, event data store, dashboard, or channel from which tags should be\n removed.
\n Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
Specifies a list of tags to be removed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the tags to remove from a trail, event data store, dashboard, or channel.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#RemoveTagsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#RequestWidget": { "type": "structure", "members": { "QueryStatement": { "target": "com.amazonaws.cloudtrail#QueryStatement", "traits": { "smithy.api#documentation": "\nThe query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.\n
\nWhen a query uses ? with eventTime, ? must be surrounded by single quotes as follows: '?'.
\n The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.\n
\n The view properties for the widget. For more information about view properties, see \n View properties for widgets\n in the CloudTrail User Guide.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\nContains information about a widget on a CloudTrail Lake dashboard.\n
" } }, "com.amazonaws.cloudtrail#RequestWidgetList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#RequestWidget" } }, "com.amazonaws.cloudtrail#Resource": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The type of a resource referenced by the event returned. When the resource type cannot\n be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter\n events by the resource types supported for a service, see Filtering CloudTrail Events.
" } }, "ResourceName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of the resource referenced by the event returned. These are user-created names\n whose values will depend on the environment. For example, the resource name might be\n \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2\n Instance.
" } } }, "traits": { "smithy.api#documentation": "Specifies the type and name of a resource referenced by an event.
" } }, "com.amazonaws.cloudtrail#ResourceARNNotValidException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceARNNotValid", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.\n
\nThe following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n
The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n
The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n
A list of resources referenced by the event returned.
" } }, "com.amazonaws.cloudtrail#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified resource is not found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ResourcePolicy": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourcePolicyNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "\n This exception is thrown when the specified resource policy is not found.\n
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#ResourcePolicyNotValidException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourcePolicyNotValid", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#ResourceTag": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the resource.
" } }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList", "traits": { "smithy.api#documentation": "A list of tags.
" } } }, "traits": { "smithy.api#documentation": "A resource tag.
" } }, "com.amazonaws.cloudtrail#ResourceTagList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#ResourceTag" } }, "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceTypeNotSupported", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified resource type is not supported by CloudTrail.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#RestoreEventDataStore": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" }, "output": { "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nRestores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.
The ARN (or the ID suffix of the ARN) of the event data store that you want to\n restore.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The event data store ARN.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { "smithy.api#documentation": "The status of the event data store.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors that were used to select events.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the event data store is collecting events from all Regions, or only\n from the Region in which the event data store was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in\n Organizations.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#documentation": "The retention period, in days.
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of an event data store's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#RetentionPeriod": { "type": "integer", "traits": { "smithy.api#range": { "min": 7, "max": 3653 } } }, "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "S3BucketDoesNotExist", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is thrown when the specified S3 bucket does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#S3ImportSource": { "type": "structure", "members": { "S3LocationUri": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The URI for the source S3 bucket.
", "smithy.api#required": {} } }, "S3BucketRegion": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Region associated with the source S3 bucket.
", "smithy.api#required": {} } }, "S3BucketAccessRoleArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The IAM ARN role used to access the source S3 bucket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The settings for the source S3 bucket.
" } }, "com.amazonaws.cloudtrail#SampleQueryDescription": { "type": "string" }, "com.amazonaws.cloudtrail#SampleQueryName": { "type": "string" }, "com.amazonaws.cloudtrail#SampleQueryRelevance": { "type": "float", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.cloudtrail#SampleQuerySQL": { "type": "string" }, "com.amazonaws.cloudtrail#SearchSampleQueries": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#SearchSampleQueriesRequest" }, "output": { "target": "com.amazonaws.cloudtrail#SearchSampleQueriesResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Searches sample queries and returns a list of sample queries that are sorted by relevance. \n To search for sample queries, provide a natural language SearchPhrase in English.\n
\n The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cloudtrail#SearchSampleQueriesMaxResults", "traits": { "smithy.api#documentation": "\n The maximum number of results to return on a single page. The default value is 10.\n
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "\n A token you can use to get the next page of results. The length constraint is in characters, not words.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#SearchSampleQueriesResponse": { "type": "structure", "members": { "SearchResults": { "target": "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResults", "traits": { "smithy.api#documentation": "\n A list of objects containing the search results ordered from most relevant to least relevant.\n
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { "smithy.api#documentation": "\n A token you can use to get the next page of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#SearchSampleQueriesSearchPhrase": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 1000 }, "smithy.api#pattern": "^[ -~\\n]*$" } }, "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResult": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#SampleQueryName", "traits": { "smithy.api#documentation": "\n The name of a sample query.\n
" } }, "Description": { "target": "com.amazonaws.cloudtrail#SampleQueryDescription", "traits": { "smithy.api#documentation": "\n A longer description of a sample query.\n
" } }, "SQL": { "target": "com.amazonaws.cloudtrail#SampleQuerySQL", "traits": { "smithy.api#documentation": "\n The SQL code of the sample query.\n
" } }, "Relevance": { "target": "com.amazonaws.cloudtrail#SampleQueryRelevance", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "\n A value between 0 and 1 indicating the similarity between the search phrase and result.\n
" } } }, "traits": { "smithy.api#documentation": "\n A search result returned by the SearchSampleQueries operation.\n
Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServiceQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "\n This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see Service quotas \n in the Amazon Web Services General Reference.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#Source": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudtrail#SourceConfig": { "type": "structure", "members": { "ApplyToAllRegions": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the channel applies to a single Region or to all Regions.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors that are configured for the channel.
" } } }, "traits": { "smithy.api#documentation": "Contains configuration information about the channel.
" } }, "com.amazonaws.cloudtrail#SourceEventCategories": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#SourceEventCategory" } }, "com.amazonaws.cloudtrail#SourceEventCategory": { "type": "enum", "members": { "Management": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Management" } }, "Data": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Data" } } } }, "com.amazonaws.cloudtrail#StartDashboardRefresh": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StartDashboardRefreshRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StartDashboardRefreshResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nStarts a refresh of the specified dashboard.\n
\n\n Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
\nThe name or ARN of the dashboard.\n
", "smithy.api#required": {} } }, "QueryParameterValues": { "target": "com.amazonaws.cloudtrail#QueryParameterValues", "traits": { "smithy.api#documentation": "\n The query parameter values for the dashboard\n
\nFor custom dashboards, the following query parameters are valid: $StartTime$, $EndTime$, and $Period$.
For managed dashboards, the following query parameters are valid: $StartTime$,\n $EndTime$, $Period$, and $EventDataStoreId$. The\n $EventDataStoreId$ query parameter is required.
\nThe refresh ID for the dashboard.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StartEventDataStoreIngestion": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStarts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StartImport": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StartImportRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StartImportResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#AccountHasOngoingImportException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ImportNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidImportSourceException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.
\nThe ARN of the destination event data store. Use this parameter for a new import.\n
" } }, "ImportSource": { "target": "com.amazonaws.cloudtrail#ImportSource", "traits": { "smithy.api#documentation": "The source S3 bucket for the import. Use this parameter for a new import.
" } }, "StartEventTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": " Use with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.
Use with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.
The ID of the import. Use this parameter when you are retrying an import.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StartImportResponse": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the import.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#ImportDestinations", "traits": { "smithy.api#documentation": "The ARN of the destination event data store.
" } }, "ImportSource": { "target": "com.amazonaws.cloudtrail#ImportSource", "traits": { "smithy.api#documentation": "The source S3 bucket for the import.
" } }, "StartEventTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": " Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
Shows the status of the import after a StartImport request. An import\n finishes with a status of COMPLETED if there were no failures, or\n FAILED if there were failures.
The timestamp for the import's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's last update, if applicable.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StartLogging": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StartLoggingRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StartLoggingResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Starts the recording of Amazon Web Services API calls and log file delivery for a trail.\n For a trail that is enabled in all Regions, this operation must be called from the Region\n in which the trail was created. This operation cannot be called on the shadow trails\n (replicated trails in other Regions) of a trail that is enabled in all Regions.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#StartLoggingRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n logs Amazon Web Services API calls. The following is the format of a trail ARN.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
The request to CloudTrail to start logging Amazon Web Services API calls for an\n account.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StartLoggingResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StartQuery": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StartQueryRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StartQueryResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" }, { "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStarts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.
\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.
The SQL code of your query.
" } }, "DeliveryS3Uri": { "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", "traits": { "smithy.api#documentation": "The URI for the S3 bucket where CloudTrail delivers the query results.
" } }, "QueryAlias": { "target": "com.amazonaws.cloudtrail#QueryAlias", "traits": { "smithy.api#documentation": "\n The alias that identifies a query template.\n
" } }, "QueryParameters": { "target": "com.amazonaws.cloudtrail#QueryParameters", "traits": { "smithy.api#documentation": "\n The query parameters for the specified QueryAlias.\n
\nThe account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StartQueryResponse": { "type": "structure", "members": { "QueryId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the started query.
" } }, "EventDataStoreOwnerAccountId": { "target": "com.amazonaws.cloudtrail#AccountId", "traits": { "smithy.api#documentation": "\n The account ID of the event data store owner.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StopEventDataStoreIngestion": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StopImport": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StopImportRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StopImportResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ImportNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStops a specified import.
" } }, "com.amazonaws.cloudtrail#StopImportRequest": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID of the import.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StopImportResponse": { "type": "structure", "members": { "ImportId": { "target": "com.amazonaws.cloudtrail#UUID", "traits": { "smithy.api#documentation": "The ID for the import.
" } }, "ImportSource": { "target": "com.amazonaws.cloudtrail#ImportSource", "traits": { "smithy.api#documentation": "The source S3 bucket for the import.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#ImportDestinations", "traits": { "smithy.api#documentation": "The ARN of the destination event data store.
" } }, "ImportStatus": { "target": "com.amazonaws.cloudtrail#ImportStatus", "traits": { "smithy.api#documentation": "The status of the import.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's creation.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp of the import's last update.
" } }, "StartEventTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": " Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n
Returns information on the stopped import.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#StopLogging": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#StopLoggingRequest" }, "output": { "target": "com.amazonaws.cloudtrail#StopLoggingResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Suspends the recording of Amazon Web Services API calls and log file delivery for the\n specified trail. Under most circumstances, there is no need to use this action. You can\n update a trail without stopping it first. This action is the only way to stop recording.\n For a trail enabled in all Regions, this operation must be called from the Region in which\n the trail was created, or an InvalidHomeRegionException will occur. This\n operation cannot be called on the shadow trails (replicated trails in other Regions) of a\n trail enabled in all Regions.
Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n will stop logging Amazon Web Services API calls. The following is the format of a trail\n ARN.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Passes the request to CloudTrail to stop logging Amazon Web Services API calls for\n the specified account.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#StopLoggingResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#String": { "type": "string" }, "com.amazonaws.cloudtrail#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.cloudtrail#TagKey", "traits": { "smithy.api#documentation": "The key in a key-value pair. The key must be must be no longer than 128 Unicode\n characters. The key must be unique for the resource to which it applies.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudtrail#TagValue", "traits": { "smithy.api#documentation": "The value in a key-value pair of a tag. The value must be no longer than 256 Unicode\n characters.
" } } }, "traits": { "smithy.api#documentation": "A custom key-value pair associated with a resource such as a CloudTrail\n trail, event data store, dashboard, or channel.
" } }, "com.amazonaws.cloudtrail#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudtrail#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cloudtrail#TagsLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TagsLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is\n 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#TagsList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Tag" }, "traits": { "smithy.api#documentation": "A list of tags.
", "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.cloudtrail#Template": { "type": "enum", "members": { "API_ACTIVITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "API_ACTIVITY" } }, "RESOURCE_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_ACCESS" } }, "USER_ACTIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_ACTIONS" } } }, "traits": { "smithy.api#documentation": "Specifies the type of the aggregation templates in the aggregation configuration. Valid values include API_ACTIVITY, RESOURCE_ACCESS and USER_ACTIONS.
" } }, "com.amazonaws.cloudtrail#Templates": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Template" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { "type": "boolean" }, "com.amazonaws.cloudtrail#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ThrottlingException", "httpResponseCode": 429 }, "smithy.api#documentation": "\n This exception is thrown when the request rate exceeds the limit. \n
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.cloudtrail#TimeOfDay": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{2}:[0-9]{2}$" } }, "com.amazonaws.cloudtrail#Timestamps": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Date" } }, "com.amazonaws.cloudtrail#Trail": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Name of the trail set by calling CreateTrail. The maximum length is\n 128 characters.
" } }, "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket naming rules.
" } }, "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.
" } }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.
\n\n arn:aws:sns:us-east-2:123456789012:MyTopic\n
Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail exists only in one Region or exists in all Regions.
" } }, "HomeRegion": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Region in which the trail was created.
" } }, "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail. The following is the format of a trail ARN.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies whether log file validation is enabled.
" } }, "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log\n group to which CloudTrail logs will be delivered.
" } }, "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
Specifies if the trail has custom event selectors.
" } }, "HasInsightSelectors": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether a trail has insight types specified in an InsightSelector\n list.
Specifies whether the trail is an organization trail.
" } }, "RecursiveLogging": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
The settings for a trail.
" } }, "com.amazonaws.cloudtrail#TrailAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrailAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the specified trail already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#TrailInfo": { "type": "structure", "members": { "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The ARN of a trail.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The name of a trail.
" } }, "HomeRegion": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "The Amazon Web Services Region in which a trail was created.
" } } }, "traits": { "smithy.api#documentation": "Information about a CloudTrail trail, including the trail's name, home Region,\n and Amazon Resource Name (ARN).
" } }, "com.amazonaws.cloudtrail#TrailList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Trail" } }, "com.amazonaws.cloudtrail#TrailNameList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#String" } }, "com.amazonaws.cloudtrail#TrailNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrailNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is thrown when the trail with the given name is not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#TrailNotProvidedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrailNotProvided", "httpResponseCode": 404 }, "smithy.api#documentation": "This exception is no longer in use.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudtrail#Trails": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#TrailInfo" } }, "com.amazonaws.cloudtrail#Type": { "type": "enum", "members": { "TagContext": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TagContext" } }, "RequestContext": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequestContext" } } } }, "com.amazonaws.cloudtrail#UUID": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-f0-9\\-]+$" } }, "com.amazonaws.cloudtrail#UnsupportedOperationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudtrail#ErrorMessage", "traits": { "smithy.api#documentation": "Brief description of the exception returned by the request.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "UnsupportedOperation", "httpResponseCode": 400 }, "smithy.api#documentation": "This exception is thrown when the requested operation is not supported.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudtrail#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#UpdateChannelRequest" }, "output": { "target": "com.amazonaws.cloudtrail#UpdateChannelResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" }, { "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nUpdates a channel specified by a required channel ARN or UUID.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudtrail#UpdateChannelRequest": { "type": "structure", "members": { "Channel": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The ARN or ID (the ARN suffix) of the channel that you want to update.
", "smithy.api#required": {} } }, "Destinations": { "target": "com.amazonaws.cloudtrail#Destinations", "traits": { "smithy.api#documentation": "The ARNs of event data stores that you want to log events arriving through the channel.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#ChannelName", "traits": { "smithy.api#documentation": "\n Changes the name of the channel.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#UpdateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.cloudtrail#ChannelArn", "traits": { "smithy.api#documentation": "The ARN of the channel that was updated.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#ChannelName", "traits": { "smithy.api#documentation": "The name of the channel that was updated.
" } }, "Source": { "target": "com.amazonaws.cloudtrail#Source", "traits": { "smithy.api#documentation": "The event source of the channel that was updated.
" } }, "Destinations": { "target": "com.amazonaws.cloudtrail#Destinations", "traits": { "smithy.api#documentation": "The event data stores that log events arriving through the channel.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#UpdateDashboard": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#UpdateDashboardRequest" }, "output": { "target": "com.amazonaws.cloudtrail#UpdateDashboardResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" }, { "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" }, { "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nUpdates the specified dashboard.\n
\n\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
\n The name or ARN of the dashboard.\n
", "smithy.api#required": {} } }, "Widgets": { "target": "com.amazonaws.cloudtrail#RequestWidgetList", "traits": { "smithy.api#documentation": "\nAn array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.\n
\nTo add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.
To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.
" } }, "RefreshSchedule": { "target": "com.amazonaws.cloudtrail#RefreshSchedule", "traits": { "smithy.api#documentation": "\nThe refresh schedule configuration for the dashboard.\n
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "\n Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#UpdateDashboardResponse": { "type": "structure", "members": { "DashboardArn": { "target": "com.amazonaws.cloudtrail#DashboardArn", "traits": { "smithy.api#documentation": "\nThe ARN for the dashboard.\n
" } }, "Name": { "target": "com.amazonaws.cloudtrail#DashboardName", "traits": { "smithy.api#documentation": "\nThe name for the dashboard.\n
" } }, "Type": { "target": "com.amazonaws.cloudtrail#DashboardType", "traits": { "smithy.api#documentation": "\nThe type of dashboard.\n
" } }, "Widgets": { "target": "com.amazonaws.cloudtrail#WidgetList", "traits": { "smithy.api#documentation": "\nAn array of widgets for the dashboard.\n
" } }, "RefreshSchedule": { "target": "com.amazonaws.cloudtrail#RefreshSchedule", "traits": { "smithy.api#documentation": "\nThe refresh schedule for the dashboard, if configured.\n
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "\n Indicates whether termination protection is enabled for the dashboard.\n
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "\n The timestamp that shows when the dashboard was created.\n
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "\n The timestamp that shows when the dashboard was updated.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#UpdateEventDataStore": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" }, "output": { "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#KmsException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nUpdates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or network activity events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
The ARN (or the ID suffix of the ARN) of the event data store that you want to\n update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The event data store name.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors used to select events for the event data store. You can\n configure up to five advanced event selectors for each event data store.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether an event data store collects events from all Regions, or only from the\n Region in which it was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether an event data store collects events logged for an organization in\n Organizations.
\nOnly the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to \n an organization event data store.
\nThe retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.
CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous \n retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.
Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", "traits": { "smithy.api#documentation": "Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.
Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.
\nCloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.
\nExamples:
\n\n alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
\n 12345678-1234-1234-1234-123456789012\n
You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to \n EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.
The billing mode for the event data store determines the cost \n for ingesting events and the default and maximum retention period for the event data store.
\nThe following are the possible values:
\n\n EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is \n 366 days.
\n FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). \n The default retention period for this billing mode is 2557 days.
For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { "smithy.api#documentation": "The ARN of the event data store.
" } }, "Name": { "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { "smithy.api#documentation": "The name of the event data store.
" } }, "Status": { "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { "smithy.api#documentation": "The status of an event data store.
" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors that are applied to the event data store.
" } }, "MultiRegionEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.
" } }, "OrganizationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in\n Organizations.
" } }, "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { "smithy.api#documentation": "The retention period, in days.
" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { "smithy.api#documentation": "Indicates whether termination protection is enabled for the event data store.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp that shows when an event data store was first created.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "The timestamp that shows when the event data store was last updated.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" } }, "FederationStatus": { "target": "com.amazonaws.cloudtrail#FederationStatus", "traits": { "smithy.api#documentation": "\n Indicates the Lake query federation status. The status is \n ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.\n
\n If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#UpdateTrail": { "type": "operation", "input": { "target": "com.amazonaws.cloudtrail#UpdateTrailRequest" }, "output": { "target": "com.amazonaws.cloudtrail#UpdateTrailResponse" }, "errors": [ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, { "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" }, { "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" }, { "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" }, { "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" }, { "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" }, { "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" }, { "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudtrail#InvalidParameterException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" }, { "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" }, { "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, { "target": "com.amazonaws.cloudtrail#KmsException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" }, { "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" }, { "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" }, { "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, { "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" }, { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, { "target": "com.amazonaws.cloudtrail#ThrottlingException" }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, { "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" }, { "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "Updates trail settings that control what events you are logging, and how to handle log\n files. Changes to a trail do not require stopping the CloudTrail service. Use this\n action to designate an existing bucket for log delivery. If the existing bucket has\n previously been a target for CloudTrail log files, an IAM policy\n exists for the bucket. UpdateTrail must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException is thrown.
Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\n (_), or dashes (-)
\nStart with a letter or number, and end with a letter or number
\nBe between 3 and 128 characters
\nHave no adjacent periods, underscores or dashes. Names like\n my-_namespace and my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
\nIf Name is a trail ARN, it must be in the following format.
\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket naming rules.
" } }, "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.
" } }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name or ARN of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.
" } }, "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the log files. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail applies only to the current Region or to all Regions. The\n default is false. If the trail exists only in the current Region and this value is set to\n true, shadow trails (replications of the trail) will be created in the other Regions. If\n the trail exists in all Regions and this value is set to false, the trail will remain in\n the Region where it was created, and its shadow trails in other Regions will be deleted. As\n a best practice, consider using trails that log events in all Regions.
" } }, "EnableLogFileValidation": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether log file validation is enabled. The default is false.
\nWhen you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.
\nSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.
\nNot required unless you specify CloudWatchLogsRoleArn.
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the KMS key ID to use to encrypt the logs and digest files delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to\n an alias, a fully specified ARN to a key, or a globally unique identifier.
\nCloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.
\nExamples:
\nalias/MyAliasName
\narn:aws:kms:us-east-2:123456789012:alias/MyAliasName
\narn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n12345678-1234-1234-1234-123456789012
\nSpecifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to\n true, the trail will be created in all Amazon Web Services accounts that\n belong to the organization. If the trail is an organization trail and this is set to\n false, the trail will remain in the current Amazon Web Services account but\n be deleted from all member accounts in the organization.
Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to \n an organization trail.
\nSpecifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
Specifies settings to update for the trail.
", "smithy.api#input": {} } }, "com.amazonaws.cloudtrail#UpdateTrailResponse": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the trail.
" } }, "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the name of the Amazon S3 bucket designated for publishing log\n files.
" } }, "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.
" } }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.
\n\n arn:aws:sns:us-east-2:123456789012:MyTopic\n
Specifies whether the trail is publishing events from global services such as IAM to the log files. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail exists in one Region or in all Regions.
" } }, "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the trail that was updated. The following is the format of a trail\n ARN.
\n\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n
Specifies whether log file integrity validation is enabled.
" } }, "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs are delivered.
" } }, "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.
" } }, "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
Specifies whether the trail is an organization trail.
" } }, "RecursiveLogging": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail.
" } } }, "traits": { "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an\n error.
", "smithy.api#output": {} } }, "com.amazonaws.cloudtrail#ViewPropertiesKey": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" } }, "com.amazonaws.cloudtrail#ViewPropertiesMap": { "type": "map", "key": { "target": "com.amazonaws.cloudtrail#ViewPropertiesKey" }, "value": { "target": "com.amazonaws.cloudtrail#ViewPropertiesValue" } }, "com.amazonaws.cloudtrail#ViewPropertiesValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9._\\- ]+$" } }, "com.amazonaws.cloudtrail#Widget": { "type": "structure", "members": { "QueryAlias": { "target": "com.amazonaws.cloudtrail#QueryAlias", "traits": { "smithy.api#documentation": "The query alias used to identify the query for the widget.\n
" } }, "QueryStatement": { "target": "com.amazonaws.cloudtrail#QueryStatement", "traits": { "smithy.api#documentation": "\nThe SQL query statement for the widget.\n
" } }, "QueryParameters": { "target": "com.amazonaws.cloudtrail#QueryParameters", "traits": { "smithy.api#documentation": "\n The query parameters for the widget.\n
" } }, "ViewProperties": { "target": "com.amazonaws.cloudtrail#ViewPropertiesMap", "traits": { "smithy.api#documentation": "\n The view properties for the widget. For more information about view properties, see \n View properties for widgets\n in the CloudTrail User Guide..\n
" } } }, "traits": { "smithy.api#documentation": "\n A widget on a CloudTrail Lake dashboard.\n
" } }, "com.amazonaws.cloudtrail#WidgetList": { "type": "list", "member": { "target": "com.amazonaws.cloudtrail#Widget" } } } }