aws-elixir v0.13.3

View Source AWS.DataExchange (aws-elixir v0.13.3)

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud.

You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIs to download or copy your entitled data sets to Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine learning services.

As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.

A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake Formation data permission, or Amazon S3 data access. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.

Link to this section Summary

Functions

cancel_job(client, job_id, input, options \\ [])

This operation cancels a job.

create_data_set(client, input, options \\ [])

This operation creates a data set.

create_event_action(client, input, options \\ [])

This operation creates an event action.

create_job(client, input, options \\ [])

This operation creates a job.

create_revision(client, data_set_id, input, options \\ [])

This operation creates a revision for a data set.

delete_asset(client, asset_id, data_set_id, revision_id, input, options \\ [])

This operation deletes an asset.

delete_data_set(client, data_set_id, input, options \\ [])

This operation deletes a data set.

delete_event_action(client, event_action_id, input, options \\ [])

This operation deletes the event action.

delete_revision(client, data_set_id, revision_id, input, options \\ [])

This operation deletes a revision.

get_asset(client, asset_id, data_set_id, revision_id, options \\ [])

This operation returns information about an asset.

get_data_set(client, data_set_id, options \\ [])

This operation returns information about a data set.

get_event_action(client, event_action_id, options \\ [])

This operation retrieves information about an event action.

get_job(client, job_id, options \\ [])

This operation returns information about a job.

get_revision(client, data_set_id, revision_id, options \\ [])

This operation returns information about a revision.

list_data_set_revisions(client, data_set_id, max_results \\ nil, next_token \\ nil, options \\ [])

This operation lists a data set's revisions sorted by CreatedAt in descending order.

list_data_sets(client, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

This operation lists your data sets.

list_event_actions(client, event_source_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

This operation lists your event actions.

list_jobs(client, data_set_id \\ nil, max_results \\ nil, next_token \\ nil, revision_id \\ nil, options \\ [])

This operation lists your jobs sorted by CreatedAt in descending order.

list_revision_assets(client, data_set_id, revision_id, max_results \\ nil, next_token \\ nil, options \\ [])

This operation lists a revision's assets sorted alphabetically in descending order.

list_tags_for_resource(client, resource_arn, options \\ [])

This operation lists the tags on the resource.

metadata()
revoke_revision(client, data_set_id, revision_id, input, options \\ [])

This operation revokes subscribers' access to a revision.

send_api_asset(client, input, options \\ [])

This operation invokes an API Gateway API asset.

start_job(client, job_id, input, options \\ [])

This operation starts a job.

tag_resource(client, resource_arn, input, options \\ [])

This operation tags a resource.

untag_resource(client, resource_arn, input, options \\ [])

This operation removes one or more tags from a resource.

update_asset(client, asset_id, data_set_id, revision_id, input, options \\ [])

This operation updates an asset.

update_data_set(client, data_set_id, input, options \\ [])

This operation updates a data set.

update_event_action(client, event_action_id, input, options \\ [])

This operation updates the event action.

update_revision(client, data_set_id, revision_id, input, options \\ [])

This operation updates a revision.

Link to this section Functions

Link to this function

cancel_job(client, job_id, input, options \\ [])

View Source

This operation cancels a job.

Jobs can be cancelled only when they are in the WAITING state.

Link to this function

create_data_set(client, input, options \\ [])

View Source

This operation creates a data set.

Link to this function

create_event_action(client, input, options \\ [])

View Source

This operation creates an event action.

Link to this function

create_job(client, input, options \\ [])

View Source

This operation creates a job.

Link to this function

create_revision(client, data_set_id, input, options \\ [])

View Source

This operation creates a revision for a data set.

Link to this function

delete_asset(client, asset_id, data_set_id, revision_id, input, options \\ [])

View Source

This operation deletes an asset.

Link to this function

delete_data_set(client, data_set_id, input, options \\ [])

View Source

This operation deletes a data set.

Link to this function

delete_event_action(client, event_action_id, input, options \\ [])

View Source

This operation deletes the event action.

Link to this function

delete_revision(client, data_set_id, revision_id, input, options \\ [])

View Source

This operation deletes a revision.

Link to this function

get_asset(client, asset_id, data_set_id, revision_id, options \\ [])

View Source

This operation returns information about an asset.

Link to this function

get_data_set(client, data_set_id, options \\ [])

View Source

This operation returns information about a data set.

Link to this function

get_event_action(client, event_action_id, options \\ [])

View Source

This operation retrieves information about an event action.

Link to this function

get_job(client, job_id, options \\ [])

View Source

This operation returns information about a job.

Link to this function

get_revision(client, data_set_id, revision_id, options \\ [])

View Source

This operation returns information about a revision.

Link to this function

list_data_set_revisions(client, data_set_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This operation lists a data set's revisions sorted by CreatedAt in descending order.

Link to this function

list_data_sets(client, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

View Source

This operation lists your data sets.

When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

Link to this function

list_event_actions(client, event_source_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This operation lists your event actions.

Link to this function

list_jobs(client, data_set_id \\ nil, max_results \\ nil, next_token \\ nil, revision_id \\ nil, options \\ [])

View Source

This operation lists your jobs sorted by CreatedAt in descending order.

Link to this function

list_revision_assets(client, data_set_id, revision_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This operation lists a revision's assets sorted alphabetically in descending order.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

This operation lists the tags on the resource.

Link to this function

metadata()

View Source
Link to this function

revoke_revision(client, data_set_id, revision_id, input, options \\ [])

View Source

This operation revokes subscribers' access to a revision.

Link to this function

send_api_asset(client, input, options \\ [])

View Source

This operation invokes an API Gateway API asset.

The request is proxied to the provider’s API Gateway API.

Link to this function

start_job(client, job_id, input, options \\ [])

View Source

This operation starts a job.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

This operation tags a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

This operation removes one or more tags from a resource.

Link to this function

update_asset(client, asset_id, data_set_id, revision_id, input, options \\ [])

View Source

This operation updates an asset.

Link to this function

update_data_set(client, data_set_id, input, options \\ [])

View Source

This operation updates a data set.

Link to this function

update_event_action(client, event_action_id, input, options \\ [])

View Source

This operation updates the event action.

Link to this function

update_revision(client, data_set_id, revision_id, input, options \\ [])

View Source

This operation updates a revision.