The tap-amazon-sp extractor pulls data from Amazon Selling Partner (SP) that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-amazon-sp extractor to your
project using
:meltano add
-
Configure the tap-amazon-sp
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-amazon-sp --variant singer-io
meltano config tap-amazon-sp set --interactive
meltano config tap-amazon-sp test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-amazon-sp
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-amazon-sp
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
aws_access_key
aws_secret_key
client_id
client_secret
marketplaces
refresh_token
role_arn
sales_data_granularity
start_date
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-amazon-sp list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
AWS Access Key (aws_access_key)
-
Environment variable:
TAP_AMAZON_SP_AWS_ACCESS_KEY
Your AWS access key.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set aws_access_key [value]
AWS Secret Key (aws_secret_key)
-
Environment variable:
TAP_AMAZON_SP_AWS_SECRET_KEY
Your AWS secret key.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set aws_secret_key [value]
Client ID (client_id)
-
Environment variable:
TAP_AMAZON_SP_CLIENT_ID
Your AWS client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set client_id [value]
Client Secret (client_secret)
-
Environment variable:
TAP_AMAZON_SP_CLIENT_SECRET
Your AWS client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set client_secret [value]
Marketplaces (marketplaces)
-
Environment variable:
TAP_AMAZON_SP_MARKETPLACES
Space delimited string of Marketplace Country Code values. Default is ["US"].
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set marketplaces [value]
Refresh Token (refresh_token)
-
Environment variable:
TAP_AMAZON_SP_REFRESH_TOKEN
Your AWS refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set refresh_token [value]
Role Arn (role_arn)
-
Environment variable:
TAP_AMAZON_SP_ROLE_ARN
Your AWS role ARN.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set role_arn [value]
Sales Data Granularity (sales_data_granularity)
-
Environment variable:
TAP_AMAZON_SP_SALES_DATA_GRANULARITY
Granularity for sales stream for sales aggregation. Default is "DAY".
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set sales_data_granularity [value]
Start Date (start_date)
-
Environment variable:
TAP_AMAZON_SP_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sp set start_date [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.