DescribeSubscriptionFilters - Amazon CloudWatch Logs (original) (raw)
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.
Request Syntax
{
"filterNamePrefix": "string",
"limit": number,
"logGroupName": "string",
"nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
The prefix to match. If you don't specify a value, no prefix filter is applied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [^:*]*
Required: No
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
The name of the log group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [\.\-_/#A-Za-z0-9]+
Required: Yes
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"nextToken": "string",
"subscriptionFilters": [
{
"applyOnTransformedLogs": boolean,
"creationTime": number,
"destinationArn": "string",
"distribution": "string",
"filterName": "string",
"filterPattern": "string",
"logGroupName": "string",
"roleArn": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
The token for the next set of items to return. The token expires after 24 hours.
Type: String
Length Constraints: Minimum length of 1.
The subscription filters.
Type: Array of SubscriptionFilter objects
Errors
For information about the errors that are common to all actions, see Common Errors.
InvalidParameterException
A parameter is specified incorrectly.
HTTP Status Code: 400
ResourceNotFoundException
The specified resource does not exist.
HTTP Status Code: 400
ServiceUnavailableException
The service cannot complete the request.
HTTP Status Code: 500
Examples
To list the subscription filters for a log group
The following example lists the subscription filters for the specified log group.
Sample Request
POST / HTTP/1.1
Host: logs.<region>.<domain>
X-Amz-Date: <DATE>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Accept: application/json
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: Logs_20140328.DescribeSubscriptionFilters
{
"logGroupName": "my-log-group"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"subscriptionFilters": [
{
"creationTime": 1396224000000,
"logGroupName": "my-log-group",
"filterName": "my-subscription-ilter",
"filterPattern": "[ip, identity, user_id, timestamp, request, status_code = 500, size]",
"destinationArn": "arn:aws:kinesis:us-east-1:123456789012:stream/my-kinesis-stream",
"roleArn": "arn:aws:iam::123456789012:role/my-subscription-role"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: