'2.0', 'service' => '

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

', 'operations' => [ 'AssociateKmsKey' => '

Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can\'t specify both of those parameters in the same operation.

If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

', 'CancelExportTask' => '

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

', 'CreateExportTask' => '

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

Exporting to S3 buckets that are encrypted with AES-256 is supported.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

', 'CreateLogGroup' => '

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

You must use the following guidelines when naming a log group:

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

', 'CreateLogStream' => '

Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

You must use the following guidelines when naming a log stream:

', 'DeleteAccountPolicy' => '

Deletes a CloudWatch Logs account policy.

To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

', 'DeleteDataProtectionPolicy' => '

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy.

', 'DeleteDestination' => '

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

', 'DeleteLogGroup' => '

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

', 'DeleteLogStream' => '

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

', 'DeleteMetricFilter' => '

Deletes the specified metric filter.

', 'DeleteQueryDefinition' => '

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

Each DeleteQueryDefinition operation can delete one query definition.

You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

', 'DeleteResourcePolicy' => '

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

', 'DeleteRetentionPolicy' => '

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

', 'DeleteSubscriptionFilter' => '

Deletes the specified subscription filter.

', 'DescribeAccountPolicies' => '

Returns a list of all CloudWatch Logs account policies in the account.

', 'DescribeDestinations' => '

Lists all your destinations. The results are ASCII-sorted by destination name.

', 'DescribeExportTasks' => '

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

', 'DescribeLogGroups' => '

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

', 'DescribeLogStreams' => '

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can\'t include both.

This operation has a limit of five transactions per second, after which transactions are throttled.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

', 'DescribeMetricFilters' => '

Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

', 'DescribeQueries' => '

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

', 'DescribeQueryDefinitions' => '

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

', 'DescribeResourcePolicies' => '

Lists the resource policies in this account.

', 'DescribeSubscriptionFilters' => '

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

', 'DisassociateKmsKey' => '

Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can\'t specify both of those parameters in the same operation.

It can take up to 5 minutes for this operation to take effect.

', 'FilterLogEvents' => '

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can\'t include both.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

', 'GetDataProtectionPolicy' => '

Returns information about a log group data protection policy.

', 'GetLogEvents' => '

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can\'t include both.

', 'GetLogGroupFields' => '

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can\'t specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

The response results are sorted by the frequency percentage, starting with the highest percentage.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

', 'GetLogRecord' => '

Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

The full unparsed log event is returned within @message.

', 'GetQueryResults' => '

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery.

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.

', 'ListTagsForResource' => '

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

', 'ListTagsLogGroup' => '

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

Lists the tags for the specified log group.

', 'PutAccountPolicy' => '

Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive data that\'s ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

To use the PutAccountPolicy operation, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

', 'PutDataProtectionPolicy' => '

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that\'s ingested by the log group by auditing and masking the sensitive log data.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

', 'PutDestination' => '

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

', 'PutDestinationPolicy' => '

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

', 'PutLogEvents' => '

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

The batch of events must satisfy the following constraints:

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

', 'PutMetricFilter' => '

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

', 'PutQueryDefinition' => '

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don\'t specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

You must have the logs:PutQueryDefinition permission to be able to perform this operation.

', 'PutResourcePolicy' => '

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

', 'PutRetentionPolicy' => '

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

', 'PutSubscriptionFilter' => '

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

', 'StartQuery' => '

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

', 'StopQuery' => '

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

', 'TagLogGroup' => '

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

', 'TagResource' => '

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don\'t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch Logs resource.

', 'TestMetricFilter' => '

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

', 'UntagLogGroup' => '

The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.

', 'UntagResource' => '

Removes one or more tags from the specified resource.

', ], 'shapes' => [ 'AccessPolicy' => [ 'base' => NULL, 'refs' => [ 'Destination$accessPolicy' => '

An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.

', 'PutDestinationPolicyRequest$accessPolicy' => '

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountIds$member' => NULL, 'AccountPolicy$accountId' => '

The Amazon Web Services account ID that the policy applies to.

', ], ], 'AccountIds' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountPoliciesRequest$accountIdentifiers' => '

If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

If you omit this parameter, only the policy in the current account is returned.

', 'DescribeLogGroupsRequest$accountIdentifiers' => '

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

', ], ], 'AccountPolicies' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountPoliciesResponse$accountPolicies' => '

An array of structures that contain information about the CloudWatch Logs account policies that match the specified filters.

', ], ], 'AccountPolicy' => [ 'base' => '

A structure that contains information about one CloudWatch Logs account policy.

', 'refs' => [ 'AccountPolicies$member' => NULL, 'PutAccountPolicyResponse$accountPolicy' => '

The account policy that you created.

', ], ], 'AccountPolicyDocument' => [ 'base' => NULL, 'refs' => [ 'AccountPolicy$policyDocument' => '

The policy document for this account policy.

The JSON specified in policyDocument can be up to 30,720 characters.

', 'PutAccountPolicyRequest$policyDocument' => '

Specify the data protection policy, in JSON.

This policy must include two JSON blocks:

For an example data protection policy, see the Examples section on this page.

The contents of the two DataIdentifer arrays must match exactly.

In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is different than the operation\'s policyName parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in policyDocument can be up to 30,720 characters.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => '

The ARN of the resource that you want to view tags for.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

', 'TagResourceRequest$resourceArn' => '

The ARN of the resource that you\'re adding tags to.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

', 'TooManyTagsException$resourceName' => '

The name of the resource.

', 'UntagResourceRequest$resourceArn' => '

The ARN of the CloudWatch Logs resource that you\'re removing tags from.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Destination$arn' => '

The ARN of this destination.

', 'LogGroup$arn' => '

The Amazon Resource Name (ARN) of the log group.

', 'LogStream$arn' => '

The Amazon Resource Name (ARN) of the log stream.

', ], ], 'AssociateKmsKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelExportTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExportTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExportTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLogGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLogStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DataAlreadyAcceptedException' => [ 'base' => '

The event was already logged.

PutLogEvents actions are now always accepted and never return DataAlreadyAcceptedException regardless of whether a given batch of log events has already been accepted.

', 'refs' => [], ], 'DataProtectionPolicyDocument' => [ 'base' => NULL, 'refs' => [ 'GetDataProtectionPolicyResponse$policyDocument' => '

The data protection policy document for this log group.

', 'PutDataProtectionPolicyRequest$policyDocument' => '

Specify the data protection policy, in JSON.

This policy must include two JSON blocks:

For an example data protection policy, see the Examples section on this page.

The contents of the two DataIdentifer arrays must match exactly.

In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in policyDocument can be up to 30,720 characters.

', 'PutDataProtectionPolicyResponse$policyDocument' => '

The data protection policy used for this log group.

', ], ], 'DataProtectionStatus' => [ 'base' => NULL, 'refs' => [ 'LogGroup$dataProtectionStatus' => '

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

', ], ], 'Days' => [ 'base' => '

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

', 'refs' => [ 'LogGroup$retentionInDays' => NULL, 'PutRetentionPolicyRequest$retentionInDays' => NULL, ], ], 'DefaultValue' => [ 'base' => NULL, 'refs' => [ 'MetricTransformation$defaultValue' => '

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

', ], ], 'DeleteAccountPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataProtectionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLogGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLogStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMetricFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQueryDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQueryDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSubscriptionFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'Descending' => [ 'base' => NULL, 'refs' => [ 'DescribeLogStreamsRequest$descending' => '

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

', ], ], 'DescribeAccountPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDestinationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDestinationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExportTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExportTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeDestinationsRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default maximum value of 50 items is used.

', 'DescribeExportTasksRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.

', 'DescribeLogGroupsRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.

', 'DescribeLogStreamsRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.

', 'DescribeMetricFiltersRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.

', 'DescribeResourcePoliciesRequest$limit' => '

The maximum number of resource policies to be displayed with one call of this API.

', 'DescribeSubscriptionFiltersRequest$limit' => '

The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.

', ], ], 'DescribeLogGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLogGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLogStreamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLogStreamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricFiltersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricFiltersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueriesMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeQueriesRequest$maxResults' => '

Limits the number of returned queries to the specified number.

', ], ], 'DescribeQueriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueryDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueryDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourcePoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscriptionFiltersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscriptionFiltersResponse' => [ 'base' => NULL, 'refs' => [], ], 'Destination' => [ 'base' => '

Represents a cross-account destination that receives subscription log events.

', 'refs' => [ 'Destinations$member' => NULL, 'PutDestinationResponse$destination' => '

The destination.

', ], ], 'DestinationArn' => [ 'base' => NULL, 'refs' => [ 'PutSubscriptionFilterRequest$destinationArn' => '

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

', 'SubscriptionFilter$destinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', ], ], 'DestinationName' => [ 'base' => NULL, 'refs' => [ 'DeleteDestinationRequest$destinationName' => '

The name of the destination.

', 'DescribeDestinationsRequest$DestinationNamePrefix' => '

The prefix to match. If you don\'t specify a value, no prefix filter is applied.

', 'Destination$destinationName' => '

The name of the destination.

', 'PutDestinationPolicyRequest$destinationName' => '

A name for an existing destination.

', 'PutDestinationRequest$destinationName' => '

A name for the destination.

', ], ], 'Destinations' => [ 'base' => NULL, 'refs' => [ 'DescribeDestinationsResponse$destinations' => '

The destinations.

', ], ], 'Dimensions' => [ 'base' => NULL, 'refs' => [ 'MetricTransformation$dimensions' => '

The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

', ], ], 'DimensionsKey' => [ 'base' => NULL, 'refs' => [ 'Dimensions$key' => NULL, ], ], 'DimensionsValue' => [ 'base' => NULL, 'refs' => [ 'Dimensions$value' => NULL, ], ], 'DisassociateKmsKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'Distribution' => [ 'base' => '

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

', 'refs' => [ 'PutSubscriptionFilterRequest$distribution' => '

The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.

', 'SubscriptionFilter$distribution' => NULL, ], ], 'EncryptionKey' => [ 'base' => NULL, 'refs' => [ 'GetQueryResultsResponse$encryptionKey' => '

If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that\'s used to encrypt the query results when StartQuery stores them.

', ], ], 'EventId' => [ 'base' => NULL, 'refs' => [ 'FilteredLogEvent$eventId' => '

The ID of the event.

', ], ], 'EventMessage' => [ 'base' => NULL, 'refs' => [ 'FilteredLogEvent$message' => '

The data contained in the log event.

', 'InputLogEvent$message' => '

The raw event message. Each log event can be no larger than 256 KB.

', 'MetricFilterMatchRecord$eventMessage' => '

The raw event data.

', 'OutputLogEvent$message' => '

The data contained in the log event.

', 'TestEventMessages$member' => NULL, ], ], 'EventNumber' => [ 'base' => NULL, 'refs' => [ 'MetricFilterMatchRecord$eventNumber' => '

The event number.

', ], ], 'EventsLimit' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsRequest$limit' => '

The maximum number of events to return. The default is 10,000 events.

', 'GetLogEventsRequest$limit' => '

The maximum number of log events returned. If you don\'t specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

', 'StartQueryRequest$limit' => '

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

', ], ], 'ExportDestinationBucket' => [ 'base' => NULL, 'refs' => [ 'CreateExportTaskRequest$destination' => '

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

', 'ExportTask$destination' => '

The name of the S3 bucket to which the log data was exported.

', ], ], 'ExportDestinationPrefix' => [ 'base' => NULL, 'refs' => [ 'CreateExportTaskRequest$destinationPrefix' => '

The prefix used as the start of the key for every object exported. If you don\'t specify a value, the default is exportedlogs.

', 'ExportTask$destinationPrefix' => '

The prefix that was used as the start of Amazon S3 key for every object exported.

', ], ], 'ExportTask' => [ 'base' => '

Represents an export task.

', 'refs' => [ 'ExportTasks$member' => NULL, ], ], 'ExportTaskExecutionInfo' => [ 'base' => '

Represents the status of an export task.

', 'refs' => [ 'ExportTask$executionInfo' => '

Execution information about the export task.

', ], ], 'ExportTaskId' => [ 'base' => NULL, 'refs' => [ 'CancelExportTaskRequest$taskId' => '

The ID of the export task.

', 'CreateExportTaskResponse$taskId' => '

The ID of the export task.

', 'DescribeExportTasksRequest$taskId' => '

The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.

', 'ExportTask$taskId' => '

The ID of the export task.

', ], ], 'ExportTaskName' => [ 'base' => NULL, 'refs' => [ 'CreateExportTaskRequest$taskName' => '

The name of the export task.

', 'ExportTask$taskName' => '

The name of the export task.

', ], ], 'ExportTaskStatus' => [ 'base' => '

Represents the status of an export task.

', 'refs' => [ 'ExportTask$status' => '

The status of the export task.

', ], ], 'ExportTaskStatusCode' => [ 'base' => NULL, 'refs' => [ 'DescribeExportTasksRequest$statusCode' => '

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

', 'ExportTaskStatus$code' => '

The status code of the export task.

', ], ], 'ExportTaskStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ExportTaskStatus$message' => '

The status message related to the status code.

', ], ], 'ExportTasks' => [ 'base' => NULL, 'refs' => [ 'DescribeExportTasksResponse$exportTasks' => '

The export tasks.

', ], ], 'ExtractedValues' => [ 'base' => NULL, 'refs' => [ 'MetricFilterMatchRecord$extractedValues' => '

The values extracted from the event data by the filter.

', ], ], 'Field' => [ 'base' => NULL, 'refs' => [ 'LogGroupField$name' => '

The name of a log field.

', 'LogRecord$key' => NULL, 'ResultField$field' => '

The log event field.

', ], ], 'FilterCount' => [ 'base' => NULL, 'refs' => [ 'LogGroup$metricFilterCount' => '

The number of metric filters.

', ], ], 'FilterLogEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'FilterLogEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'DeleteMetricFilterRequest$filterName' => '

The name of the metric filter.

', 'DeleteSubscriptionFilterRequest$filterName' => '

The name of the subscription filter.

', 'DescribeMetricFiltersRequest$filterNamePrefix' => '

The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.

', 'DescribeSubscriptionFiltersRequest$filterNamePrefix' => '

The prefix to match. If you don\'t specify a value, no prefix filter is applied.

', 'MetricFilter$filterName' => '

The name of the metric filter.

', 'PutMetricFilterRequest$filterName' => '

A name for the metric filter.

', 'PutSubscriptionFilterRequest$filterName' => '

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

', 'SubscriptionFilter$filterName' => '

The name of the subscription filter.

', ], ], 'FilterPattern' => [ 'base' => '

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

', 'refs' => [ 'FilterLogEventsRequest$filterPattern' => '

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

', 'MetricFilter$filterPattern' => NULL, 'PutMetricFilterRequest$filterPattern' => '

A filter pattern for extracting metric data out of ingested log events.

', 'PutSubscriptionFilterRequest$filterPattern' => '

A filter pattern for subscribing to a filtered stream of log events.

', 'SubscriptionFilter$filterPattern' => NULL, 'TestMetricFilterRequest$filterPattern' => NULL, ], ], 'FilteredLogEvent' => [ 'base' => '

Represents a matched event.

', 'refs' => [ 'FilteredLogEvents$member' => NULL, ], ], 'FilteredLogEvents' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsResponse$events' => '

The matched events.

', ], ], 'ForceUpdate' => [ 'base' => NULL, 'refs' => [ 'PutDestinationPolicyRequest$forceUpdate' => '

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

', ], ], 'GetDataProtectionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataProtectionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLogEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLogEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLogGroupFieldsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLogGroupFieldsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLogRecordRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLogRecordResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetQueryResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetQueryResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'IncludeLinkedAccounts' => [ 'base' => NULL, 'refs' => [ 'DescribeLogGroupsRequest$includeLinkedAccounts' => '

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

', ], ], 'InheritedProperties' => [ 'base' => NULL, 'refs' => [ 'LogGroup$inheritedProperties' => '

Displays all the properties that this log group has inherited from account-level settings.

', ], ], 'InheritedProperty' => [ 'base' => NULL, 'refs' => [ 'InheritedProperties$member' => NULL, ], ], 'InputLogEvent' => [ 'base' => '

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

', 'refs' => [ 'InputLogEvents$member' => NULL, ], ], 'InputLogEvents' => [ 'base' => NULL, 'refs' => [ 'PutLogEventsRequest$logEvents' => '

The log events.

', ], ], 'InputLogStreamNames' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsRequest$logStreamNames' => '

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

', ], ], 'Interleaved' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsRequest$interleaved' => '

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

', ], ], 'InvalidOperationException' => [ 'base' => '

The operation is not valid on the specified resource.

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

A parameter is specified incorrectly.

', 'refs' => [], ], 'InvalidSequenceTokenException' => [ 'base' => '

The sequence token is not valid. You can get the correct sequence token in the expectedSequenceToken field in the InvalidSequenceTokenException message.

PutLogEvents actions are now always accepted and never return InvalidSequenceTokenException regardless of receiving an invalid sequence token.

', 'refs' => [], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AssociateKmsKeyRequest$kmsKeyId' => '

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

', 'CreateLogGroupRequest$kmsKeyId' => '

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.

', 'LogGroup$kmsKeyId' => '

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.

', ], ], 'LimitExceededException' => [ 'base' => '

You have reached the maximum number of resources that can be created.

', 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsLogGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsLogGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogEventIndex' => [ 'base' => NULL, 'refs' => [ 'RejectedLogEventsInfo$tooNewLogEventStartIndex' => '

The log events that are too new.

', 'RejectedLogEventsInfo$tooOldLogEventEndIndex' => '

The log events that are dated too far in the past.

', 'RejectedLogEventsInfo$expiredLogEventEndIndex' => '

The expired log events.

', ], ], 'LogGroup' => [ 'base' => '

Represents a log group.

', 'refs' => [ 'LogGroups$member' => NULL, ], ], 'LogGroupField' => [ 'base' => '

The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.

', 'refs' => [ 'LogGroupFieldList$member' => NULL, ], ], 'LogGroupFieldList' => [ 'base' => NULL, 'refs' => [ 'GetLogGroupFieldsResponse$logGroupFields' => '

The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

', ], ], 'LogGroupIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteDataProtectionPolicyRequest$logGroupIdentifier' => '

The name or ARN of the log group that you want to delete the data protection policy for.

', 'DescribeLogStreamsRequest$logGroupIdentifier' => '

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'FilterLogEventsRequest$logGroupIdentifier' => '

Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'GetDataProtectionPolicyRequest$logGroupIdentifier' => '

The name or ARN of the log group that contains the data protection policy that you want to see.

', 'GetDataProtectionPolicyResponse$logGroupIdentifier' => '

The log group name or ARN that you specified in your request.

', 'GetLogEventsRequest$logGroupIdentifier' => '

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'GetLogGroupFieldsRequest$logGroupIdentifier' => '

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'LogGroupIdentifiers$member' => NULL, 'PutDataProtectionPolicyRequest$logGroupIdentifier' => '

Specify either the log group name or log group ARN.

', 'PutDataProtectionPolicyResponse$logGroupIdentifier' => '

The log group name or ARN that you specified in your request.

', ], ], 'LogGroupIdentifiers' => [ 'base' => NULL, 'refs' => [ 'StartQueryRequest$logGroupIdentifiers' => '

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you\'re querying is in a source account and you\'re using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can\'t end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

', ], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'AssociateKmsKeyRequest$logGroupName' => '

The name of the log group.

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can\'t specify both.

', 'CreateExportTaskRequest$logGroupName' => '

The name of the log group.

', 'CreateLogGroupRequest$logGroupName' => '

The name of the log group.

', 'CreateLogStreamRequest$logGroupName' => '

The name of the log group.

', 'DeleteLogGroupRequest$logGroupName' => '

The name of the log group.

', 'DeleteLogStreamRequest$logGroupName' => '

The name of the log group.

', 'DeleteMetricFilterRequest$logGroupName' => '

The name of the log group.

', 'DeleteRetentionPolicyRequest$logGroupName' => '

The name of the log group.

', 'DeleteSubscriptionFilterRequest$logGroupName' => '

The name of the log group.

', 'DescribeLogGroupsRequest$logGroupNamePrefix' => '

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

', 'DescribeLogStreamsRequest$logGroupName' => '

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'DescribeMetricFiltersRequest$logGroupName' => '

The name of the log group.

', 'DescribeQueriesRequest$logGroupName' => '

Limits the returned queries to only those for the specified log group.

', 'DescribeSubscriptionFiltersRequest$logGroupName' => '

The name of the log group.

', 'DisassociateKmsKeyRequest$logGroupName' => '

The name of the log group.

In your DisassociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can\'t specify both.

', 'ExportTask$logGroupName' => '

The name of the log group from which logs data was exported.

', 'FilterLogEventsRequest$logGroupName' => '

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'GetLogEventsRequest$logGroupName' => '

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'GetLogGroupFieldsRequest$logGroupName' => '

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

', 'ListTagsLogGroupRequest$logGroupName' => '

The name of the log group.

', 'LogGroup$logGroupName' => '

The name of the log group.

', 'LogGroupNames$member' => NULL, 'MetricFilter$logGroupName' => '

The name of the log group.

', 'PutLogEventsRequest$logGroupName' => '

The name of the log group.

', 'PutMetricFilterRequest$logGroupName' => '

The name of the log group.

', 'PutRetentionPolicyRequest$logGroupName' => '

The name of the log group.

', 'PutSubscriptionFilterRequest$logGroupName' => '

The name of the log group.

', 'QueryInfo$logGroupName' => '

The name of the log group scanned by this query.

', 'StartQueryRequest$logGroupName' => '

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

', 'SubscriptionFilter$logGroupName' => '

The name of the log group.

', 'TagLogGroupRequest$logGroupName' => '

The name of the log group.

', 'UntagLogGroupRequest$logGroupName' => '

The name of the log group.

', ], ], 'LogGroupNamePattern' => [ 'base' => NULL, 'refs' => [ 'DescribeLogGroupsRequest$logGroupNamePattern' => '

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

', ], ], 'LogGroupNames' => [ 'base' => NULL, 'refs' => [ 'PutQueryDefinitionRequest$logGroupNames' => '

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

', 'QueryDefinition$logGroupNames' => '

If this query definition contains a list of log groups that it is limited to, that list appears here.

', 'StartQueryRequest$logGroupNames' => '

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

', ], ], 'LogGroups' => [ 'base' => NULL, 'refs' => [ 'DescribeLogGroupsResponse$logGroups' => '

The log groups.

If the retentionInDays value is not included for a log group, then that log group\'s events do not expire.

', ], ], 'LogRecord' => [ 'base' => NULL, 'refs' => [ 'GetLogRecordResponse$logRecord' => '

The requested log event, as a JSON string.

', ], ], 'LogRecordPointer' => [ 'base' => NULL, 'refs' => [ 'GetLogRecordRequest$logRecordPointer' => '

The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.

', ], ], 'LogStream' => [ 'base' => '

Represents a log stream, which is a sequence of log events from a single emitter of logs.

', 'refs' => [ 'LogStreams$member' => NULL, ], ], 'LogStreamName' => [ 'base' => NULL, 'refs' => [ 'CreateExportTaskRequest$logStreamNamePrefix' => '

Export only log streams that match the provided prefix. If you don\'t specify a value, no prefix filter is applied.

', 'CreateLogStreamRequest$logStreamName' => '

The name of the log stream.

', 'DeleteLogStreamRequest$logStreamName' => '

The name of the log stream.

', 'DescribeLogStreamsRequest$logStreamNamePrefix' => '

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

', 'FilterLogEventsRequest$logStreamNamePrefix' => '

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

', 'FilteredLogEvent$logStreamName' => '

The name of the log stream to which this event belongs.

', 'GetLogEventsRequest$logStreamName' => '

The name of the log stream.

', 'InputLogStreamNames$member' => NULL, 'LogStream$logStreamName' => '

The name of the log stream.

', 'PutLogEventsRequest$logStreamName' => '

The name of the log stream.

', 'SearchedLogStream$logStreamName' => '

The name of the log stream.

', ], ], 'LogStreamSearchedCompletely' => [ 'base' => NULL, 'refs' => [ 'SearchedLogStream$searchedCompletely' => '

Indicates whether all the events in this log stream were searched.

', ], ], 'LogStreams' => [ 'base' => NULL, 'refs' => [ 'DescribeLogStreamsResponse$logStreams' => '

The log streams.

', ], ], 'MalformedQueryException' => [ 'base' => '

The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see QueryCompileError.

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.

', 'refs' => [], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'QueryCompileError$message' => '

Reserved.

', 'TooManyTagsException$message' => NULL, ], ], 'MetricFilter' => [ 'base' => '

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

', 'refs' => [ 'MetricFilters$member' => NULL, ], ], 'MetricFilterMatchRecord' => [ 'base' => '

Represents a matched event.

', 'refs' => [ 'MetricFilterMatches$member' => NULL, ], ], 'MetricFilterMatches' => [ 'base' => NULL, 'refs' => [ 'TestMetricFilterResponse$matches' => '

The matched events.

', ], ], 'MetricFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricFiltersResponse$metricFilters' => '

The metric filters.

', ], ], 'MetricName' => [ 'base' => '

The name of the CloudWatch metric to which the monitored log information should be published. For example, you might publish to a metric named ErrorCount.

', 'refs' => [ 'DescribeMetricFiltersRequest$metricName' => '

Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

', 'MetricTransformation$metricName' => '

The name of the CloudWatch metric.

', ], ], 'MetricNamespace' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricFiltersRequest$metricNamespace' => '

Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.

', 'MetricTransformation$metricNamespace' => '

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

', ], ], 'MetricTransformation' => [ 'base' => '

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

', 'refs' => [ 'MetricTransformations$member' => NULL, ], ], 'MetricTransformations' => [ 'base' => NULL, 'refs' => [ 'MetricFilter$metricTransformations' => '

The metric transformations.

', 'PutMetricFilterRequest$metricTransformations' => '

A collection of information that defines how metric data gets emitted.

', ], ], 'MetricValue' => [ 'base' => '

The value to publish to the CloudWatch metric. For example, if you\'re counting the occurrences of a term like Error, the value is 1 for each occurrence. If you\'re counting the bytes transferred, the value is the value in the log event.

', 'refs' => [ 'MetricTransformation$metricValue' => '

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

', ], ], 'NextToken' => [ 'base' => '

The token for the next set of items to return. The token expires after 24 hours.

', 'refs' => [ 'DescribeDestinationsRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeDestinationsResponse$nextToken' => NULL, 'DescribeExportTasksRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeExportTasksResponse$nextToken' => NULL, 'DescribeLogGroupsRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLogGroupsResponse$nextToken' => NULL, 'DescribeLogStreamsRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLogStreamsResponse$nextToken' => NULL, 'DescribeMetricFiltersRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeMetricFiltersResponse$nextToken' => NULL, 'DescribeQueriesRequest$nextToken' => NULL, 'DescribeQueriesResponse$nextToken' => NULL, 'DescribeQueryDefinitionsRequest$nextToken' => NULL, 'DescribeQueryDefinitionsResponse$nextToken' => NULL, 'DescribeResourcePoliciesRequest$nextToken' => NULL, 'DescribeResourcePoliciesResponse$nextToken' => NULL, 'DescribeSubscriptionFiltersRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeSubscriptionFiltersResponse$nextToken' => NULL, 'FilterLogEventsRequest$nextToken' => '

The token for the next set of events to return. (You received this token from a previous call.)

', 'FilterLogEventsResponse$nextToken' => '

The token to use when requesting the next set of items. The token expires after 24 hours.

', 'GetLogEventsRequest$nextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'GetLogEventsResponse$nextForwardToken' => '

The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in.

', 'GetLogEventsResponse$nextBackwardToken' => '

The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.

', ], ], 'OperationAbortedException' => [ 'base' => '

Multiple concurrent requests to update the same resource were in conflict.

', 'refs' => [], ], 'OrderBy' => [ 'base' => NULL, 'refs' => [ 'DescribeLogStreamsRequest$orderBy' => '

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

', ], ], 'OutputLogEvent' => [ 'base' => '

Represents a log event.

', 'refs' => [ 'OutputLogEvents$member' => NULL, ], ], 'OutputLogEvents' => [ 'base' => NULL, 'refs' => [ 'GetLogEventsResponse$events' => '

The events.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'LogGroupField$percent' => '

The percentage of log events queried that contained the field.

', ], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$policyDocument' => '

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }

', 'ResourcePolicy$policyDocument' => '

The details of the policy.

', ], ], 'PolicyName' => [ 'base' => NULL, 'refs' => [ 'AccountPolicy$policyName' => '

The name of the account policy.

', 'DeleteAccountPolicyRequest$policyName' => '

The name of the policy to delete.

', 'DeleteResourcePolicyRequest$policyName' => '

The name of the policy to be revoked. This parameter is required.

', 'DescribeAccountPoliciesRequest$policyName' => '

Use this parameter to limit the returned policies to only the policy with the name that you specify.

', 'PutAccountPolicyRequest$policyName' => '

A name for the policy. This must be unique within the account.

', 'PutResourcePolicyRequest$policyName' => '

Name of the new policy. This parameter is required.

', 'ResourcePolicy$policyName' => '

The name of the resource policy.

', ], ], 'PolicyType' => [ 'base' => NULL, 'refs' => [ 'AccountPolicy$policyType' => '

The type of policy for this account policy.

', 'DeleteAccountPolicyRequest$policyType' => '

The type of policy to delete. Currently, the only valid value is DATA_PROTECTION_POLICY.

', 'DescribeAccountPoliciesRequest$policyType' => '

Use this parameter to limit the returned policies to only the policies that match the policy type that you specify. Currently, the only valid value is DATA_PROTECTION_POLICY.

', 'PutAccountPolicyRequest$policyType' => '

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

', ], ], 'PutAccountPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDataProtectionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDataProtectionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDestinationPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutLogEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutLogEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutMetricFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutQueryDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutQueryDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSubscriptionFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueryCharOffset' => [ 'base' => NULL, 'refs' => [ 'QueryCompileErrorLocation$startCharOffset' => '

Reserved.

', 'QueryCompileErrorLocation$endCharOffset' => '

Reserved.

', ], ], 'QueryCompileError' => [ 'base' => '

Reserved.

', 'refs' => [ 'MalformedQueryException$queryCompileError' => NULL, ], ], 'QueryCompileErrorLocation' => [ 'base' => '

Reserved.

', 'refs' => [ 'QueryCompileError$location' => '

Reserved.

', ], ], 'QueryDefinition' => [ 'base' => '

This structure contains details about a saved CloudWatch Logs Insights query definition.

', 'refs' => [ 'QueryDefinitionList$member' => NULL, ], ], 'QueryDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeQueryDefinitionsResponse$queryDefinitions' => '

The list of query definitions that match your request.

', ], ], 'QueryDefinitionName' => [ 'base' => NULL, 'refs' => [ 'DescribeQueryDefinitionsRequest$queryDefinitionNamePrefix' => '

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

', 'PutQueryDefinitionRequest$name' => '

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

', 'QueryDefinition$name' => '

The name of the query definition.

', ], ], 'QueryDefinitionString' => [ 'base' => NULL, 'refs' => [ 'PutQueryDefinitionRequest$queryString' => '

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

', 'QueryDefinition$queryString' => '

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

', ], ], 'QueryId' => [ 'base' => NULL, 'refs' => [ 'DeleteQueryDefinitionRequest$queryDefinitionId' => '

The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

', 'GetQueryResultsRequest$queryId' => '

The ID number of the query.

', 'PutQueryDefinitionRequest$queryDefinitionId' => '

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

', 'PutQueryDefinitionResponse$queryDefinitionId' => '

The ID of the query definition.

', 'QueryDefinition$queryDefinitionId' => '

The unique ID of the query definition.

', 'QueryInfo$queryId' => '

The unique ID number of this query.

', 'StartQueryResponse$queryId' => '

The unique ID of the query.

', 'StopQueryRequest$queryId' => '

The ID number of the query to stop. To find this ID number, use DescribeQueries.

', ], ], 'QueryInfo' => [ 'base' => '

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

', 'refs' => [ 'QueryInfoList$member' => NULL, ], ], 'QueryInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeQueriesResponse$queries' => '

The list of queries that match the request.

', ], ], 'QueryListMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeQueryDefinitionsRequest$maxResults' => '

Limits the number of returned query definitions to the specified number.

', ], ], 'QueryResults' => [ 'base' => NULL, 'refs' => [ 'GetQueryResultsResponse$results' => '

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

', ], ], 'QueryStatistics' => [ 'base' => '

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

', 'refs' => [ 'GetQueryResultsResponse$statistics' => '

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

', ], ], 'QueryStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeQueriesRequest$status' => '

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

', 'GetQueryResultsResponse$status' => '

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

', 'QueryInfo$status' => '

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

', ], ], 'QueryString' => [ 'base' => NULL, 'refs' => [ 'QueryInfo$queryString' => '

The query string used in this query.

', 'StartQueryRequest$queryString' => '

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

', ], ], 'RejectedLogEventsInfo' => [ 'base' => '

Represents the rejected events.

', 'refs' => [ 'PutLogEventsResponse$rejectedLogEventsInfo' => '

The rejected events.

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

The specified resource already exists.

', 'refs' => [], ], 'ResourceIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociateKmsKeyRequest$resourceIdentifier' => '

Specifies the target for this operation. You must specify one of the following:

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can\'t specify both.

', 'DisassociateKmsKeyRequest$resourceIdentifier' => '

Specifies the target for this operation. You must specify one of the following:

In your DisssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can\'t specify both.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource does not exist.

', 'refs' => [], ], 'ResourcePolicies' => [ 'base' => NULL, 'refs' => [ 'DescribeResourcePoliciesResponse$resourcePolicies' => '

The resource policies that exist in this account.

', ], ], 'ResourcePolicy' => [ 'base' => '

A policy enabling one or more entities to put logs to a log group in this account.

', 'refs' => [ 'PutResourcePolicyResponse$resourcePolicy' => '

The new policy.

', 'ResourcePolicies$member' => NULL, ], ], 'ResultField' => [ 'base' => '

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

', 'refs' => [ 'ResultRows$member' => NULL, ], ], 'ResultRows' => [ 'base' => NULL, 'refs' => [ 'QueryResults$member' => NULL, ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'Destination$roleArn' => '

A role for impersonation, used when delivering log events to the target.

', 'PutDestinationRequest$roleArn' => '

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

', 'PutSubscriptionFilterRequest$roleArn' => '

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don\'t need to provide the ARN when you are working with a logical destination for cross-account delivery.

', 'SubscriptionFilter$roleArn' => '

', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'AccountPolicy$scope' => '

The scope of the account policy.

', 'PutAccountPolicyRequest$scope' => '

Currently the only valid value for this parameter is ALL, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of ALL is used.

', ], ], 'SearchedLogStream' => [ 'base' => '

Represents the search status of a log stream.

', 'refs' => [ 'SearchedLogStreams$member' => NULL, ], ], 'SearchedLogStreams' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsResponse$searchedLogStreams' => '

Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

Indicates which log streams have been searched and whether each has been searched completely.

', ], ], 'SequenceToken' => [ 'base' => NULL, 'refs' => [ 'DataAlreadyAcceptedException$expectedSequenceToken' => NULL, 'InvalidSequenceTokenException$expectedSequenceToken' => NULL, 'LogStream$uploadSequenceToken' => '

The sequence token.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don\'t need to obtain uploadSequenceToken to use a PutLogEvents action.

', 'PutLogEventsRequest$sequenceToken' => '

The sequence token obtained from the response of the previous PutLogEvents call.

The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

', 'PutLogEventsResponse$nextSequenceToken' => '

The next sequence token.

This field has been deprecated.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream and you do not need to wait for the response of a previous PutLogEvents action to obtain the nextSequenceToken value.

', ], ], 'ServiceUnavailableException' => [ 'base' => '

The service cannot complete the request.

', 'refs' => [], ], 'StandardUnit' => [ 'base' => NULL, 'refs' => [ 'MetricTransformation$unit' => '

The unit to assign to the metric. If you omit this, the unit is set as None.

', ], ], 'StartFromHead' => [ 'base' => NULL, 'refs' => [ 'GetLogEventsRequest$startFromHead' => '

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

', ], ], 'StartQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatsValue' => [ 'base' => NULL, 'refs' => [ 'QueryStatistics$recordsMatched' => '

The number of log events that matched the query string.

', 'QueryStatistics$recordsScanned' => '

The total number of log events scanned during the query.

', 'QueryStatistics$bytesScanned' => '

The total number of bytes in the log events scanned during the query.

', ], ], 'StopQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'StoredBytes' => [ 'base' => NULL, 'refs' => [ 'LogGroup$storedBytes' => '

The number of bytes stored.

', 'LogStream$storedBytes' => '

The number of bytes stored.

Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

', ], ], 'SubscriptionFilter' => [ 'base' => '

Represents a subscription filter.

', 'refs' => [ 'SubscriptionFilters$member' => NULL, ], ], 'SubscriptionFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeSubscriptionFiltersResponse$subscriptionFilters' => '

The subscription filters.

', ], ], 'Success' => [ 'base' => NULL, 'refs' => [ 'DeleteQueryDefinitionResponse$success' => '

A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.

', 'StopQueryResponse$success' => '

This is true if the query was stopped by the StopQuery operation.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The list of tag keys to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'UntagLogGroupRequest$tags' => '

The tag keys. The corresponding tags are removed from the log group.

', ], ], 'TagLogGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateLogGroupRequest$tags' => '

The key-value pairs to use for the tags.

You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

', 'ListTagsForResourceResponse$tags' => '

The list of tags associated with the requested resource.>

', 'ListTagsLogGroupResponse$tags' => '

The tags for the log group.

', 'PutDestinationRequest$tags' => '

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

', 'TagLogGroupRequest$tags' => '

The key-value pairs to use for the tags.

', 'TagResourceRequest$tags' => '

The list of key-value pairs to associate with the resource.

', ], ], 'TargetArn' => [ 'base' => NULL, 'refs' => [ 'Destination$targetArn' => '

The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

', 'PutDestinationRequest$targetArn' => '

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

', ], ], 'TestEventMessages' => [ 'base' => NULL, 'refs' => [ 'TestMetricFilterRequest$logEventMessages' => '

The log event messages to test.

', ], ], 'TestMetricFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestMetricFilterResponse' => [ 'base' => NULL, 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccountPolicy$lastUpdatedTime' => '

The date and time that this policy was most recently updated.

', 'CreateExportTaskRequest$from' => '

The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

', 'CreateExportTaskRequest$to' => '

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

You must specify a time that is not earlier than when this log group was created.

', 'Destination$creationTime' => '

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'ExportTask$from' => '

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.

', 'ExportTask$to' => '

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

', 'ExportTaskExecutionInfo$creationTime' => '

The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'ExportTaskExecutionInfo$completionTime' => '

The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'FilterLogEventsRequest$startTime' => '

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

', 'FilterLogEventsRequest$endTime' => '

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

', 'FilteredLogEvent$timestamp' => '

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'FilteredLogEvent$ingestionTime' => '

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'GetDataProtectionPolicyResponse$lastUpdatedTime' => '

The date and time that this policy was most recently updated.

', 'GetLogEventsRequest$startTime' => '

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

', 'GetLogEventsRequest$endTime' => '

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

', 'GetLogGroupFieldsRequest$time' => '

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

', 'InputLogEvent$timestamp' => '

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'LogGroup$creationTime' => '

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'LogStream$creationTime' => '

The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'LogStream$firstEventTimestamp' => '

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'LogStream$lastEventTimestamp' => '

The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

', 'LogStream$lastIngestionTime' => '

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.

', 'MetricFilter$creationTime' => '

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'OutputLogEvent$timestamp' => '

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'OutputLogEvent$ingestionTime' => '

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'PutDataProtectionPolicyResponse$lastUpdatedTime' => '

The date and time that this policy was most recently updated.

', 'QueryDefinition$lastModified' => '

The date that the query definition was most recently modified.

', 'QueryInfo$createTime' => '

The date and time that this query was created.

', 'ResourcePolicy$lastUpdatedTime' => '

Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', 'StartQueryRequest$startTime' => '

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

', 'StartQueryRequest$endTime' => '

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

', 'SubscriptionFilter$creationTime' => '

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'ExtractedValues$key' => NULL, ], ], 'TooManyTagsException' => [ 'base' => '

A resource can have no more than 50 tags.

', 'refs' => [], ], 'Unmask' => [ 'base' => NULL, 'refs' => [ 'FilterLogEventsRequest$unmask' => '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

', 'GetLogEventsRequest$unmask' => '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

', 'GetLogRecordRequest$unmask' => '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

', ], ], 'UnrecognizedClientException' => [ 'base' => '

The most likely cause is an Amazon Web Services access key ID or secret key that\'s not valid.

', 'refs' => [], ], 'UntagLogGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'ExtractedValues$value' => NULL, 'LogRecord$value' => NULL, 'ResultField$value' => '

The value of this field.

', ], ], ],];