GetTransformer
Returns the information about the log transformer associated with this log group.
This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use DescribeAccountPolicies.
Request Syntax
{
"logGroupIdentifier": "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
-
Specify either the name or ARN of the log group to return transformer information for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\w#+=/:,.@-]*Required: Yes
Response Syntax
{
"creationTime": number,
"lastModifiedTime": number,
"logGroupIdentifier": "string",
"transformerConfig": [
{
"addKeys": {
"entries": [
{
"key": "string",
"overwriteIfExists": boolean,
"value": "string"
}
]
},
"copyValue": {
"entries": [
{
"overwriteIfExists": boolean,
"source": "string",
"target": "string"
}
]
},
"csv": {
"columns": [ "string" ],
"delimiter": "string",
"quoteCharacter": "string",
"source": "string"
},
"dateTimeConverter": {
"locale": "string",
"matchPatterns": [ "string" ],
"source": "string",
"sourceTimezone": "string",
"target": "string",
"targetFormat": "string",
"targetTimezone": "string"
},
"deleteKeys": {
"withKeys": [ "string" ]
},
"grok": {
"match": "string",
"source": "string"
},
"listToMap": {
"flatten": boolean,
"flattenedElement": "string",
"key": "string",
"source": "string",
"target": "string",
"valueKey": "string"
},
"lowerCaseString": {
"withKeys": [ "string" ]
},
"moveKeys": {
"entries": [
{
"overwriteIfExists": boolean,
"source": "string",
"target": "string"
}
]
},
"parseCloudfront": {
"source": "string"
},
"parseJSON": {
"destination": "string",
"source": "string"
},
"parseKeyValue": {
"destination": "string",
"fieldDelimiter": "string",
"keyPrefix": "string",
"keyValueDelimiter": "string",
"nonMatchValue": "string",
"overwriteIfExists": boolean,
"source": "string"
},
"parsePostgres": {
"source": "string"
},
"parseRoute53": {
"source": "string"
},
"parseVPC": {
"source": "string"
},
"parseWAF": {
"source": "string"
},
"renameKeys": {
"entries": [
{
"key": "string",
"overwriteIfExists": boolean,
"renameTo": "string"
}
]
},
"splitString": {
"entries": [
{
"delimiter": "string",
"source": "string"
}
]
},
"substituteString": {
"entries": [
{
"from": "string",
"source": "string",
"to": "string"
}
]
},
"trimString": {
"withKeys": [ "string" ]
},
"typeConverter": {
"entries": [
{
"key": "string",
"type": "string"
}
]
},
"upperCaseString": {
"withKeys": [ "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.
- creationTime
-
The creation time of the transformer, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Type: Long
Valid Range: Minimum value of 0.
- lastModifiedTime
-
The date and time when this transformer was most recently modified, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Type: Long
Valid Range: Minimum value of 0.
- logGroupIdentifier
-
The ARN of the log group that you specified in your request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\w#+=/:,.@-]* - transformerConfig
-
This sructure contains the configuration of the requested transformer.
Type: Array of Processor objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
