GetLogFields
Discovers available fields for a specific data source and type. The response includes any field modifications introduced through pipelines, such as new fields or changed field types.
Request Syntax
{
"dataSourceName": "string",
"dataSourceType": "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.
- dataSourceName
-
The name of the data source to retrieve log fields for.
Type: String
Required: Yes
- dataSourceType
-
The type of the data source to retrieve log fields for.
Type: String
Required: Yes
Response Syntax
{
"logFields": [
{
"logFieldName": "string",
"logFieldType": {
"element": "LogFieldType",
"fields": [
"LogFieldsListItem"
],
"type": "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.
- logFields
-
The list of log fields for the specified data source, including field names and their data types.
Type: Array of LogFieldsListItem 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
- OperationAbortedException
-
Multiple concurrent requests to update the same resource were in conflict.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
