Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an AWS Cost Explorer API source in Nexla.
aws_ce_api.png

AWS Cost Explorer API

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the AWS Cost Explorer API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the AWS Cost Explorer API instance, and click Next; or, create a new AWS Cost Explorer API credential for use in this flow.

  3. In Nexla, AWS Cost Explorer API data sources can be created using pre-built endpoint templates, which expedite source setup for common AWS Cost Explorer API endpoints. Each template is designed specifically for the corresponding AWS Cost Explorer API endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    AWS Cost Explorer API sources can also be configured manually, allowing you to ingest data from AWS Cost Explorer API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common AWS Cost Explorer API endpoints. Each template is designed specifically for the corresponding AWS Cost Explorer API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Run Cost Explorer Report/Action

    This endpoint runs a specific AWS Cost Explorer API report or action to retrieve cost and usage data from your AWS account. Use this endpoint when you need to access cost data, usage metrics, anomaly detection, reservation information, or other cost management data from AWS Cost Explorer.

    • Select the Cost Explorer action you want to execute from the Cost Explorer Action dropdown menu. Available actions include GetAnomalies, GetAnomalyMonitors, GetAnomalySubscriptions, GetApproximateUsageRecords, GetCostAndUsage, GetCostAndUsageWithResources, GetCostCategories, GetCostForecast, GetDimensionValues, GetReservationCoverage, GetReservationPurchaseRecommendation, GetReservationUtilization, GetRightsizingRecommendation, GetSavingsPlansCoverage, GetSavingsPlansPurchaseRecommendation, GetSavingsPlansUtilization, and GetUsageReport. The selected action determines which AWS Cost Explorer API operation will be executed.
    • Enter the request query in the Request Query field. This should be a JSON-formatted request body that specifies the parameters for the selected Cost Explorer action. The request query should follow the AWS Cost Explorer API specification for the selected action, including time periods, metrics, dimensions, filters, and other required parameters. The request body is sent as the POST request body to the endpoint.
    • The endpoint uses POST requests to https://ce.us-east-1.amazonaws.com with required headers: Content-Type: application/x-amz-json-1.1 and X-Amz-Target: AWSInsightsIndexService.{ActionName} where {ActionName} matches the selected Cost Explorer action.
    • The endpoint uses token-based pagination when applicable, automatically fetching additional pages as needed using the NextPageToken mechanism. When a response includes a NextPageToken field, Nexla automatically includes it in the subsequent request body to fetch the next page of results.
    • The endpoint will return cost and usage data based on your request query, formatted according to the selected action's response structure. The response is returned at the root level of the JSON response, and Nexla will process the entire response structure.

    The request query must be properly formatted JSON that matches the AWS Cost Explorer API specification for the selected action. Common parameters include TimePeriod (start and end dates in YYYY-MM-DD format), Granularity (DAILY or MONTHLY), Metrics (cost and usage metrics like BlendedCost, UnblendedCost, UsageQuantity), and Dimensions (for grouping data like Service, AvailabilityZone, InstanceType). The endpoint requires AWS Signature Version 4 authentication, which is handled automatically by your credential configuration. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the NextPageToken mechanism - when a response includes a NextPageToken field, Nexla automatically includes it in the subsequent request body (params.in.body: true) to fetch the next page of results. The request body is sent as JSON in the POST request body, and the required headers (Content-Type: application/x-amz-json-1.1 and X-Amz-Target: AWSInsightsIndexService.{ActionName}) are automatically configured based on your selected action. For detailed information about AWS Cost Explorer API actions, request formatting, response structures, and available parameters for each action, see the AWS Cost Explorer API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

AWS Cost Explorer API data sources can be manually configured to ingest data from any valid AWS Cost Explorer API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex AWS Cost Explorer API sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the AWS Cost Explorer API from the Method pulldown menu. The AWS Cost Explorer API uses POST requests for all operations. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions (required for AWS Cost Explorer API)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the AWS Cost Explorer API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. AWS Cost Explorer API endpoints typically follow the pattern https://ce.{'{region}'}.amazonaws.com where {region} is your AWS region (e.g., https://ce.us-east-1.amazonaws.com).

Ensure the API endpoint URL is correct and accessible with your current credentials. The AWS Cost Explorer API is typically available in the us-east-1 region. You can test the endpoint using the Test button after configuring the URL. For detailed information about AWS Cost Explorer API endpoints, see the AWS Cost Explorer API documentation.

Request Body​

Required

The AWS Cost Explorer API requires a request body with query parameters for all operations. The request body should contain the action name, time periods, metrics, dimensions, and other parameters according to the AWS Cost Explorer API specification.

  1. Configure the request body for your API call. The request body should be formatted as JSON and include the necessary parameters according to the AWS Cost Explorer API specification. Common parameters include:
    • TimePeriod: The start and end dates for the data retrieval period
    • Granularity: The granularity of the returned data (DAILY or MONTHLY)
    • Metrics: The cost and usage metrics to retrieve
    • Dimensions: Dimensions for grouping the data
    • Filter: Filters for narrowing down the data

The request body format follows the AWS Cost Explorer API specification. The request body must include the X-Amz-Target header which specifies the action to execute. For detailed information about request body formatting and available parameters, see the AWS Cost Explorer API documentation.

Request Headers​

Required

The AWS Cost Explorer API requires specific headers for all requests, including the X-Amz-Target header that specifies the action to execute.

  1. Configure the required request headers for your API call. The AWS Cost Explorer API requires:
    • Content-Type: application/x-amz-json-1.1
    • X-Amz-Target: The action to execute, in the format AWSInsightsIndexService.{ActionName} (e.g., AWSInsightsIndexService.GetCostAndUsage)

The X-Amz-Target header must match the action you want to execute. The header format is AWSInsightsIndexService.{ActionName} where {ActionName} is the Cost Explorer action (e.g., GetCostAndUsage, GetDimensionValues). These headers are required for all AWS Cost Explorer API requests.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.ResultsByTime[*] to access an array of time-based results within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the API response is in JSON format and includes a top-level object with an array named ResultsByTime that contains the relevant data, the path to the response would be entered as $.ResultsByTime[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when a request call is used to fetch a list of items, the API response will typically include an array of records along with metadata such as total count, pagination information, or request timestamps. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new AWS Cost Explorer API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.