String logGroupName
The name of the log group.
String kmsKeyId
The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).
String taskId
The ID of the export task.
String taskName
The name of the export task.
String logGroupName
The name of the log group.
String logStreamNamePrefix
Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
Long 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.
Long 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.
String destination
The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
String 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
.
String taskId
The ID of the export task.
String logGroupName
The name of the log group.
String kmsKeyId
The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).
SdkInternalMap<K,V> tags
The key-value pairs to use for the tags.
String expectedSequenceToken
String destinationName
The name of the destination.
String logGroupName
The name of the log group.
String policyName
The name of the policy to be revoked. This parameter is required.
String logGroupName
The name of the log group.
String destinationNamePrefix
The prefix to match. If you don't specify a value, no prefix filter is applied.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
SdkInternalList<T> destinations
The destinations.
String nextToken
String taskId
The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.
String statusCode
The status code of the export task. Specifying a status code filters the results to zero or more export tasks.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
SdkInternalList<T> exportTasks
The export tasks.
String nextToken
String logGroupNamePrefix
The prefix to match.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
SdkInternalList<T> logGroups
The log groups.
String nextToken
String logGroupName
The name of the log group.
String logStreamNamePrefix
The prefix to match.
If orderBy
is LastEventTime
,you cannot specify this parameter.
String 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 may take longer in some rare situations.
Boolean 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.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
SdkInternalList<T> logStreams
The log streams.
String nextToken
String logGroupName
The name of the log group.
String filterNamePrefix
The prefix to match.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
String 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.
String 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.
SdkInternalList<T> metricFilters
The metric filters.
String nextToken
String logGroupName
Limits the returned queries to only those for the specified log group.
String status
Limits the returned queries to only those that have the specified status. Valid values are Cancelled
, Complete
, Failed
, Running
, and Scheduled
.
Integer maxResults
Limits the number of returned queries to the specified number.
String nextToken
SdkInternalList<T> queries
The list of queries that match the request.
String nextToken
SdkInternalList<T> resourcePolicies
The resource policies that exist in this account.
String nextToken
String logGroupName
The name of the log group.
String filterNamePrefix
The prefix to match. If you don't specify a value, no prefix filter is applied.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer limit
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
SdkInternalList<T> subscriptionFilters
The subscription filters.
String nextToken
String destinationName
The name of the destination.
String targetArn
The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).
String roleArn
A role for impersonation, used when delivering log events to the target.
String accessPolicy
An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
String arn
The ARN of this destination.
Long creationTime
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String logGroupName
The name of the log group.
String taskId
The ID of the export task.
String taskName
The name of the export task.
String logGroupName
The name of the log group from which logs data was exported.
Long 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.
Long 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.
String destination
The name of Amazon S3 bucket to which the log data was exported.
String destinationPrefix
The prefix that was used as the start of Amazon S3 key for every object exported.
ExportTaskStatus status
The status of the export task.
ExportTaskExecutionInfo executionInfo
Execution info about the export task.
String logStreamName
The name of the log stream to which this event belongs.
Long timestamp
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String message
The data contained in the log event.
Long ingestionTime
The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String eventId
The ID of the event.
String logGroupName
The name of the log group to search.
SdkInternalList<T> 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.
String 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.
Long 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.
Long 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.
String filterPattern
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
String nextToken
The token for the next set of events to return. (You received this token from a previous call.)
Integer limit
The maximum number of events to return. The default is 10,000 events.
Boolean interleaved
If the value is true, the operation makes a best effort 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. The default is false.
IMPORTANT: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.
SdkInternalList<T> events
The matched events.
SdkInternalList<T> searchedLogStreams
Indicates which log streams have been searched and whether each has been searched completely.
String nextToken
The token to use when requesting the next set of items. The token expires after 24 hours.
String logGroupName
The name of the log group.
String logStreamName
The name of the log stream.
Long 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.
Long 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.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Using this token works only when you specify true
for startFromHead
.
Integer limit
The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
Boolean 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 nextToken
in this operation, you must specify true
for
startFromHead
.
SdkInternalList<T> events
The events.
String 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 will return the same token you passed in.
String nextBackwardToken
The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in.
String logGroupName
The name of the log group to search.
Long 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 past 15 minutes are queried.
The time
value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00
UTC.
SdkInternalList<T> 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.
String 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.
SdkInternalMap<K,V> logRecord
The requested log event, as a JSON string.
String queryId
The ID number of the query.
SdkInternalList<T> 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 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 log events that were scanned.
String 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 15 minutes of execution. To avoid having your queries time out, reduce the time range being searched, or partition your query into a number of queries.
String expectedSequenceToken
String logGroupName
The name of the log group.
SdkInternalMap<K,V> tags
The tags for the log group.
String logGroupName
The name of the log group.
Long creationTime
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Integer retentionInDays
Integer metricFilterCount
The number of metric filters.
String arn
The Amazon Resource Name (ARN) of the log group.
Long storedBytes
The number of bytes stored.
String kmsKeyId
The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
String logStreamName
The name of the log stream.
Long creationTime
The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Long firstEventTimestamp
The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Long 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 may take longer in some
rare situations.
Long lastIngestionTime
The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String uploadSequenceToken
The sequence token.
String arn
The Amazon Resource Name (ARN) of the log stream.
Long storedBytes
The number of bytes stored.
IMPORTANT:On June 17, 2019, this parameter was deprecated 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.
QueryCompileError queryCompileError
String filterName
The name of the metric filter.
String filterPattern
SdkInternalList<T> metricTransformations
The metric transformations.
Long creationTime
The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String logGroupName
The name of the log group.
Long eventNumber
The event number.
String eventMessage
The raw event data.
SdkInternalMap<K,V> extractedValues
The values extracted from the event data by the filter.
String metricName
The name of the CloudWatch metric.
String metricNamespace
The namespace of the CloudWatch metric.
String metricValue
The value to publish to the CloudWatch metric when a filter pattern matches a log event.
Double defaultValue
(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
Long timestamp
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String message
The data contained in the log event.
Long ingestionTime
The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String destinationName
A name for the destination.
String targetArn
The ARN of an Amazon Kinesis stream to which to deliver matching log events.
String roleArn
The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.
Destination destination
The destination.
String logGroupName
The name of the log group.
String logStreamName
The name of the log stream.
SdkInternalList<T> logEvents
The log events.
String sequenceToken
The sequence token obtained from the response of the previous PutLogEvents
call. An upload in a
newly created log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same
value for sequenceToken
, both calls may be successful, or one may be rejected.
String nextSequenceToken
The next sequence token.
RejectedLogEventsInfo rejectedLogEventsInfo
The rejected events.
String logGroupName
The name of the log group.
String filterName
A name for the metric filter.
String filterPattern
A filter pattern for extracting metric data out of ingested log events.
SdkInternalList<T> metricTransformations
A collection of information that defines how metric data gets emitted.
String policyName
Name of the new policy. This parameter is required.
String 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.
{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }
ResourcePolicy resourcePolicy
The new policy.
String logGroupName
The name of the log group.
String filterName
A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in
filterName
. Otherwise, the call fails because you cannot associate a second filter with a log group.
To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.
String filterPattern
A filter pattern for subscribing to a filtered stream of log events.
String destinationArn
The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.
An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.
String 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.
String 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 stream.
QueryCompileErrorLocation location
Reserved.
String message
Reserved.
String queryId
The unique ID number of this query.
String queryString
The query string used in this query.
String status
The status of this query. Possible values are Cancelled
, Complete
, Failed
,
Running
, Scheduled
, and Unknown
.
Long createTime
The date and time that this query was created.
String logGroupName
The name of the log group scanned by this query.
String logGroupName
The log group on which to perform the query.
A StartQuery
operation must include a logGroupNames
or a logGroupName
parameter, but not both.
SdkInternalList<T> logGroupNames
The list of log groups to be queried. You can include up to 20 log groups.
A StartQuery
operation must include a logGroupNames
or a logGroupName
parameter, but not both.
Long 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.
Long 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.
String queryString
The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
Integer 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.
String queryId
The unique ID of the query.
String queryId
The ID number of the query to stop. If necessary, you can use DescribeQueries
to find this ID
number.
Boolean success
This is true if the query was stopped by the StopQuery
operation.
String filterName
The name of the subscription filter.
String logGroupName
The name of the log group.
String filterPattern
String destinationArn
The Amazon Resource Name (ARN) of the destination.
String roleArn
String distribution
Long creationTime
The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String logGroupName
The name of the log group.
SdkInternalMap<K,V> tags
The key-value pairs to use for the tags.
String filterPattern
SdkInternalList<T> logEventMessages
The log event messages to test.
SdkInternalList<T> matches
The matched events.
String logGroupName
The name of the log group.
SdkInternalList<T> tags
The tag keys. The corresponding tags are removed from the log group.
Copyright © 2020. All rights reserved.