1517 lines
64 KiB
JSON
1517 lines
64 KiB
JSON
{
|
|
"version":"2.0",
|
|
"metadata":{
|
|
"apiVersion":"2014-03-28",
|
|
"endpointPrefix":"logs",
|
|
"jsonVersion":"1.1",
|
|
"protocol":"json",
|
|
"serviceFullName":"Amazon CloudWatch Logs",
|
|
"signatureVersion":"v4",
|
|
"targetPrefix":"Logs_20140328"
|
|
},
|
|
"operations":{
|
|
"CancelExportTask":{
|
|
"name":"CancelExportTask",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CancelExportTaskRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidOperationException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state.</p>"
|
|
},
|
|
"CreateExportTask":{
|
|
"name":"CreateExportTask",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CreateExportTaskRequest"},
|
|
"output":{"shape":"CreateExportTaskResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ResourceAlreadyExistsException"}
|
|
],
|
|
"documentation":"<p>Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.</p> <p>This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account.</p> <p>You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.</p>"
|
|
},
|
|
"CreateLogGroup":{
|
|
"name":"CreateLogGroup",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CreateLogGroupRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceAlreadyExistsException"},
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.</p> <p>You must use the following guidelines when naming a log group:</p> <ul> <li> <p>Log group names can be between 1 and 512 characters long.</p> </li> <li> <p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</p> </li> </ul>"
|
|
},
|
|
"CreateLogStream":{
|
|
"name":"CreateLogStream",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CreateLogStreamRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceAlreadyExistsException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.</p> <p>You must use the following guidelines when naming a log stream:</p> <ul> <li> <p>Log stream names can be between 1 and 512 characters long.</p> </li> <li> <p>The ':' colon character is not allowed.</p> </li> </ul>"
|
|
},
|
|
"DeleteDestination":{
|
|
"name":"DeleteDestination",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteDestinationRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.</p>"
|
|
},
|
|
"DeleteLogGroup":{
|
|
"name":"DeleteLogGroup",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteLogGroupRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.</p>"
|
|
},
|
|
"DeleteLogStream":{
|
|
"name":"DeleteLogStream",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteLogStreamRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes a log stream and permanently deletes all the archived log events associated with it.</p>"
|
|
},
|
|
"DeleteMetricFilter":{
|
|
"name":"DeleteMetricFilter",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteMetricFilterRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes a metric filter associated with the specified log group.</p>"
|
|
},
|
|
"DeleteRetentionPolicy":{
|
|
"name":"DeleteRetentionPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteRetentionPolicyRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.</p>"
|
|
},
|
|
"DeleteSubscriptionFilter":{
|
|
"name":"DeleteSubscriptionFilter",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteSubscriptionFilterRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Deletes a subscription filter associated with the specified log group.</p>"
|
|
},
|
|
"DescribeDestinations":{
|
|
"name":"DescribeDestinations",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeDestinationsRequest"},
|
|
"output":{"shape":"DescribeDestinationsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.</p> <p>By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"DescribeExportTasks":{
|
|
"name":"DescribeExportTasks",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeExportTasksRequest"},
|
|
"output":{"shape":"DescribeExportTasksResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>.</p> <p>By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"DescribeLogGroups":{
|
|
"name":"DescribeLogGroups",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeLogGroupsRequest"},
|
|
"output":{"shape":"DescribeLogGroupsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.</p> <p>By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"DescribeLogStreams":{
|
|
"name":"DescribeLogStreams",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeLogStreamsRequest"},
|
|
"output":{"shape":"DescribeLogStreamsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.</p> <p>By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code>limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.</p>"
|
|
},
|
|
"DescribeMetricFilters":{
|
|
"name":"DescribeMetricFilters",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeMetricFiltersRequest"},
|
|
"output":{"shape":"DescribeMetricFiltersResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.</p> <p>By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"DescribeSubscriptionFilters":{
|
|
"name":"DescribeSubscriptionFilters",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeSubscriptionFiltersRequest"},
|
|
"output":{"shape":"DescribeSubscriptionFiltersResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.</p> <p>By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code>nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"FilterLogEvents":{
|
|
"name":"FilterLogEvents",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"FilterLogEventsRequest"},
|
|
"output":{"shape":"FilterLogEventsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code>timestamp</code>. You can limit the streams searched to an explicit list of <code>logStreamNames</code>.</p> <p>By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code>nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code>searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code>limit</code> parameter in the request can be used to specify the maximum number of events to return in a page.</p>"
|
|
},
|
|
"GetLogEvents":{
|
|
"name":"GetLogEvents",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetLogEventsRequest"},
|
|
"output":{"shape":"GetLogEventsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code>timestamp</code>.</p> <p>By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code>nextForwardToken</code> and a <code>nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code>GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code>limit</code> parameter in the request.</p>"
|
|
},
|
|
"PutDestination":{
|
|
"name":"PutDestination",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutDestinationRequest"},
|
|
"output":{"shape":"PutDestinationResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code>PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.</p> <p>A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination.</p>"
|
|
},
|
|
"PutDestinationPolicy":{
|
|
"name":"PutDestinationPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutDestinationPolicyRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html\">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination.</p>"
|
|
},
|
|
"PutLogEvents":{
|
|
"name":"PutLogEvents",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutLogEventsRequest"},
|
|
"output":{"shape":"PutLogEventsResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"InvalidSequenceTokenException"},
|
|
{"shape":"DataAlreadyAcceptedException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Uploads a batch of log events to the specified log stream.</p> <p>Every PutLogEvents request must include the <code>sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code>sequenceToken</code>. You can also get the <code>sequenceToken</code> using <a>DescribeLogStreams</a>.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their <code>timestamp</code>.</p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</p> </li> </ul>"
|
|
},
|
|
"PutMetricFilter":{
|
|
"name":"PutMetricFilter",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutMetricFilterRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code>PutLogEvents</code> requests.</p> <p>The maximum number of metric filters that can be associated with a log group is 100.</p>"
|
|
},
|
|
"PutRetentionPolicy":{
|
|
"name":"PutRetentionPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutRetentionPolicyRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.</p>"
|
|
},
|
|
"PutSubscriptionFilter":{
|
|
"name":"PutSubscriptionFilter",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutSubscriptionFilterRequest"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"OperationAbortedException"},
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code>PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.</p> </li> </ul> <p>Currently there can only be one subscription filter associated with a log group.</p>"
|
|
},
|
|
"TestMetricFilter":{
|
|
"name":"TestMetricFilter",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"TestMetricFilterRequest"},
|
|
"output":{"shape":"TestMetricFilterResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ServiceUnavailableException"}
|
|
],
|
|
"documentation":"<p>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.</p>"
|
|
}
|
|
},
|
|
"shapes":{
|
|
"AccessPolicy":{
|
|
"type":"string",
|
|
"min":1
|
|
},
|
|
"Arn":{"type":"string"},
|
|
"CancelExportTaskRequest":{
|
|
"type":"structure",
|
|
"required":["taskId"],
|
|
"members":{
|
|
"taskId":{
|
|
"shape":"ExportTaskId",
|
|
"documentation":"<p>Id of the export task to cancel.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateExportTaskRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"from",
|
|
"to",
|
|
"destination"
|
|
],
|
|
"members":{
|
|
"taskName":{
|
|
"shape":"ExportTaskName",
|
|
"documentation":"<p>The name of the export task.</p>"
|
|
},
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to export.</p>"
|
|
},
|
|
"logStreamNamePrefix":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.</p>"
|
|
},
|
|
"from":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the start time of the range for the request. Events with a timestamp prior to this time will not be exported.</p>"
|
|
},
|
|
"to":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the end time of the range for the request. Events with a timestamp later than this time will not be exported.</p>"
|
|
},
|
|
"destination":{
|
|
"shape":"ExportDestinationBucket",
|
|
"documentation":"<p>Name of Amazon S3 bucket to which the log data will be exported.</p> <p> <b>Note:</b> Only buckets in the same AWS region are supported.</p>"
|
|
},
|
|
"destinationPrefix":{
|
|
"shape":"ExportDestinationPrefix",
|
|
"documentation":"<p>Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateExportTaskResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"taskId":{
|
|
"shape":"ExportTaskId",
|
|
"documentation":"<p>Id of the export task that got created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateLogGroupRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to create.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateLogStreamRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"logStreamName"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group under which the log stream is to be created.</p>"
|
|
},
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream to create.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DataAlreadyAcceptedException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"expectedSequenceToken":{"shape":"SequenceToken"}
|
|
},
|
|
"exception":true
|
|
},
|
|
"Days":{
|
|
"type":"integer",
|
|
"documentation":"<p>Specifies the number of days you want to retain 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, 1827, 3653.</p>"
|
|
},
|
|
"DefaultValue":{"type":"double"},
|
|
"DeleteDestinationRequest":{
|
|
"type":"structure",
|
|
"required":["destinationName"],
|
|
"members":{
|
|
"destinationName":{
|
|
"shape":"DestinationName",
|
|
"documentation":"<p>The name of destination to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteLogGroupRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteLogStreamRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"logStreamName"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group under which the log stream to delete belongs.</p>"
|
|
},
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteMetricFilterRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"filterName"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group that is associated with the metric filter to delete.</p>"
|
|
},
|
|
"filterName":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>The name of the metric filter to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRetentionPolicyRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group that is associated with the retention policy to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteSubscriptionFilterRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"filterName"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group that is associated with the subscription filter to delete.</p>"
|
|
},
|
|
"filterName":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>The name of the subscription filter to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Descending":{"type":"boolean"},
|
|
"DescribeDestinationsRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"DestinationNamePrefix":{
|
|
"shape":"DestinationName",
|
|
"documentation":"<p>Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.</p>"
|
|
},
|
|
"nextToken":{"shape":"NextToken"},
|
|
"limit":{"shape":"DescribeLimit"}
|
|
}
|
|
},
|
|
"DescribeDestinationsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"destinations":{"shape":"Destinations"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"DescribeExportTasksRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"taskId":{
|
|
"shape":"ExportTaskId",
|
|
"documentation":"<p>Export task that matches the specified task Id will be returned. This can result in zero or one export task.</p>"
|
|
},
|
|
"statusCode":{
|
|
"shape":"ExportTaskStatusCode",
|
|
"documentation":"<p>All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code>DescribeExportTasks</code> request.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"DescribeLimit",
|
|
"documentation":"<p>The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeExportTasksResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"exportTasks":{"shape":"ExportTasks"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"DescribeLimit":{
|
|
"type":"integer",
|
|
"documentation":"<p>The maximum number of results to return.</p>",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"DescribeLogGroupsRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logGroupNamePrefix":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code>DescribeLogGroups</code> request.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"DescribeLimit",
|
|
"documentation":"<p>The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeLogGroupsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logGroups":{"shape":"LogGroups"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"DescribeLogStreamsRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The log group name for which log streams are to be listed.</p>"
|
|
},
|
|
"logStreamNamePrefix":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.</p>"
|
|
},
|
|
"orderBy":{
|
|
"shape":"OrderBy",
|
|
"documentation":"<p>Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.</p>"
|
|
},
|
|
"descending":{
|
|
"shape":"Descending",
|
|
"documentation":"<p>If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code>DescribeLogStreams</code> request.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"DescribeLimit",
|
|
"documentation":"<p>The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeLogStreamsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logStreams":{"shape":"LogStreams"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"DescribeMetricFiltersRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The log group name for which metric filters are to be listed.</p>"
|
|
},
|
|
"filterNamePrefix":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code>DescribeMetricFilters</code> request.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"DescribeLimit",
|
|
"documentation":"<p>The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeMetricFiltersResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"metricFilters":{"shape":"MetricFilters"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"DescribeSubscriptionFiltersRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The log group name for which subscription filters are to be listed.</p>"
|
|
},
|
|
"filterNamePrefix":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.</p>"
|
|
},
|
|
"nextToken":{"shape":"NextToken"},
|
|
"limit":{"shape":"DescribeLimit"}
|
|
}
|
|
},
|
|
"DescribeSubscriptionFiltersResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"subscriptionFilters":{"shape":"SubscriptionFilters"},
|
|
"nextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"Destination":{
|
|
"type":"structure",
|
|
"members":{
|
|
"destinationName":{
|
|
"shape":"DestinationName",
|
|
"documentation":"<p>Name of the destination.</p>"
|
|
},
|
|
"targetArn":{
|
|
"shape":"TargetArn",
|
|
"documentation":"<p>ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).</p>"
|
|
},
|
|
"roleArn":{
|
|
"shape":"RoleArn",
|
|
"documentation":"<p>A role for impersonation for delivering log events to the target.</p>"
|
|
},
|
|
"accessPolicy":{
|
|
"shape":"AccessPolicy",
|
|
"documentation":"<p>An IAM policy document that governs which AWS accounts can create subscription filters against this destination.</p>"
|
|
},
|
|
"arn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>ARN of this destination.</p>"
|
|
},
|
|
"creationTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A cross account destination that is the recipient of subscription log events.</p>"
|
|
},
|
|
"DestinationArn":{
|
|
"type":"string",
|
|
"min":1
|
|
},
|
|
"DestinationName":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1,
|
|
"pattern":"[^:*]*"
|
|
},
|
|
"Destinations":{
|
|
"type":"list",
|
|
"member":{"shape":"Destination"}
|
|
},
|
|
"EventId":{"type":"string"},
|
|
"EventMessage":{
|
|
"type":"string",
|
|
"min":1
|
|
},
|
|
"EventNumber":{"type":"long"},
|
|
"EventsLimit":{
|
|
"type":"integer",
|
|
"documentation":"<p>The maximum number of events to return.</p>",
|
|
"max":10000,
|
|
"min":1
|
|
},
|
|
"ExportDestinationBucket":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1
|
|
},
|
|
"ExportDestinationPrefix":{"type":"string"},
|
|
"ExportTask":{
|
|
"type":"structure",
|
|
"members":{
|
|
"taskId":{
|
|
"shape":"ExportTaskId",
|
|
"documentation":"<p>Id of the export task.</p>"
|
|
},
|
|
"taskName":{
|
|
"shape":"ExportTaskName",
|
|
"documentation":"<p>The name of the export task.</p>"
|
|
},
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group from which logs data was exported.</p>"
|
|
},
|
|
"from":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported.</p>"
|
|
},
|
|
"to":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.</p>"
|
|
},
|
|
"destination":{
|
|
"shape":"ExportDestinationBucket",
|
|
"documentation":"<p>Name of Amazon S3 bucket to which the log data was exported.</p>"
|
|
},
|
|
"destinationPrefix":{
|
|
"shape":"ExportDestinationPrefix",
|
|
"documentation":"<p>Prefix that was used as the start of Amazon S3 key for every object exported.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"ExportTaskStatus",
|
|
"documentation":"<p>Status of the export task.</p>"
|
|
},
|
|
"executionInfo":{
|
|
"shape":"ExportTaskExecutionInfo",
|
|
"documentation":"<p>Execution info about the export task.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Represents an export task.</p>"
|
|
},
|
|
"ExportTaskExecutionInfo":{
|
|
"type":"structure",
|
|
"members":{
|
|
"creationTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time when the export task got created.</p>"
|
|
},
|
|
"completionTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time when the export task got completed.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Represents the status of an export task.</p>"
|
|
},
|
|
"ExportTaskId":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1
|
|
},
|
|
"ExportTaskName":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1
|
|
},
|
|
"ExportTaskStatus":{
|
|
"type":"structure",
|
|
"members":{
|
|
"code":{
|
|
"shape":"ExportTaskStatusCode",
|
|
"documentation":"<p>Status code of the export task.</p>"
|
|
},
|
|
"message":{
|
|
"shape":"ExportTaskStatusMessage",
|
|
"documentation":"<p>Status message related to the <code>code</code>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Represents the status of an export task.</p>"
|
|
},
|
|
"ExportTaskStatusCode":{
|
|
"type":"string",
|
|
"enum":[
|
|
"CANCELLED",
|
|
"COMPLETED",
|
|
"FAILED",
|
|
"PENDING",
|
|
"PENDING_CANCEL",
|
|
"RUNNING"
|
|
]
|
|
},
|
|
"ExportTaskStatusMessage":{"type":"string"},
|
|
"ExportTasks":{
|
|
"type":"list",
|
|
"member":{"shape":"ExportTask"},
|
|
"documentation":"<p>A list of export tasks.</p>"
|
|
},
|
|
"ExtractedValues":{
|
|
"type":"map",
|
|
"key":{"shape":"Token"},
|
|
"value":{"shape":"Value"}
|
|
},
|
|
"FilterCount":{
|
|
"type":"integer",
|
|
"documentation":"<p>The number of metric filters associated with the log group.</p>"
|
|
},
|
|
"FilterLogEventsRequest":{
|
|
"type":"structure",
|
|
"required":["logGroupName"],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to query.</p>"
|
|
},
|
|
"logStreamNames":{
|
|
"shape":"InputLogStreamNames",
|
|
"documentation":"<p>Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.</p>"
|
|
},
|
|
"startTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.</p>"
|
|
},
|
|
"endTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.</p>"
|
|
},
|
|
"filterPattern":{
|
|
"shape":"FilterPattern",
|
|
"documentation":"<p>A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A pagination token obtained from a <code>FilterLogEvents</code> response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"EventsLimit",
|
|
"documentation":"<p>The maximum number of events to return in a page of results. Default is 10,000 events.</p>"
|
|
},
|
|
"interleaved":{
|
|
"shape":"Interleaved",
|
|
"documentation":"<p>If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.</p>"
|
|
}
|
|
}
|
|
},
|
|
"FilterLogEventsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"events":{
|
|
"shape":"FilteredLogEvents",
|
|
"documentation":"<p>A list of <code>FilteredLogEvent</code> objects representing the matched events from the request.</p>"
|
|
},
|
|
"searchedLogStreams":{
|
|
"shape":"SearchedLogStreams",
|
|
"documentation":"<p>A list of <code>SearchedLogStream</code> objects indicating which log streams have been searched in this request and whether each has been searched completely or still has more to be paginated.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A pagination token obtained from a <code>FilterLogEvents</code> response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.</p>"
|
|
}
|
|
}
|
|
},
|
|
"FilterName":{
|
|
"type":"string",
|
|
"documentation":"<p>A name for a metric or subscription filter.</p>",
|
|
"max":512,
|
|
"min":1,
|
|
"pattern":"[^:*]*"
|
|
},
|
|
"FilterPattern":{
|
|
"type":"string",
|
|
"documentation":"<p>A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.</p>",
|
|
"max":1024,
|
|
"min":0
|
|
},
|
|
"FilteredLogEvent":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream this event belongs to.</p>"
|
|
},
|
|
"timestamp":{"shape":"Timestamp"},
|
|
"message":{
|
|
"shape":"EventMessage",
|
|
"documentation":"<p>The data contained in the log event.</p>"
|
|
},
|
|
"ingestionTime":{"shape":"Timestamp"},
|
|
"eventId":{
|
|
"shape":"EventId",
|
|
"documentation":"<p>A unique identifier for this event.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Represents a matched event from a <code>FilterLogEvents</code> request.</p>"
|
|
},
|
|
"FilteredLogEvents":{
|
|
"type":"list",
|
|
"member":{"shape":"FilteredLogEvent"},
|
|
"documentation":"<p>A list of matched <code>FilteredLogEvent</code> objects returned from a <code>FilterLogEvents</code> request.</p>"
|
|
},
|
|
"GetLogEventsRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"logStreamName"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to query.</p>"
|
|
},
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream to query.</p>"
|
|
},
|
|
"startTime":{"shape":"Timestamp"},
|
|
"endTime":{"shape":"Timestamp"},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the <code>nextForwardToken</code> or <code>nextBackwardToken</code> fields in the response of the previous <code>GetLogEvents</code> request.</p>"
|
|
},
|
|
"limit":{
|
|
"shape":"EventsLimit",
|
|
"documentation":"<p>The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.</p>"
|
|
},
|
|
"startFromHead":{
|
|
"shape":"StartFromHead",
|
|
"documentation":"<p>If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetLogEventsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"events":{"shape":"OutputLogEvents"},
|
|
"nextForwardToken":{"shape":"NextToken"},
|
|
"nextBackwardToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"InputLogEvent":{
|
|
"type":"structure",
|
|
"required":[
|
|
"timestamp",
|
|
"message"
|
|
],
|
|
"members":{
|
|
"timestamp":{"shape":"Timestamp"},
|
|
"message":{"shape":"EventMessage"}
|
|
},
|
|
"documentation":"<p>A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message.</p>"
|
|
},
|
|
"InputLogEvents":{
|
|
"type":"list",
|
|
"member":{"shape":"InputLogEvent"},
|
|
"documentation":"<p>A list of log events belonging to a log stream.</p>",
|
|
"max":10000,
|
|
"min":1
|
|
},
|
|
"InputLogStreamNames":{
|
|
"type":"list",
|
|
"member":{"shape":"LogStreamName"},
|
|
"documentation":"<p>A list of log stream names.</p>",
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"Interleaved":{"type":"boolean"},
|
|
"InvalidOperationException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if the operation is not valid on the specified resource</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidParameterException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if a parameter of the request is incorrectly specified.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidSequenceTokenException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"expectedSequenceToken":{"shape":"SequenceToken"}
|
|
},
|
|
"exception":true
|
|
},
|
|
"LimitExceededException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if you have reached the maximum number of resources that can be created.</p>",
|
|
"exception":true
|
|
},
|
|
"LogEventIndex":{"type":"integer"},
|
|
"LogGroup":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logGroupName":{"shape":"LogGroupName"},
|
|
"creationTime":{"shape":"Timestamp"},
|
|
"retentionInDays":{"shape":"Days"},
|
|
"metricFilterCount":{"shape":"FilterCount"},
|
|
"arn":{"shape":"Arn"},
|
|
"storedBytes":{"shape":"StoredBytes"}
|
|
}
|
|
},
|
|
"LogGroupName":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1,
|
|
"pattern":"[\\.\\-_/#A-Za-z0-9]+"
|
|
},
|
|
"LogGroups":{
|
|
"type":"list",
|
|
"member":{"shape":"LogGroup"},
|
|
"documentation":"<p>A list of log groups.</p>"
|
|
},
|
|
"LogStream":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logStreamName":{"shape":"LogStreamName"},
|
|
"creationTime":{"shape":"Timestamp"},
|
|
"firstEventTimestamp":{"shape":"Timestamp"},
|
|
"lastEventTimestamp":{"shape":"Timestamp"},
|
|
"lastIngestionTime":{"shape":"Timestamp"},
|
|
"uploadSequenceToken":{"shape":"SequenceToken"},
|
|
"arn":{"shape":"Arn"},
|
|
"storedBytes":{"shape":"StoredBytes"}
|
|
},
|
|
"documentation":"<p>A log stream is sequence of log events from a single emitter of logs.</p>"
|
|
},
|
|
"LogStreamName":{
|
|
"type":"string",
|
|
"max":512,
|
|
"min":1,
|
|
"pattern":"[^:*]*"
|
|
},
|
|
"LogStreamSearchedCompletely":{"type":"boolean"},
|
|
"LogStreams":{
|
|
"type":"list",
|
|
"member":{"shape":"LogStream"},
|
|
"documentation":"<p>A list of log streams.</p>"
|
|
},
|
|
"MetricFilter":{
|
|
"type":"structure",
|
|
"members":{
|
|
"filterName":{"shape":"FilterName"},
|
|
"filterPattern":{"shape":"FilterPattern"},
|
|
"metricTransformations":{"shape":"MetricTransformations"},
|
|
"creationTime":{"shape":"Timestamp"}
|
|
},
|
|
"documentation":"<p>Metric filters can be used to express how CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric.</p>"
|
|
},
|
|
"MetricFilterMatchRecord":{
|
|
"type":"structure",
|
|
"members":{
|
|
"eventNumber":{"shape":"EventNumber"},
|
|
"eventMessage":{"shape":"EventMessage"},
|
|
"extractedValues":{"shape":"ExtractedValues"}
|
|
}
|
|
},
|
|
"MetricFilterMatches":{
|
|
"type":"list",
|
|
"member":{"shape":"MetricFilterMatchRecord"}
|
|
},
|
|
"MetricFilters":{
|
|
"type":"list",
|
|
"member":{"shape":"MetricFilter"}
|
|
},
|
|
"MetricName":{
|
|
"type":"string",
|
|
"documentation":"<p>The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.</p>",
|
|
"max":255,
|
|
"pattern":"[^:*$]*"
|
|
},
|
|
"MetricNamespace":{
|
|
"type":"string",
|
|
"documentation":"<p>The destination namespace of the new CloudWatch metric.</p>",
|
|
"max":255,
|
|
"pattern":"[^:*$]*"
|
|
},
|
|
"MetricTransformation":{
|
|
"type":"structure",
|
|
"required":[
|
|
"metricName",
|
|
"metricNamespace",
|
|
"metricValue"
|
|
],
|
|
"members":{
|
|
"metricName":{
|
|
"shape":"MetricName",
|
|
"documentation":"<p>Name of the metric.</p>"
|
|
},
|
|
"metricNamespace":{
|
|
"shape":"MetricNamespace",
|
|
"documentation":"<p>Namespace to which the metric belongs.</p>"
|
|
},
|
|
"metricValue":{
|
|
"shape":"MetricValue",
|
|
"documentation":"<p> A string representing a value to publish to this metric when a filter pattern matches a log event. </p>"
|
|
},
|
|
"defaultValue":{
|
|
"shape":"DefaultValue",
|
|
"documentation":"<p>(Optional) A default value to emit when a filter pattern does not match a log event. Can be null.</p>"
|
|
}
|
|
}
|
|
},
|
|
"MetricTransformations":{
|
|
"type":"list",
|
|
"member":{"shape":"MetricTransformation"},
|
|
"max":1,
|
|
"min":1
|
|
},
|
|
"MetricValue":{
|
|
"type":"string",
|
|
"documentation":"<p>What to publish to the metric. For example, if you're counting the occurrences of a particular term like \"Error\", the value will be \"1\" for each occurrence. If you're counting the bytes transferred the published value will be the value in the log event.</p>",
|
|
"max":100
|
|
},
|
|
"NextToken":{
|
|
"type":"string",
|
|
"documentation":"<p>A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.</p>",
|
|
"min":1
|
|
},
|
|
"OperationAbortedException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if multiple requests to update the same resource were in conflict.</p>",
|
|
"exception":true
|
|
},
|
|
"OrderBy":{
|
|
"type":"string",
|
|
"enum":[
|
|
"LogStreamName",
|
|
"LastEventTime"
|
|
]
|
|
},
|
|
"OutputLogEvent":{
|
|
"type":"structure",
|
|
"members":{
|
|
"timestamp":{"shape":"Timestamp"},
|
|
"message":{"shape":"EventMessage"},
|
|
"ingestionTime":{"shape":"Timestamp"}
|
|
}
|
|
},
|
|
"OutputLogEvents":{
|
|
"type":"list",
|
|
"member":{"shape":"OutputLogEvent"}
|
|
},
|
|
"PutDestinationPolicyRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"destinationName",
|
|
"accessPolicy"
|
|
],
|
|
"members":{
|
|
"destinationName":{
|
|
"shape":"DestinationName",
|
|
"documentation":"<p>A name for an existing destination.</p>"
|
|
},
|
|
"accessPolicy":{
|
|
"shape":"AccessPolicy",
|
|
"documentation":"<p>An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutDestinationRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"destinationName",
|
|
"targetArn",
|
|
"roleArn"
|
|
],
|
|
"members":{
|
|
"destinationName":{
|
|
"shape":"DestinationName",
|
|
"documentation":"<p>A name for the destination.</p>"
|
|
},
|
|
"targetArn":{
|
|
"shape":"TargetArn",
|
|
"documentation":"<p>The ARN of an Amazon Kinesis stream to deliver matching log events to.</p>"
|
|
},
|
|
"roleArn":{
|
|
"shape":"RoleArn",
|
|
"documentation":"<p>The ARN of an IAM role that grants CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the destination stream.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutDestinationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"destination":{"shape":"Destination"}
|
|
}
|
|
},
|
|
"PutLogEventsRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"logStreamName",
|
|
"logEvents"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to put log events to.</p>"
|
|
},
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream to put log events to.</p>"
|
|
},
|
|
"logEvents":{"shape":"InputLogEvents"},
|
|
"sequenceToken":{
|
|
"shape":"SequenceToken",
|
|
"documentation":"<p>A string token that must be obtained from the response of the previous <code>PutLogEvents</code> request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutLogEventsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"nextSequenceToken":{"shape":"SequenceToken"},
|
|
"rejectedLogEventsInfo":{"shape":"RejectedLogEventsInfo"}
|
|
}
|
|
},
|
|
"PutMetricFilterRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"filterName",
|
|
"filterPattern",
|
|
"metricTransformations"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to associate the metric filter with.</p>"
|
|
},
|
|
"filterName":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>A name for the metric filter.</p>"
|
|
},
|
|
"filterPattern":{
|
|
"shape":"FilterPattern",
|
|
"documentation":"<p>A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.</p>"
|
|
},
|
|
"metricTransformations":{
|
|
"shape":"MetricTransformations",
|
|
"documentation":"<p>A collection of information needed to define how metric data gets emitted.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutRetentionPolicyRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"retentionInDays"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to associate the retention policy with.</p>"
|
|
},
|
|
"retentionInDays":{"shape":"Days"}
|
|
}
|
|
},
|
|
"PutSubscriptionFilterRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"logGroupName",
|
|
"filterName",
|
|
"filterPattern",
|
|
"destinationArn"
|
|
],
|
|
"members":{
|
|
"logGroupName":{
|
|
"shape":"LogGroupName",
|
|
"documentation":"<p>The name of the log group to associate the subscription filter with.</p>"
|
|
},
|
|
"filterName":{
|
|
"shape":"FilterName",
|
|
"documentation":"<p>A name for the subscription filter.</p>"
|
|
},
|
|
"filterPattern":{
|
|
"shape":"FilterPattern",
|
|
"documentation":"<p>A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.</p>"
|
|
},
|
|
"destinationArn":{
|
|
"shape":"DestinationArn",
|
|
"documentation":"<p>The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.</p> </li> </ul>"
|
|
},
|
|
"roleArn":{
|
|
"shape":"RoleArn",
|
|
"documentation":"<p>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 (used via an ARN of <code>Destination</code>) for cross-account delivery.</p>"
|
|
}
|
|
}
|
|
},
|
|
"RejectedLogEventsInfo":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tooNewLogEventStartIndex":{"shape":"LogEventIndex"},
|
|
"tooOldLogEventEndIndex":{"shape":"LogEventIndex"},
|
|
"expiredLogEventEndIndex":{"shape":"LogEventIndex"}
|
|
}
|
|
},
|
|
"ResourceAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if the specified resource already exists.</p>",
|
|
"exception":true
|
|
},
|
|
"ResourceNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if the specified resource does not exist.</p>",
|
|
"exception":true
|
|
},
|
|
"RoleArn":{
|
|
"type":"string",
|
|
"min":1
|
|
},
|
|
"SearchedLogStream":{
|
|
"type":"structure",
|
|
"members":{
|
|
"logStreamName":{
|
|
"shape":"LogStreamName",
|
|
"documentation":"<p>The name of the log stream.</p>"
|
|
},
|
|
"searchedCompletely":{
|
|
"shape":"LogStreamSearchedCompletely",
|
|
"documentation":"<p>Indicates whether all the events in this log stream were searched or more data exists to search by paginating further.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object indicating the search status of a log stream in a <code>FilterLogEvents</code> request.</p>"
|
|
},
|
|
"SearchedLogStreams":{
|
|
"type":"list",
|
|
"member":{"shape":"SearchedLogStream"},
|
|
"documentation":"<p>A list of <code>SearchedLogStream</code> objects indicating the search status for log streams in a <code>FilterLogEvents</code> request.</p>"
|
|
},
|
|
"SequenceToken":{
|
|
"type":"string",
|
|
"documentation":"<p>A string token used for making PutLogEvents requests. A <code>sequenceToken</code> can only be used once, and PutLogEvents requests must include the <code>sequenceToken</code> obtained from the response of the previous request.</p>",
|
|
"min":1
|
|
},
|
|
"ServiceUnavailableException":{
|
|
"type":"structure",
|
|
"members":{
|
|
},
|
|
"documentation":"<p>Returned if the service cannot complete the request.</p>",
|
|
"exception":true,
|
|
"fault":true
|
|
},
|
|
"StartFromHead":{"type":"boolean"},
|
|
"StoredBytes":{
|
|
"type":"long",
|
|
"min":0
|
|
},
|
|
"SubscriptionFilter":{
|
|
"type":"structure",
|
|
"members":{
|
|
"filterName":{"shape":"FilterName"},
|
|
"logGroupName":{"shape":"LogGroupName"},
|
|
"filterPattern":{"shape":"FilterPattern"},
|
|
"destinationArn":{"shape":"DestinationArn"},
|
|
"roleArn":{"shape":"RoleArn"},
|
|
"creationTime":{"shape":"Timestamp"}
|
|
}
|
|
},
|
|
"SubscriptionFilters":{
|
|
"type":"list",
|
|
"member":{"shape":"SubscriptionFilter"}
|
|
},
|
|
"TargetArn":{
|
|
"type":"string",
|
|
"min":1
|
|
},
|
|
"TestEventMessages":{
|
|
"type":"list",
|
|
"member":{"shape":"EventMessage"},
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"TestMetricFilterRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"filterPattern",
|
|
"logEventMessages"
|
|
],
|
|
"members":{
|
|
"filterPattern":{"shape":"FilterPattern"},
|
|
"logEventMessages":{
|
|
"shape":"TestEventMessages",
|
|
"documentation":"<p>A list of log event messages to test.</p>"
|
|
}
|
|
}
|
|
},
|
|
"TestMetricFilterResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"matches":{"shape":"MetricFilterMatches"}
|
|
}
|
|
},
|
|
"Timestamp":{
|
|
"type":"long",
|
|
"documentation":"<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
|
|
"min":0
|
|
},
|
|
"Token":{"type":"string"},
|
|
"Value":{"type":"string"}
|
|
},
|
|
"documentation":"<p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.</p> <p>You can use CloudWatch Logs to:</p> <ul> <li> <p> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.</p> </li> <li> <p> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.</p> </li> <li> <p> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.</p> </li> </ul>"
|
|
}
|