Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Get data from Amazon Metadata

Use the Amazon Metadata source function to get data from the resources and infrastructure in Amazon Web Services (AWS). You must create a connection to use this source function. See Create a DSP connection to get metadata from AWS.

Function output schema

This function outputs data pipeline events using the event schema.

The data that is included in the body field varies depending on the specific AWS API that the event comes from, but typically contains all the attributes of the corresponding AWS resource. For example, the body field of an event from the ec2_key_pairs API would include all attributes of the ec2.KeyPairInfo resource. However, in some cases, additional related attributes are included in the body field. See How AWS metadata is collected in the Connect to Data Sources and Destinations with DSP manual for more information.

For all events, the function also includes the following attributes in addition to the ones that are part of the original payload:

  • AccountID: The ID of the AWS account associated with the event. This attribute is omitted if the account ID cannot be retrieved.
  • Region: The AWS region associated with the event.

The following is an example of a record from the read_from_aws_cloudwatch_metrics function. In this example, the record contains an event from the ec2_key_pairs API.

"timestamp": 1568050119000,
"nanos": 0,
"id": "2823738566644596",
"host": "test-host-1",
"source": "us-east-1:ec2:describeKeyPairs",
"source_type": "aws:ec2:keypair",
"body": {
"attributes": {
     "AccountID": "123412341234",
     "Region": "ca-central-1"

Required arguments

Syntax: string
Description: The ID of your Amazon Metadata connection.
Example: "576205b3-f6f5-4ab7-8ffc-a4089a95d0c4"

Optional arguments

Description: The position in the data stream where you want to start reading data. Defaults to LATEST.
  • LATEST: Start reading data from the latest position on the data stream.
  • TRIM_HORIZON: Start reading data from the very beginning of the data stream.
Example: LATEST

SPL2 example

You can write the function by listing arguments in this exact order.

| from read_from_aws_metadata("my-connection-id", "TRIM_HORIZON") |... ;

Alternatively, you can use named arguments in any order, and omit the optional argument if you just want to use the default value. See the "Named arguments" section in SPL2 syntax for more details. The following SPL2 example omits the initial_position argument.

| from read_from_aws_metadata(connection_id: "my-connection-id") |... ;

Limitations of the Amazon Metadata source function

The Amazon Metadata source function uses scheduled data collection jobs to ingest data. See Limitations of scheduled data collection jobs for information about limitations that apply to all scheduled data collection jobs.

Last modified on 22 October, 2020
Get data from Amazon Kinesis Data Stream
Get data from Amazon S3

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0

Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters