Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListSyslogConfigurations

Returns a list of syslog configurations. You can optionally filter the results by log group or VPC endpoint.

Request Syntax


{
   "logGroupIdentifier": "string",
   "maxResults": number,
   "nextToken": "string",
   "vpcEndpointId": "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.

logGroupIdentifier

The name or ARN of the log group to filter syslog configurations for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w#+=/:,.@-]*

Required: No

maxResults

The maximum number of syslog configurations to return in the response.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 50.

Required: No

nextToken

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

vpcEndpointId

The ID of the VPC endpoint to filter syslog configurations for.

Type: String

Pattern: ^vpce-[0-9a-f]{1,64}$

Required: No

Response Syntax


{
   "nextToken": "string",
   "syslogConfigurations": [ 
      { 
         "createdAt": number,
         "logGroupArn": "string",
         "sourceType": "string",
         "vpcEndpointId": "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.

nextToken

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

Type: String

Length Constraints: Minimum length of 1.

syslogConfigurations

The list of syslog configurations.

Type: Array of SyslogConfiguration objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 400

InvalidOperationException

The operation is not valid on the specified resource.

HTTP Status Code: 400

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

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 400

Examples

To list syslog configurations

The following example lists the syslog configurations 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.ListSyslogConfigurations
{
  "logGroupIdentifier": "arn:aws:logs:us-east-1:123456789012:log-group:my-syslog-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>
{
  "syslogConfigurations": [
    {
      "logGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:my-syslog-group",
      "sourceType": "VPCE",
      "vpcEndpointId": "vpce-0123456789abcdef0",
      "createdAt": 1718000000000
    }
  ]
}